5803 lines
368 KiB
JSON
5803 lines
368 KiB
JSON
{
|
|
"api_version": "2014-05-15",
|
|
"service_full_name": "Amazon Route 53 Domains",
|
|
"type": "json",
|
|
"json_version": "1.1",
|
|
"signature_version": "v4",
|
|
"endpoint_prefix": "route53domains",
|
|
"target_prefix": "Route53Domains_v20140515",
|
|
"xmlnamespace": "https://route53domains.amazonaws.com/doc/2014-05-15/",
|
|
"documentation": null,
|
|
"operations": {
|
|
"CheckDomainAvailability": {
|
|
"name": "CheckDomainAvailability",
|
|
"input": {
|
|
"shape_name": "CheckDomainAvailabilityRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"DomainName": {
|
|
"shape_name": "DomainName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>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.</p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"IdnLangCode": {
|
|
"shape_name": "LangCode",
|
|
"type": "string",
|
|
"max_length": 3,
|
|
"documentation": "\n<p>Reserved for future use.</p>\n"
|
|
}
|
|
},
|
|
"documentation": "\n<p>The CheckDomainAvailability request contains the following elements.</p>\n"
|
|
},
|
|
"output": {
|
|
"shape_name": "CheckDomainAvailabilityResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Availability": {
|
|
"shape_name": "DomainAvailability",
|
|
"type": "string",
|
|
"enum": [
|
|
"AVAILABLE",
|
|
"AVAILABLE_RESERVED",
|
|
"AVAILABLE_PREORDER",
|
|
"UNAVAILABLE",
|
|
"UNAVAILABLE_PREMIUM",
|
|
"UNAVAILABLE_RESTRICTED",
|
|
"RESERVED"
|
|
],
|
|
"documentation": "\n<p>Whether the domain name is available for registering.</p>\n<note>\n<p>You can only register domains designated as <code>AVAILABLE</code>.</p>\n</note>\n<p>Type: String</p>\n<p>Valid values:</p>\n<ul>\n<li>\n<code>AVAILABLE</code> \u2013 The domain name is available.</li>\n<li>\n<code>AVAILABLE_RESERVED</code> \u2013 The domain name is reserved under specific conditions.</li>\n<li>\n<code>AVAILABLE_PREORDER</code> \u2013 The domain name is available and can be preordered.</li>\n<li>\n<code>UNAVAILABLE</code> \u2013 The domain name is not available.</li>\n<li>\n<code>UNAVAILABLE_PREMIUM</code> \u2013 The domain name is not available.</li>\n<li>\n<code>UNAVAILABLE_RESTRICTED</code> \u2013 The domain name is forbidden.</li>\n<li>\n<code>RESERVED</code> \u2013 The domain name has been reserved for another person or organization.</li>\n</ul>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>The CheckDomainAvailability response includes the following elements.</p>\n"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "UnsupportedTLD",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>Amazon Route 53 does not support this top-level domain.</p>\n"
|
|
}
|
|
],
|
|
"documentation": "\n<p>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.</p>\n<examples>\n <example>\n<name>CheckDomainAvailability Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205225Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.CheckDomainAvailability\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json- 1.1\ncontent-length:[number of characters in the JSON string]\nconnections:Keep-Alive\n{\n \"DomainName\":\"example.com\"\n}</request>\n <response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"Availability\":\"AVAILABLE\"\n}</response>\n </example>\n</examples>\n"
|
|
},
|
|
"DisableDomainTransferLock": {
|
|
"name": "DisableDomainTransferLock",
|
|
"input": {
|
|
"shape_name": "DisableDomainTransferLockRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"DomainName": {
|
|
"shape_name": "DomainName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>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.</p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>The DisableDomainTransferLock request includes the following element.</p>\n"
|
|
},
|
|
"output": {
|
|
"shape_name": "DisableDomainTransferLockResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"OperationId": {
|
|
"shape_name": "OperationId",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p>\n <p>Type: String</p>\n <p>Default: None</p>\n <p>Constraints: Maximum 255 characters.</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>The DisableDomainTransferLock response includes the following element.</p>\n"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "DuplicateRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The request is already in progress for the domain.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "TLDRulesViolation",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The top-level domain does not support this operation.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "OperationLimitExceeded",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The number of operations or jobs running exceeded the allowed threshold for the account.</p>\n"
|
|
}
|
|
],
|
|
"documentation": "\n<p>This operation removes the transfer lock on the domain (specifically the\n<code>clientTransferProhibited</code> status) to allow domain transfers. We recommend\nyou refrain from performing this action unless you intend to transfer the domain to a\ndifferent registrar. Successful submission returns an operation ID that you can use to track\nthe progress and completion of the action. If the request is not completed successfully, the\ndomain registrant will be notified by email.</p>\n\n<examples>\n<example>\n<name>DisableDomainTransferLock Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.DisableDomainTransferLock\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n\"DomainName\":\"example.com\"\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n\"OperationId\":\"0b370c79-faa4-40fe-94c8-b423069de3f6\"\n}</response>\n</example>\n</examples>\n"
|
|
},
|
|
"EnableDomainTransferLock": {
|
|
"name": "EnableDomainTransferLock",
|
|
"input": {
|
|
"shape_name": "EnableDomainTransferLockRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"DomainName": {
|
|
"shape_name": "DomainName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>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.</p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>The EnableDomainTransferLock request includes the following element.</p>\n"
|
|
},
|
|
"output": {
|
|
"shape_name": "EnableDomainTransferLockResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"OperationId": {
|
|
"shape_name": "OperationId",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p>\n <p>Type: String</p>\n <p>Default: None</p>\n <p>Constraints: Maximum 255 characters.</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>The EnableDomainTransferLock response includes the following elements.</p>\n"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "DuplicateRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The request is already in progress for the domain.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "TLDRulesViolation",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The top-level domain does not support this operation.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "OperationLimitExceeded",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The number of operations or jobs running exceeded the allowed threshold for the account.</p>\n"
|
|
}
|
|
],
|
|
"documentation": "\n<p>This operation sets the transfer lock on the domain (specifically the\n<code>clientTransferProhibited</code> status) to prevent domain transfers. Successful submission\nreturns an operation ID that you can use to track the progress and completion of the action. If the\nrequest is not completed successfully, the domain registrant will be notified by email.</p>\n<examples>\n<example>\n<name>EnableDomainTransferLock Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.EnableDomainTransferLock\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"DomainName\":\"example.com\"\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"OperationId\":\"0b370c79-faa4-40fe-94c8-b423069de3f6\"\n}</response>\n</example>\n</examples>\n"
|
|
},
|
|
"GetDomainDetail": {
|
|
"name": "GetDomainDetail",
|
|
"input": {
|
|
"shape_name": "GetDomainDetailRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"DomainName": {
|
|
"shape_name": "DomainName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>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.</p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>The GetDomainDetail request includes the following element.</p>\n"
|
|
},
|
|
"output": {
|
|
"shape_name": "GetDomainDetailResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"DomainName": {
|
|
"shape_name": "DomainName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n",
|
|
"required": true
|
|
},
|
|
"Nameservers": {
|
|
"shape_name": "NameserverList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Nameserver",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "HostName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The fully qualified host name of the name server.</p>\n<p>Type: String</p>\n<p>Constraint: Maximum 255 characterss</p>\n<p>Parent: <code>Nameservers</code></p>\n",
|
|
"required": true
|
|
},
|
|
"GlueIps": {
|
|
"shape_name": "GlueIpList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "GlueIp",
|
|
"type": "string",
|
|
"max_length": 45,
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n<p>Glue IP address of a name server entry. Glue IP addresses are required only when the name of the\nname server is a subdomain of the domain. For example, if your domain is example.com and the name\nserver for the domain is ns.example.com, you need to specify the IP address for ns.example.com.</p>\n<p>Type: List of IP addresses.</p>\n<p>Constraints: The list can contain only one IPv4 and one IPv6 address.</p>\n<p>Parent: <code>Nameservers</code></p>\n"
|
|
}
|
|
},
|
|
"documentation": "\n<p>Nameserver includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>The name of the domain.</p>\n<p>Type: String</p>\n",
|
|
"required": true
|
|
},
|
|
"AutoRenew": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>Specifies whether the domain registration is set to renew automatically.</p>\n<p>Type: Boolean</p>\n"
|
|
},
|
|
"AdminContact": {
|
|
"shape_name": "ContactDetail",
|
|
"type": "structure",
|
|
"members": {
|
|
"FirstName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"LastName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ContactType": {
|
|
"shape_name": "ContactType",
|
|
"type": "string",
|
|
"enum": [
|
|
"PERSON",
|
|
"COMPANY",
|
|
"ASSOCIATION",
|
|
"PUBLIC_BODY",
|
|
"RESELLER"
|
|
],
|
|
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"OrganizationName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"AddressLine1": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"AddressLine2": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"City": {
|
|
"shape_name": "City",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"State": {
|
|
"shape_name": "State",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"CountryCode": {
|
|
"shape_name": "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"
|
|
],
|
|
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ZipCode": {
|
|
"shape_name": "ZipCode",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"PhoneNumber": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Email": {
|
|
"shape_name": "Email",
|
|
"type": "string",
|
|
"max_length": 254,
|
|
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Fax": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"ExtraParams": {
|
|
"shape_name": "ExtraParamList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "ExtraParam",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "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",
|
|
"FI_BUSINESS_NUMBER",
|
|
"FI_ID_NUMBER",
|
|
"IT_PIN",
|
|
"RU_PASSPORT_DATA",
|
|
"SE_ID_NUMBER",
|
|
"SG_ID_NUMBER",
|
|
"VAT_NUMBER"
|
|
],
|
|
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"Value": {
|
|
"shape_name": "ExtraParamValue",
|
|
"type": "string",
|
|
"max_length": 2048,
|
|
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
|
}
|
|
},
|
|
"sensitive": true,
|
|
"documentation": "\n<p>Provides details about the domain administrative contact. </p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>,\n<code>LastName</code>, <code>ContactType</code>,\n<code>OrganizationName</code>, <code>AddressLine1</code>,\n<code>AddressLine2</code>, <code>City</code>, <code>State</code>,\n<code>CountryCode</code>, <code>ZipCode</code>,\n<code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>,\n<code>ExtraParams</code></p>\n",
|
|
"required": true
|
|
},
|
|
"RegistrantContact": {
|
|
"shape_name": "ContactDetail",
|
|
"type": "structure",
|
|
"members": {
|
|
"FirstName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"LastName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ContactType": {
|
|
"shape_name": "ContactType",
|
|
"type": "string",
|
|
"enum": [
|
|
"PERSON",
|
|
"COMPANY",
|
|
"ASSOCIATION",
|
|
"PUBLIC_BODY",
|
|
"RESELLER"
|
|
],
|
|
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"OrganizationName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"AddressLine1": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"AddressLine2": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"City": {
|
|
"shape_name": "City",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"State": {
|
|
"shape_name": "State",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"CountryCode": {
|
|
"shape_name": "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"
|
|
],
|
|
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ZipCode": {
|
|
"shape_name": "ZipCode",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"PhoneNumber": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Email": {
|
|
"shape_name": "Email",
|
|
"type": "string",
|
|
"max_length": 254,
|
|
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Fax": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"ExtraParams": {
|
|
"shape_name": "ExtraParamList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "ExtraParam",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "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",
|
|
"FI_BUSINESS_NUMBER",
|
|
"FI_ID_NUMBER",
|
|
"IT_PIN",
|
|
"RU_PASSPORT_DATA",
|
|
"SE_ID_NUMBER",
|
|
"SG_ID_NUMBER",
|
|
"VAT_NUMBER"
|
|
],
|
|
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"Value": {
|
|
"shape_name": "ExtraParamValue",
|
|
"type": "string",
|
|
"max_length": 2048,
|
|
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
|
}
|
|
},
|
|
"sensitive": true,
|
|
"documentation": "\n<p>Provides details about the domain registrant. </p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>,\n<code>LastName</code>, <code>ContactType</code>,\n<code>OrganizationName</code>, <code>AddressLine1</code>,\n<code>AddressLine2</code>, <code>City</code>, <code>State</code>,\n<code>CountryCode</code>, <code>ZipCode</code>,\n<code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>,\n<code>ExtraParams</code></p>\n",
|
|
"required": true
|
|
},
|
|
"TechContact": {
|
|
"shape_name": "ContactDetail",
|
|
"type": "structure",
|
|
"members": {
|
|
"FirstName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"LastName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ContactType": {
|
|
"shape_name": "ContactType",
|
|
"type": "string",
|
|
"enum": [
|
|
"PERSON",
|
|
"COMPANY",
|
|
"ASSOCIATION",
|
|
"PUBLIC_BODY",
|
|
"RESELLER"
|
|
],
|
|
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"OrganizationName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"AddressLine1": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"AddressLine2": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"City": {
|
|
"shape_name": "City",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"State": {
|
|
"shape_name": "State",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"CountryCode": {
|
|
"shape_name": "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"
|
|
],
|
|
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ZipCode": {
|
|
"shape_name": "ZipCode",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"PhoneNumber": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Email": {
|
|
"shape_name": "Email",
|
|
"type": "string",
|
|
"max_length": 254,
|
|
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Fax": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"ExtraParams": {
|
|
"shape_name": "ExtraParamList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "ExtraParam",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "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",
|
|
"FI_BUSINESS_NUMBER",
|
|
"FI_ID_NUMBER",
|
|
"IT_PIN",
|
|
"RU_PASSPORT_DATA",
|
|
"SE_ID_NUMBER",
|
|
"SG_ID_NUMBER",
|
|
"VAT_NUMBER"
|
|
],
|
|
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"Value": {
|
|
"shape_name": "ExtraParamValue",
|
|
"type": "string",
|
|
"max_length": 2048,
|
|
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
|
}
|
|
},
|
|
"sensitive": true,
|
|
"documentation": "\n<p>Provides details about the domain technical contact.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>,\n<code>LastName</code>, <code>ContactType</code>,\n<code>OrganizationName</code>, <code>AddressLine1</code>,\n<code>AddressLine2</code>, <code>City</code>, <code>State</code>,\n<code>CountryCode</code>, <code>ZipCode</code>,\n<code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>,\n<code>ExtraParams</code></p>\n",
|
|
"required": true
|
|
},
|
|
"AdminPrivacy": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>Specifies whether contact information for the admin contact is concealed from WHOIS queries.\nIf the value is <code>true</code>, WHOIS (\"who is\") queries will return contact information for our\nregistrar partner, Gandi, instead of the contact information that you enter.</p>\n<p>Type: Boolean</p>\n"
|
|
},
|
|
"RegistrantPrivacy": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>Specifies whether contact information for the registrant contact is concealed from WHOIS queries.\nIf the value is <code>true</code>, WHOIS (\"who is\") queries will return contact information for our\nregistrar partner, Gandi, instead of the contact information that you enter.</p>\n<p>Type: Boolean</p>\n"
|
|
},
|
|
"TechPrivacy": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>Specifies whether contact information for the tech contact is concealed from WHOIS queries.\nIf the value is <code>true</code>, WHOIS (\"who is\") queries will return contact information for our\nregistrar partner, Gandi, instead of the contact information that you enter.</p>\n<p>Type: Boolean</p>\n"
|
|
},
|
|
"RegistrarName": {
|
|
"shape_name": "RegistrarName",
|
|
"type": "string",
|
|
"documentation": "\n<p>Name of the registrar of the domain as identified in the registry. Amazon Route 53 domains are registered by registrar Gandi.\nThe value is <code>\"GANDI SAS\"</code>. </p>\n<p>Type: String</p>\n"
|
|
},
|
|
"WhoIsServer": {
|
|
"shape_name": "RegistrarWhoIsServer",
|
|
"type": "string",
|
|
"documentation": "\n<p>The fully qualified name of the WHOIS server that can answer the WHOIS query for the\ndomain.</p>\n<p>Type: String</p>\n"
|
|
},
|
|
"RegistrarUrl": {
|
|
"shape_name": "RegistrarUrl",
|
|
"type": "string",
|
|
"documentation": "\n<p>Web address of the registrar.</p>\n<p>Type: String</p>\n"
|
|
},
|
|
"AbuseContactEmail": {
|
|
"shape_name": "Email",
|
|
"type": "string",
|
|
"max_length": 254,
|
|
"documentation": "\n<p>Email address to contact to report incorrect contact information for a domain, to report that the domain\nis being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type\nof abuse. </p>\n<p>Type: String</p>\n"
|
|
},
|
|
"AbuseContactPhone": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>Phone number for reporting abuse. </p>\n<p>Type: String</p>\n"
|
|
},
|
|
"RegistryDomainId": {
|
|
"shape_name": "RegistryDomainId",
|
|
"type": "string",
|
|
"documentation": "\n<p>Reserved for future use.</p>\n"
|
|
},
|
|
"CreationDate": {
|
|
"shape_name": "Timestamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n<p>The date when the domain was created as found in the response to a WHOIS query. The date\nformat is Unix time.</p>\n"
|
|
},
|
|
"UpdatedDate": {
|
|
"shape_name": "Timestamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n<p>The last updated date of the domain as found in the response to a WHOIS query. The date\nformat is Unix time.</p>\n"
|
|
},
|
|
"ExpirationDate": {
|
|
"shape_name": "Timestamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n<p>The date when the registration for the domain is set to expire. The date format is Unix time.</p>\n"
|
|
},
|
|
"Reseller": {
|
|
"shape_name": "Reseller",
|
|
"type": "string",
|
|
"documentation": "\n<p>Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have\n<code>\"Amazon\"</code> as the reseller. </p>\n<p>Type: String</p>\n"
|
|
},
|
|
"DnsSec": {
|
|
"shape_name": "DNSSec",
|
|
"type": "string",
|
|
"documentation": "\n<p>Reserved for future use.</p>\n"
|
|
},
|
|
"StatusList": {
|
|
"shape_name": "DomainStatusList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DomainStatus",
|
|
"type": "string",
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n<p>An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.</p>\n<p>ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes\nthat tell you the status of a variety of operations on a domain name, for example, registering a domain name,\ntransferring a domain name to another registrar, renewing the registration for a domain name, and so on.\nAll registrars use this same set of status codes.</p>\n<p>For a current list of domain name status codes and an explanation of what each code means, go to the\n<a href=\"https://www.icann.org/\">ICANN website</a> and search for <code>epp status codes</code>.\n(Search on the ICANN website; web searches sometimes return an old version of the document.)</p>\n<p>Type: Array of String</p>\n"
|
|
}
|
|
},
|
|
"documentation": "\n<p>The GetDomainDetail response includes the following elements.</p>\n"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n"
|
|
}
|
|
],
|
|
"documentation": "\n<p>This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output.</p>\n<examples>\n<example>\n<name>GetDomainDetail Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.GetDomainDetail\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"DomainName\":\"example.com\"\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"AbuseContactEmail\":\"abuse@support.gandi.net\",\n \"AbuseContactPhone\":\"+33.170377661\",\n \"AdminContact\":{\n \"AddressLine1\":\"1 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Anytown\",\n \"CountryCode\":\"US\",\n \"Email\":\"john@example.com\",\n \"ExtraParams\":[\n ],\n \"FirstName\":\"John\",\n \"LastName\":\"Doe\",\n \"PhoneNumber\":\"+2065550100\",\n \"State\":\"WA\",\n \"ZipCode\":\"98101\"\n },\n \"AdminPrivacy\":true,\n \"AutoRenew\":true,\n \"CreationDate\":1400010459,\n \"DomainName\":\"example.com\",\n \"ExpirationDate\":1431539259,\n \"Nameservers\":[\n {\n \"GlueIps\":[\n ],\n \"Name\":\"ns-2048.awsdns-64.com\"\n },\n {\n \"GlueIps\":[\n ],\n \"Name\":\"ns-2051.awsdns-67.co.uk\"\n },\n {\n \"GlueIps\":[\n ],\n \"Name\":\"ns-2050.awsdns-66.org\"\n },\n {\n \"GlueIps\":[\n ],\n \"Name\":\"ns-2049.awsdns-65.net\"\n }\n ],\n \"RegistrantContact\":{\n \"AddressLine1\":\"1 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Anytown\",\n \"CountryCode\":\"US\",\n \"Email\":\"john@example.com\",\n \"ExtraParams\":[\n ],\n \"FirstName\":\"John\",\n \"LastName\":\"Doe\",\n \"PhoneNumber\":\"+2065550100\",\n \"State\":\"WA\",\n \"ZipCode\":\"98101\"\n },\n \"RegistrantPrivacy\":true,\n \"RegistrarName\":\"GANDI SAS\",\n \"RegistrarUrl\":\"http://www.gandi.net\",\n \"Reseller\":\"Amazon\",\n \"StatusList\":[\n \"clientTransferProhibited\"\n ],\n \"TechContact\":{\n \"AddressLine1\":\"1 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Anytown\",\n \"CountryCode\":\"US\",\n \"Email\":\"john@example.com\",\n \"ExtraParams\":[\n ],\n \"FirstName\":\"John\",\n \"LastName\":\"Doe\",\n \"PhoneNumber\":\"+2065550100\",\n \"State\":\"WA\",\n \"ZipCode\":\"98101\"\n },\n \"TechPrivacy\":true,\n \"UpdatedDate\":1400010459,\n \"WhoIsServer\":\"whois.gandi.net\"\n}</response>\n</example>\n</examples>\n"
|
|
},
|
|
"GetOperationDetail": {
|
|
"name": "GetOperationDetail",
|
|
"input": {
|
|
"shape_name": "GetOperationDetailRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"OperationId": {
|
|
"shape_name": "OperationId",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier\nin the response to the original request.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>The GetOperationDetail request includes the following element.</p>\n"
|
|
},
|
|
"output": {
|
|
"shape_name": "GetOperationDetailResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"OperationId": {
|
|
"shape_name": "OperationId",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The identifier for the operation.</p>\n<p>Type: String</p>\n"
|
|
},
|
|
"Status": {
|
|
"shape_name": "OperationStatus",
|
|
"type": "string",
|
|
"enum": [
|
|
"SUBMITTED",
|
|
"IN_PROGRESS",
|
|
"ERROR",
|
|
"SUCCESSFUL",
|
|
"FAILED"
|
|
],
|
|
"documentation": "\n<p>The current status of the requested operation in the system.</p>\n<p>Type: String</p>\n"
|
|
},
|
|
"Message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": "\n<p>Detailed information on the status including possible errors.</p>\n<p>Type: String</p>\n"
|
|
},
|
|
"DomainName": {
|
|
"shape_name": "DomainName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n"
|
|
},
|
|
"Type": {
|
|
"shape_name": "OperationType",
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTER_DOMAIN",
|
|
"DELETE_DOMAIN",
|
|
"TRANSFER_IN_DOMAIN",
|
|
"UPDATE_DOMAIN_CONTACT",
|
|
"UPDATE_NAMESERVER",
|
|
"CHANGE_PRIVACY_PROTECTION",
|
|
"DOMAIN_LOCK"
|
|
],
|
|
"documentation": "\n<p>The type of operation that was requested.</p>\n<p>Type: String</p>\n"
|
|
},
|
|
"SubmittedDate": {
|
|
"shape_name": "Timestamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n<p>The date when the request was submitted.</p>\n"
|
|
}
|
|
},
|
|
"documentation": "\n<p>The GetOperationDetail response includes the following elements.</p>\n"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n"
|
|
}
|
|
],
|
|
"documentation": "\n<p>This operation returns the current status of an operation that is not completed.</p>\n<examples>\n<example>\n<name>GetOperationDetail Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.GetOperationDetail\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"OperationId\":\"43884ce5-e30a-4801-858f-7aa86356c127\"\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"DomainName\":\"happierdomain.ca\",\n \"OperationId\":\"43884ce5-e30a-4801-858f-7aa86356c127\",\n \"Status\":\"WORKFLOW_IN_PROGRESS\",\n \"SubmittedDate\" : 1402630939.057,\n \"Type\" : \"REGISTER_DOMAIN\"\n}</response>\n</example>\n</examples>\n"
|
|
},
|
|
"ListDomains": {
|
|
"name": "ListDomains",
|
|
"input": {
|
|
"shape_name": "ListDomainsRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Marker": {
|
|
"shape_name": "PageMarker",
|
|
"type": "string",
|
|
"max_length": 4096,
|
|
"documentation": "\n<p>For an initial request for a list of domains, omit this element. If the number of domains\nthat are associated with the current AWS account is greater than the value that you specified for\n<code>MaxItems</code>, you can use <code>Marker</code> to return additional domains. Get the value of\n<code>NextPageMarker</code> from the previous response, and submit another request that includes the\nvalue of <code>NextPageMarker</code> in the <code>Marker</code> element.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: The marker must match the value specified in the previous request. </p>\n<p>Required: No</p>\n"
|
|
},
|
|
"MaxItems": {
|
|
"shape_name": "PageMaxItems",
|
|
"type": "integer",
|
|
"max_length": 100,
|
|
"documentation": "\n<p>Number of domains to be returned.</p>\n<p>Type: Integer</p>\n<p>Default: 20</p>\n<p>Constraints: A numeral between 1 and 100.</p>\n<p>Required: No</p>\n"
|
|
}
|
|
},
|
|
"documentation": "\n<p>The ListDomains request includes the following elements.</p>\n"
|
|
},
|
|
"output": {
|
|
"shape_name": "ListDomainsResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Domains": {
|
|
"shape_name": "DomainSummaryList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "DomainSummary",
|
|
"type": "structure",
|
|
"members": {
|
|
"DomainName": {
|
|
"shape_name": "DomainName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n",
|
|
"required": true
|
|
},
|
|
"AutoRenew": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>Indicates whether the domain is automatically renewed upon expiration.</p>\n<p>Type: Boolean</p>\n<p>Valid values: <code>True</code> | <code>False</code></p>\n"
|
|
},
|
|
"TransferLock": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>Indicates whether a domain is locked from unauthorized transfer to another party.</p>\n<p>Type: Boolean</p>\n<p>Valid values: <code>True</code> | <code>False</code></p>\n"
|
|
},
|
|
"Expiry": {
|
|
"shape_name": "Timestamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n<p>Expiration date of the domain in Coordinated Universal Time (UTC).</p>\n<p>Type: Long</p>\n"
|
|
}
|
|
},
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n<p>A summary of domains.</p>\n<p>Type: Complex type containing a list of domain summaries.</p>\n<p>Children: <code>AutoRenew</code>, <code>DomainName</code>,\n<code>Expiry</code>, <code>TransferLock</code></p>\n",
|
|
"required": true
|
|
},
|
|
"NextPageMarker": {
|
|
"shape_name": "PageMarker",
|
|
"type": "string",
|
|
"max_length": 4096,
|
|
"documentation": "\n<p>If there are more domains than you specified for <code>MaxItems</code> in the request, submit another\nrequest and include the value of <code>NextPageMarker</code> in the value of <code>Marker</code>.</p>\n<p>Type: String</p>\n<p>Parent: <code>Operations</code></p>\n"
|
|
}
|
|
},
|
|
"documentation": "\n<p>The ListDomains response includes the following elements.</p>\n"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n"
|
|
}
|
|
],
|
|
"documentation": "\n<p>This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.</p>\n<examples>\n<example>\n<name>ListDomains Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.ListDomains\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"Marker\":\"AxDAClaROQAXasf29GHWAIKPLA=\",\n \"MaxItems\":20\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"Domains\":[\n {\n \"AutoRenew\":false,\n \"DomainName\":\"example.com\",\n \"Expiry\":1431203765,\n \"TransferLock\":false\n },\n {\n \"AutoRenew\":false,\n \"DomainName\":\"example.net\",\n \"Expiry\":1431539260,\n \"TransferLock\":false\n },\n {\n \"AutoRenew\":false,\n \"DomainName\":\"example.org\",\n \"Expiry\":1431240024,\n \"TransferLock\":false\n },\n {\n \"AutoRenew\":false,\n \"DomainName\":\"example.test\",\n \"Expiry\":1431539259,\n \"TransferLock\":false\n }\n ]\n}</response>\n</example>\n</examples>\n"
|
|
},
|
|
"ListOperations": {
|
|
"name": "ListOperations",
|
|
"input": {
|
|
"shape_name": "ListOperationsRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"Marker": {
|
|
"shape_name": "PageMarker",
|
|
"type": "string",
|
|
"max_length": 4096,
|
|
"documentation": "\n<p>For an initial request for a list of operations, omit this element. If the number of operations that are\nnot yet complete is greater than the value that you specified for <code>MaxItems</code>, you can use <code>Marker</code>\nto return additional operations. Get the value of <code>NextPageMarker</code> from the previous response,\nand submit another request that includes the value of <code>NextPageMarker</code> in the <code>Marker</code> element.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Required: No</p>\n"
|
|
},
|
|
"MaxItems": {
|
|
"shape_name": "PageMaxItems",
|
|
"type": "integer",
|
|
"max_length": 100,
|
|
"documentation": "\n<p>Number of domains to be returned.</p>\n<p>Type: Integer</p>\n<p>Default: 20</p>\n<p>Constraints: A value between 1 and 100.</p>\n<p>Required: No</p>\n"
|
|
}
|
|
},
|
|
"documentation": "\n<p>The ListOperations request includes the following elements.</p>\n"
|
|
},
|
|
"output": {
|
|
"shape_name": "ListOperationsResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"Operations": {
|
|
"shape_name": "OperationSummaryList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "OperationSummary",
|
|
"type": "structure",
|
|
"members": {
|
|
"OperationId": {
|
|
"shape_name": "OperationId",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Identifier returned to track the requested action.</p>\n<p>Type: String</p>\n",
|
|
"required": true
|
|
},
|
|
"Status": {
|
|
"shape_name": "OperationStatus",
|
|
"type": "string",
|
|
"enum": [
|
|
"SUBMITTED",
|
|
"IN_PROGRESS",
|
|
"ERROR",
|
|
"SUCCESSFUL",
|
|
"FAILED"
|
|
],
|
|
"documentation": "\n<p>The current status of the requested operation in the system.</p>\n<p>Type: String</p>\n",
|
|
"required": true
|
|
},
|
|
"Type": {
|
|
"shape_name": "OperationType",
|
|
"type": "string",
|
|
"enum": [
|
|
"REGISTER_DOMAIN",
|
|
"DELETE_DOMAIN",
|
|
"TRANSFER_IN_DOMAIN",
|
|
"UPDATE_DOMAIN_CONTACT",
|
|
"UPDATE_NAMESERVER",
|
|
"CHANGE_PRIVACY_PROTECTION",
|
|
"DOMAIN_LOCK"
|
|
],
|
|
"documentation": "\n<p>Type of the action requested.</p>\n<p>Type: String</p>\n<p>Valid values: <code>REGISTER_DOMAIN</code> | <code>DELETE_DOMAIN</code> | <code>TRANSFER_IN_DOMAIN</code> | <code>UPDATE_DOMAIN_CONTACT</code> | <code>UPDATE_NAMESERVER</code> | <code>CHANGE_PRIVACY_PROTECTION</code> | <code>DOMAIN_LOCK</code></p>\n",
|
|
"required": true
|
|
},
|
|
"SubmittedDate": {
|
|
"shape_name": "Timestamp",
|
|
"type": "timestamp",
|
|
"documentation": "\n<p>The date when the request was submitted.</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>OperationSummary includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>Lists summaries of the operations.</p>\n<p>Type: Complex type containing a list of operation summaries</p>\n<p>Children: <code>OperationId</code>, <code>Status</code>, <code>SubmittedDate</code>,\n<code>Type</code></p>\n",
|
|
"required": true
|
|
},
|
|
"NextPageMarker": {
|
|
"shape_name": "PageMarker",
|
|
"type": "string",
|
|
"max_length": 4096,
|
|
"documentation": "\n<p>If there are more operations than you specified for <code>MaxItems</code> in the request, submit another\nrequest and include the value of <code>NextPageMarker</code> in the value of <code>Marker</code>.</p>\n<p>Type: String</p>\n<p>Parent: <code>Operations</code></p>\n"
|
|
}
|
|
},
|
|
"documentation": "\n<p>The ListOperations response includes the following elements.</p>\n"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n"
|
|
}
|
|
],
|
|
"documentation": "\n<p>This operation returns the operation IDs of operations that are not yet complete.</p>\n<examples>\n<example>\n<name>ListOperations Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.ListOperations\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"MaxItems\" : 2\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"Operations\":[\n {\n \"OperationId\":\"4ced3d4a-e011-45ee-b94f-1e2d73477562\",\n \"Status\":\"WORKFLOW_IN_PROGRESS\",\n \"SubmittedDate\":1403548979.088,\n \"Type\":\"CHANGE_PRIVACY_PROTECTION\"\n },\n {\n \"OperationId\":\"2e3ac45b-89b3-47ea-a042-f56dcd1b6883\",\n \"Status\":\"WORKFLOW_IN_PROGRESS\",\n \"SubmittedDate\":1403548986.429,\n \"Type\":\"DOMAIN_LOCK\"\n }\n ]\n}</response>\n</example>\n</examples>\n"
|
|
},
|
|
"RegisterDomain": {
|
|
"name": "RegisterDomain",
|
|
"input": {
|
|
"shape_name": "RegisterDomainRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"DomainName": {
|
|
"shape_name": "DomainName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>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.</p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"IdnLangCode": {
|
|
"shape_name": "LangCode",
|
|
"type": "string",
|
|
"max_length": 3,
|
|
"documentation": "\n<p>Reserved for future use.</p>\n"
|
|
},
|
|
"DurationInYears": {
|
|
"shape_name": "DurationInYears",
|
|
"type": "integer",
|
|
"min_length": 1,
|
|
"max_length": 10,
|
|
"documentation": "\n<p>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.</p>\n<p>Type: Integer</p>\n<p>Default: 1</p>\n<p>Valid values: Integer from 1 to 10</p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"AutoRenew": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>Indicates whether the domain will be automatically renewed (<code>true</code>) or not (<code>false</code>). Autorenewal only takes effect after the account is charged.</p>\n<p>Type: Boolean</p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Default: <code>true</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"AdminContact": {
|
|
"shape_name": "ContactDetail",
|
|
"type": "structure",
|
|
"members": {
|
|
"FirstName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"LastName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ContactType": {
|
|
"shape_name": "ContactType",
|
|
"type": "string",
|
|
"enum": [
|
|
"PERSON",
|
|
"COMPANY",
|
|
"ASSOCIATION",
|
|
"PUBLIC_BODY",
|
|
"RESELLER"
|
|
],
|
|
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"OrganizationName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"AddressLine1": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"AddressLine2": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"City": {
|
|
"shape_name": "City",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"State": {
|
|
"shape_name": "State",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"CountryCode": {
|
|
"shape_name": "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"
|
|
],
|
|
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ZipCode": {
|
|
"shape_name": "ZipCode",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"PhoneNumber": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Email": {
|
|
"shape_name": "Email",
|
|
"type": "string",
|
|
"max_length": 254,
|
|
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Fax": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"ExtraParams": {
|
|
"shape_name": "ExtraParamList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "ExtraParam",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "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",
|
|
"FI_BUSINESS_NUMBER",
|
|
"FI_ID_NUMBER",
|
|
"IT_PIN",
|
|
"RU_PASSPORT_DATA",
|
|
"SE_ID_NUMBER",
|
|
"SG_ID_NUMBER",
|
|
"VAT_NUMBER"
|
|
],
|
|
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"Value": {
|
|
"shape_name": "ExtraParamValue",
|
|
"type": "string",
|
|
"max_length": 2048,
|
|
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
|
}
|
|
},
|
|
"sensitive": true,
|
|
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"RegistrantContact": {
|
|
"shape_name": "ContactDetail",
|
|
"type": "structure",
|
|
"members": {
|
|
"FirstName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"LastName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ContactType": {
|
|
"shape_name": "ContactType",
|
|
"type": "string",
|
|
"enum": [
|
|
"PERSON",
|
|
"COMPANY",
|
|
"ASSOCIATION",
|
|
"PUBLIC_BODY",
|
|
"RESELLER"
|
|
],
|
|
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"OrganizationName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"AddressLine1": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"AddressLine2": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"City": {
|
|
"shape_name": "City",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"State": {
|
|
"shape_name": "State",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"CountryCode": {
|
|
"shape_name": "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"
|
|
],
|
|
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ZipCode": {
|
|
"shape_name": "ZipCode",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"PhoneNumber": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Email": {
|
|
"shape_name": "Email",
|
|
"type": "string",
|
|
"max_length": 254,
|
|
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Fax": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"ExtraParams": {
|
|
"shape_name": "ExtraParamList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "ExtraParam",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "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",
|
|
"FI_BUSINESS_NUMBER",
|
|
"FI_ID_NUMBER",
|
|
"IT_PIN",
|
|
"RU_PASSPORT_DATA",
|
|
"SE_ID_NUMBER",
|
|
"SG_ID_NUMBER",
|
|
"VAT_NUMBER"
|
|
],
|
|
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"Value": {
|
|
"shape_name": "ExtraParamValue",
|
|
"type": "string",
|
|
"max_length": 2048,
|
|
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
|
}
|
|
},
|
|
"sensitive": true,
|
|
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"TechContact": {
|
|
"shape_name": "ContactDetail",
|
|
"type": "structure",
|
|
"members": {
|
|
"FirstName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"LastName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ContactType": {
|
|
"shape_name": "ContactType",
|
|
"type": "string",
|
|
"enum": [
|
|
"PERSON",
|
|
"COMPANY",
|
|
"ASSOCIATION",
|
|
"PUBLIC_BODY",
|
|
"RESELLER"
|
|
],
|
|
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"OrganizationName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"AddressLine1": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"AddressLine2": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"City": {
|
|
"shape_name": "City",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"State": {
|
|
"shape_name": "State",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"CountryCode": {
|
|
"shape_name": "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"
|
|
],
|
|
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ZipCode": {
|
|
"shape_name": "ZipCode",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"PhoneNumber": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Email": {
|
|
"shape_name": "Email",
|
|
"type": "string",
|
|
"max_length": 254,
|
|
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Fax": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"ExtraParams": {
|
|
"shape_name": "ExtraParamList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "ExtraParam",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "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",
|
|
"FI_BUSINESS_NUMBER",
|
|
"FI_ID_NUMBER",
|
|
"IT_PIN",
|
|
"RU_PASSPORT_DATA",
|
|
"SE_ID_NUMBER",
|
|
"SG_ID_NUMBER",
|
|
"VAT_NUMBER"
|
|
],
|
|
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"Value": {
|
|
"shape_name": "ExtraParamValue",
|
|
"type": "string",
|
|
"max_length": 2048,
|
|
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
|
}
|
|
},
|
|
"sensitive": true,
|
|
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"PrivacyProtectAdminContact": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>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.</p>\n<p>Type: Boolean</p>\n<p>Default: <code>true</code></p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
|
},
|
|
"PrivacyProtectRegistrantContact": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>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.</p>\n<p>Type: Boolean</p>\n<p>Default: <code>true</code></p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
|
},
|
|
"PrivacyProtectTechContact": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>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.</p>\n<p>Type: Boolean</p>\n<p>Default: <code>true</code></p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
|
}
|
|
},
|
|
"documentation": "\n<p>The RegisterDomain request includes the following elements.</p>\n"
|
|
},
|
|
"output": {
|
|
"shape_name": "RegisterDomainResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"OperationId": {
|
|
"shape_name": "OperationId",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p>\n <p>Type: String</p>\n <p>Default: None</p>\n <p>Constraints: Maximum 255 characters.</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>The RegisterDomain response includes the following element.</p>\n"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "UnsupportedTLD",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>Amazon Route 53 does not support this top-level domain.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "DuplicateRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The request is already in progress for the domain.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "TLDRulesViolation",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The top-level domain does not support this operation.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "DomainLimitExceeded",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The number of domains has exceeded the allowed threshold for the account.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "OperationLimitExceeded",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The number of operations or jobs running exceeded the allowed threshold for the account.</p>\n"
|
|
}
|
|
],
|
|
"documentation": "\n<p>This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi.\nFor some top-level domains (TLDs), this operation requires extra parameters.</p>\n<p>When you register a domain, Amazon Route 53 does the following:</p>\n<ul>\n<li>Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers\nto your hosted zone and automatically updates your domain registration with the names of these name servers.</li>\n<li>Enables autorenew, so your domain registration will renew automatically each year. We'll notify you\nin advance of the renewal date so you can choose whether to renew the registration.</li>\n<li>Optionally enables privacy protection, so WHOIS queries return contact information for our registrar partner, Gandi,\ninstead of the information you entered for registrant, admin, and tech contacts.</li>\n<li>If registration is successful, returns an operation ID that you can use to track the progress and\ncompletion of the action. If the request is not completed successfully, the domain registrant is notified by email.</li>\n<li>Charges your AWS account an amount based on the top-level domain. For more information, see <a href=\"http://aws.amazon.com/route53/pricing/\">Amazon Route 53 Pricing</a>.</li>\n</ul>\n<examples>\n<example>\n<name>RegisterDomain Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.RegisterDomain\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"DomainName\":\"example.com\",\n \"DurationInYears\":1,\n \"AutoRenew\":true,\n \"AdminContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+2065550101\"\n },\n \"RegistrantContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+2065550101\"\n },\n \"TechContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+2065550101\"\n},\n\"PrivacyProtectAdminContact\":true,\n\"PrivacyProtectRegistrantContact\":true,\n\"PrivacyProtectTechContact\":true\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"OperationId\":\"308c56712-faa4-40fe-94c8-b423069de3f6\"\n}</response>\n</example>\n</examples>\n"
|
|
},
|
|
"RetrieveDomainAuthCode": {
|
|
"name": "RetrieveDomainAuthCode",
|
|
"input": {
|
|
"shape_name": "RetrieveDomainAuthCodeRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"DomainName": {
|
|
"shape_name": "DomainName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>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.</p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>The RetrieveDomainAuthCode request includes the following element.</p>\n"
|
|
},
|
|
"output": {
|
|
"shape_name": "RetrieveDomainAuthCodeResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"AuthCode": {
|
|
"shape_name": "DomainAuthCode",
|
|
"type": "string",
|
|
"max_length": 1024,
|
|
"sensitive": true,
|
|
"documentation": "\n<p>The authorization code for the domain.</p>\n<p>Type: String</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>The RetrieveDomainAuthCode response includes the following element.</p>\n"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n"
|
|
}
|
|
],
|
|
"documentation": "\n<p>This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.</p>\n<examples>\n<example>\n<name>RetrieveDomainAuthCode Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.RetrieveDomainAuthCode\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"DomainName\":\"example.com\"\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"AuthCode\":\"rqL3*REjYH\"\n}</response>\n</example>\n</examples>\n"
|
|
},
|
|
"TransferDomain": {
|
|
"name": "TransferDomain",
|
|
"input": {
|
|
"shape_name": "TransferDomainRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"DomainName": {
|
|
"shape_name": "DomainName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>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.</p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"IdnLangCode": {
|
|
"shape_name": "LangCode",
|
|
"type": "string",
|
|
"max_length": 3,
|
|
"documentation": "\n<p>Reserved for future use.</p>\n"
|
|
},
|
|
"DurationInYears": {
|
|
"shape_name": "DurationInYears",
|
|
"type": "integer",
|
|
"min_length": 1,
|
|
"max_length": 10,
|
|
"documentation": "\n<p>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.</p>\n<p>Type: Integer</p>\n<p>Default: 1</p>\n<p>Valid values: Integer from 1 to 10</p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"Nameservers": {
|
|
"shape_name": "NameserverList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Nameserver",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "HostName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The fully qualified host name of the name server.</p>\n<p>Type: String</p>\n<p>Constraint: Maximum 255 characterss</p>\n<p>Parent: <code>Nameservers</code></p>\n",
|
|
"required": true
|
|
},
|
|
"GlueIps": {
|
|
"shape_name": "GlueIpList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "GlueIp",
|
|
"type": "string",
|
|
"max_length": 45,
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n<p>Glue IP address of a name server entry. Glue IP addresses are required only when the name of the\nname server is a subdomain of the domain. For example, if your domain is example.com and the name\nserver for the domain is ns.example.com, you need to specify the IP address for ns.example.com.</p>\n<p>Type: List of IP addresses.</p>\n<p>Constraints: The list can contain only one IPv4 and one IPv6 address.</p>\n<p>Parent: <code>Nameservers</code></p>\n"
|
|
}
|
|
},
|
|
"documentation": "\n<p>Nameserver includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>Contains details for the host and glue IP addresses.</p>\n<p>Type: Complex</p>\n<p>Children: <code>GlueIps</code>, <code>Name</code></p>\n",
|
|
"required": true
|
|
},
|
|
"AuthCode": {
|
|
"shape_name": "DomainAuthCode",
|
|
"type": "string",
|
|
"max_length": 1024,
|
|
"sensitive": true,
|
|
"documentation": "\n<p>The authorization code for the domain. You get this value from the current registrar.</p>\n<p>Type: String</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"AutoRenew": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.</p>\n<p>Type: Boolean</p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Default: true</p>\n<p>Required: No</p>\n"
|
|
},
|
|
"AdminContact": {
|
|
"shape_name": "ContactDetail",
|
|
"type": "structure",
|
|
"members": {
|
|
"FirstName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"LastName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ContactType": {
|
|
"shape_name": "ContactType",
|
|
"type": "string",
|
|
"enum": [
|
|
"PERSON",
|
|
"COMPANY",
|
|
"ASSOCIATION",
|
|
"PUBLIC_BODY",
|
|
"RESELLER"
|
|
],
|
|
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"OrganizationName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"AddressLine1": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"AddressLine2": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"City": {
|
|
"shape_name": "City",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"State": {
|
|
"shape_name": "State",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"CountryCode": {
|
|
"shape_name": "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"
|
|
],
|
|
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ZipCode": {
|
|
"shape_name": "ZipCode",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"PhoneNumber": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Email": {
|
|
"shape_name": "Email",
|
|
"type": "string",
|
|
"max_length": 254,
|
|
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Fax": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"ExtraParams": {
|
|
"shape_name": "ExtraParamList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "ExtraParam",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "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",
|
|
"FI_BUSINESS_NUMBER",
|
|
"FI_ID_NUMBER",
|
|
"IT_PIN",
|
|
"RU_PASSPORT_DATA",
|
|
"SE_ID_NUMBER",
|
|
"SG_ID_NUMBER",
|
|
"VAT_NUMBER"
|
|
],
|
|
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"Value": {
|
|
"shape_name": "ExtraParamValue",
|
|
"type": "string",
|
|
"max_length": 2048,
|
|
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
|
}
|
|
},
|
|
"sensitive": true,
|
|
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"RegistrantContact": {
|
|
"shape_name": "ContactDetail",
|
|
"type": "structure",
|
|
"members": {
|
|
"FirstName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"LastName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ContactType": {
|
|
"shape_name": "ContactType",
|
|
"type": "string",
|
|
"enum": [
|
|
"PERSON",
|
|
"COMPANY",
|
|
"ASSOCIATION",
|
|
"PUBLIC_BODY",
|
|
"RESELLER"
|
|
],
|
|
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"OrganizationName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"AddressLine1": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"AddressLine2": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"City": {
|
|
"shape_name": "City",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"State": {
|
|
"shape_name": "State",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"CountryCode": {
|
|
"shape_name": "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"
|
|
],
|
|
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ZipCode": {
|
|
"shape_name": "ZipCode",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"PhoneNumber": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Email": {
|
|
"shape_name": "Email",
|
|
"type": "string",
|
|
"max_length": 254,
|
|
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Fax": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"ExtraParams": {
|
|
"shape_name": "ExtraParamList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "ExtraParam",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "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",
|
|
"FI_BUSINESS_NUMBER",
|
|
"FI_ID_NUMBER",
|
|
"IT_PIN",
|
|
"RU_PASSPORT_DATA",
|
|
"SE_ID_NUMBER",
|
|
"SG_ID_NUMBER",
|
|
"VAT_NUMBER"
|
|
],
|
|
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"Value": {
|
|
"shape_name": "ExtraParamValue",
|
|
"type": "string",
|
|
"max_length": 2048,
|
|
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
|
}
|
|
},
|
|
"sensitive": true,
|
|
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"TechContact": {
|
|
"shape_name": "ContactDetail",
|
|
"type": "structure",
|
|
"members": {
|
|
"FirstName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"LastName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ContactType": {
|
|
"shape_name": "ContactType",
|
|
"type": "string",
|
|
"enum": [
|
|
"PERSON",
|
|
"COMPANY",
|
|
"ASSOCIATION",
|
|
"PUBLIC_BODY",
|
|
"RESELLER"
|
|
],
|
|
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"OrganizationName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"AddressLine1": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"AddressLine2": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"City": {
|
|
"shape_name": "City",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"State": {
|
|
"shape_name": "State",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"CountryCode": {
|
|
"shape_name": "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"
|
|
],
|
|
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ZipCode": {
|
|
"shape_name": "ZipCode",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"PhoneNumber": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Email": {
|
|
"shape_name": "Email",
|
|
"type": "string",
|
|
"max_length": 254,
|
|
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Fax": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"ExtraParams": {
|
|
"shape_name": "ExtraParamList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "ExtraParam",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "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",
|
|
"FI_BUSINESS_NUMBER",
|
|
"FI_ID_NUMBER",
|
|
"IT_PIN",
|
|
"RU_PASSPORT_DATA",
|
|
"SE_ID_NUMBER",
|
|
"SG_ID_NUMBER",
|
|
"VAT_NUMBER"
|
|
],
|
|
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"Value": {
|
|
"shape_name": "ExtraParamValue",
|
|
"type": "string",
|
|
"max_length": 2048,
|
|
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
|
}
|
|
},
|
|
"sensitive": true,
|
|
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"PrivacyProtectAdminContact": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>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.</p>\n<p>Type: Boolean</p>\n<p>Default: <code>true</code></p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
|
},
|
|
"PrivacyProtectRegistrantContact": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>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.</p>\n<p>Type: Boolean</p>\n<p>Default: <code>true</code></p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
|
},
|
|
"PrivacyProtectTechContact": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>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.</p>\n<p>Type: Boolean</p>\n<p>Default: <code>true</code></p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
|
}
|
|
},
|
|
"documentation": "\n<p>The TransferDomain request includes the following elements.</p>\n"
|
|
},
|
|
"output": {
|
|
"shape_name": "TransferDomainResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"OperationId": {
|
|
"shape_name": "OperationId",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p>\n <p>Type: String</p>\n <p>Default: None</p>\n <p>Constraints: Maximum 255 characters.</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>The TranserDomain response includes the following element.</p>\n"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "UnsupportedTLD",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>Amazon Route 53 does not support this top-level domain.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "DuplicateRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The request is already in progress for the domain.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "TLDRulesViolation",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The top-level domain does not support this operation.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "DomainLimitExceeded",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The number of domains has exceeded the allowed threshold for the account.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "OperationLimitExceeded",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The number of operations or jobs running exceeded the allowed threshold for the account.</p>\n"
|
|
}
|
|
],
|
|
"documentation": "\n<p>This operation transfers a domain from another registrar to Amazon Route 53. Domains are registered by the\nAWS registrar, Gandi upon transfer.</p>\n<p>To transfer a domain, you need to meet all the domain transfer criteria, including the following:</p>\n<ul>\n<li>You must supply nameservers to transfer a domain.</li>\n<li>You must disable the domain transfer lock (if any) before transferring the domain.</li>\n<li>A minimum of 60 days must have elapsed since the domain's registration or last transfer.</li>\n</ul>\n<p>We recommend you use the Amazon Route 53 as the DNS service for your domain. You can create a hosted\nzone in Amazon Route 53 for your current domain before transferring your domain.</p>\n<p>Note that upon transfer, the domain duration is extended for a year if not otherwise\nspecified. Autorenew is enabled by default.</p>\n<p>If the transfer is successful, this method returns an operation ID that you can use to\ntrack the progress and completion of the action. If the request is not completed\nsuccessfully, the domain registrant will be notified by email.</p>\n<p>Transferring domains charges your AWS account an amount based on the top-level domain. For more\ninformation, see <a href=\"http://aws.amazon.com/route53/pricing/\">Amazon Route 53 Pricing</a>. </p>\n<examples>\n<example>\n<name>TransferDomain Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.TransferDomain\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"DomainName\":\"example.com\",\n \"DurationInYears\":1,\n \"Nameservers\":[\n {\n \"Name\":\"ns-2048.awsdns-64.com\",\n \"GlueIps\":[\n \"192.0.2.11\"\n ]\n },\n {\n \"Name\":\"ns-2049.awsdns-65.net\",\n \"GlueIps\":[\n \"192.0.2.12\"\n ]\n }\n ],\n \"AuthCode\":\"a42qxjz1\",\n \"AutoRenew\":true,\n \"AdminContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+206555-0101\"\n },\n \"RegistrantContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+206555-0101\"\n },\n \"TechContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+206555-0101\"\n },\n \"PrivacyProtectAdminContact\":true,\n \"PrivacyProtectRegistrantContact\":true,\n \"PrivacyProtectTechContact\":true,\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n\"OperationId\":\"308c56712-faa4-40fe-94c8-b423069de3f6\"\n}</response>\n</example>\n</examples>\n"
|
|
},
|
|
"UpdateDomainContact": {
|
|
"name": "UpdateDomainContact",
|
|
"input": {
|
|
"shape_name": "UpdateDomainContactRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"DomainName": {
|
|
"shape_name": "DomainName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>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.</p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"AdminContact": {
|
|
"shape_name": "ContactDetail",
|
|
"type": "structure",
|
|
"members": {
|
|
"FirstName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"LastName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ContactType": {
|
|
"shape_name": "ContactType",
|
|
"type": "string",
|
|
"enum": [
|
|
"PERSON",
|
|
"COMPANY",
|
|
"ASSOCIATION",
|
|
"PUBLIC_BODY",
|
|
"RESELLER"
|
|
],
|
|
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"OrganizationName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"AddressLine1": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"AddressLine2": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"City": {
|
|
"shape_name": "City",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"State": {
|
|
"shape_name": "State",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"CountryCode": {
|
|
"shape_name": "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"
|
|
],
|
|
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ZipCode": {
|
|
"shape_name": "ZipCode",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"PhoneNumber": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Email": {
|
|
"shape_name": "Email",
|
|
"type": "string",
|
|
"max_length": 254,
|
|
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Fax": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"ExtraParams": {
|
|
"shape_name": "ExtraParamList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "ExtraParam",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "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",
|
|
"FI_BUSINESS_NUMBER",
|
|
"FI_ID_NUMBER",
|
|
"IT_PIN",
|
|
"RU_PASSPORT_DATA",
|
|
"SE_ID_NUMBER",
|
|
"SG_ID_NUMBER",
|
|
"VAT_NUMBER"
|
|
],
|
|
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"Value": {
|
|
"shape_name": "ExtraParamValue",
|
|
"type": "string",
|
|
"max_length": 2048,
|
|
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
|
}
|
|
},
|
|
"sensitive": true,
|
|
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"RegistrantContact": {
|
|
"shape_name": "ContactDetail",
|
|
"type": "structure",
|
|
"members": {
|
|
"FirstName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"LastName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ContactType": {
|
|
"shape_name": "ContactType",
|
|
"type": "string",
|
|
"enum": [
|
|
"PERSON",
|
|
"COMPANY",
|
|
"ASSOCIATION",
|
|
"PUBLIC_BODY",
|
|
"RESELLER"
|
|
],
|
|
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"OrganizationName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"AddressLine1": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"AddressLine2": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"City": {
|
|
"shape_name": "City",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"State": {
|
|
"shape_name": "State",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"CountryCode": {
|
|
"shape_name": "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"
|
|
],
|
|
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ZipCode": {
|
|
"shape_name": "ZipCode",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"PhoneNumber": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Email": {
|
|
"shape_name": "Email",
|
|
"type": "string",
|
|
"max_length": 254,
|
|
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Fax": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"ExtraParams": {
|
|
"shape_name": "ExtraParamList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "ExtraParam",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "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",
|
|
"FI_BUSINESS_NUMBER",
|
|
"FI_ID_NUMBER",
|
|
"IT_PIN",
|
|
"RU_PASSPORT_DATA",
|
|
"SE_ID_NUMBER",
|
|
"SG_ID_NUMBER",
|
|
"VAT_NUMBER"
|
|
],
|
|
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"Value": {
|
|
"shape_name": "ExtraParamValue",
|
|
"type": "string",
|
|
"max_length": 2048,
|
|
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
|
}
|
|
},
|
|
"sensitive": true,
|
|
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"TechContact": {
|
|
"shape_name": "ContactDetail",
|
|
"type": "structure",
|
|
"members": {
|
|
"FirstName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"LastName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Last name of contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ContactType": {
|
|
"shape_name": "ContactType",
|
|
"type": "string",
|
|
"enum": [
|
|
"PERSON",
|
|
"COMPANY",
|
|
"ASSOCIATION",
|
|
"PUBLIC_BODY",
|
|
"RESELLER"
|
|
],
|
|
"documentation": "\n<p>Indicates whether the contact is a person, company, association, or public organization.\nIf you choose an option other than <code>PERSON</code>, you must enter an organization name, and you can't\nenable privacy protection for the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Valid values: <code>PERSON</code> | <code>COMPANY</code> | <code>ASSOCIATION</code> | <code>PUBLIC_BODY</code></p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"OrganizationName": {
|
|
"shape_name": "ContactName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Name of the organization for contact types other than <code>PERSON</code>.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters. Contact type must not be <code>PERSON</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"AddressLine1": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>First line of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"AddressLine2": {
|
|
"shape_name": "AddressLine",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Second line of contact's address, if any.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"City": {
|
|
"shape_name": "City",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The city of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"State": {
|
|
"shape_name": "State",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The state or province of the contact's city.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"CountryCode": {
|
|
"shape_name": "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"
|
|
],
|
|
"documentation": "\n<p>Code for the country of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"ZipCode": {
|
|
"shape_name": "ZipCode",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>The zip or postal code of the contact's address.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 255 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"PhoneNumber": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>The phone number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code>]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Email": {
|
|
"shape_name": "Email",
|
|
"type": "string",
|
|
"max_length": 254,
|
|
"documentation": "\n<p>Email address of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 254 characters.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code>\n</p>\n<p>Required: Yes</p>\n"
|
|
},
|
|
"Fax": {
|
|
"shape_name": "ContactNumber",
|
|
"type": "string",
|
|
"max_length": 30,
|
|
"documentation": "\n<p>Fax number of the contact.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Phone number must be specified in the format \"+[country\ndialing code].[number including any\narea code]\". For example, a US phone number might\nappear as <code>\"+1.1234567890\"</code>.</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Required: No</p>\n"
|
|
},
|
|
"ExtraParams": {
|
|
"shape_name": "ExtraParamList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "ExtraParam",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "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",
|
|
"FI_BUSINESS_NUMBER",
|
|
"FI_ID_NUMBER",
|
|
"IT_PIN",
|
|
"RU_PASSPORT_DATA",
|
|
"SE_ID_NUMBER",
|
|
"SG_ID_NUMBER",
|
|
"VAT_NUMBER"
|
|
],
|
|
"documentation": "\n<p>Name of the additional parameter required by the top-level domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Valid values: <code>DUNS_NUMBER</code> | <code>BRAND_NUMBER</code> | <code>BIRTH_DEPARTMENT</code> |\n<code>BIRTH_DATE_IN_YYYY_MM_DD</code> | <code>BIRTH_COUNTRY</code> | <code>BIRTH_CITY</code> |\n<code>DOCUMENT_NUMBER</code> | <code>AU_ID_NUMBER</code> | <code>AU_ID_TYPE</code> | <code>CA_LEGAL_TYPE</code> |\n<code>FI_BUSINESS_NUMBER</code> | <code>FI_ID_NUMBER</code> | <code>IT_PIN</code> | <code>RU_PASSPORT_DATA</code> |\n<code>SE_ID_NUMBER</code> | <code>SG_ID_NUMBER</code> | <code>VAT_NUMBER</code></p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"Value": {
|
|
"shape_name": "ExtraParamValue",
|
|
"type": "string",
|
|
"max_length": 2048,
|
|
"documentation": "\n<p>Values corresponding to the additional parameter names required by some top-level\ndomains.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>Constraints: Maximum 2048 characters.</p>\n<p>Parent: <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>ExtraParam includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>A list of name-value pairs for parameters required by certain top-level\ndomains.</p>\n<p>Type: Complex</p>\n<p>Default: None</p>\n<p>Parents: <code>RegistrantContact</code>, <code>AdminContact</code>, <code>TechContact</code></p>\n<p>Children: <code>Name</code>, <code>Value</code></p>\n<p>Required: No</p>\n"
|
|
}
|
|
},
|
|
"sensitive": true,
|
|
"documentation": "\n<p>Provides detailed contact information.</p>\n<p>Type: Complex</p>\n<p>Children: <code>FirstName</code>, <code>MiddleName</code>, <code>LastName</code>, <code>ContactType</code>, <code>OrganizationName</code>, <code>AddressLine1</code>, <code>AddressLine2</code>, <code>City</code>, <code>State</code>, <code>CountryCode</code>, <code>ZipCode</code>, <code>PhoneNumber</code>, <code>Email</code>, <code>Fax</code>, <code>ExtraParams</code></p>\n<p>Required: Yes</p>\n"
|
|
}
|
|
},
|
|
"documentation": "\n<p>The UpdateDomainContact request includes the following elements.</p>\n"
|
|
},
|
|
"output": {
|
|
"shape_name": "UpdateDomainContactResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"OperationId": {
|
|
"shape_name": "OperationId",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p>\n <p>Type: String</p>\n <p>Default: None</p>\n <p>Constraints: Maximum 255 characters.</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>The UpdateDomainContact response includes the following element.</p>\n"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "DuplicateRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The request is already in progress for the domain.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "TLDRulesViolation",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The top-level domain does not support this operation.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "OperationLimitExceeded",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The number of operations or jobs running exceeded the allowed threshold for the account.</p>\n"
|
|
}
|
|
],
|
|
"documentation": "\n<p>This operation updates the contact information for a particular domain.\nInformation for at least one contact (registrant, administrator, or technical) must be\nsupplied for update.</p>\n<p>If the update is successful, this method returns an operation ID that you can use to\ntrack the progress and completion of the action. If the request is not completed\nsuccessfully, the domain registrant will be notified by email.</p>\n<examples>\n<example>\n<name>UpdateDomainContact Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.UpdateDomainContact\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"DomainName\":\"example.com\",\n \"RegistrantContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+2065550101\"\n },\n \"AdminContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+2065550101\"\n },\n \"TechContact\":{\n \"FirstName\":\"John\",\n \"MiddleName\":\"Richard\",\n \"LastName\":\"Doe\",\n \"ContactType\":\"PERSON\",\n \"OrganizationName\":\"\",\n \"AddressLine1\":\"123 Any Street\",\n \"AddressLine2\":\"\",\n \"City\":\"Any Town\",\n \"State\":\"WA\",\n \"CountryCode\":\"US\",\n \"ZipCode\":\"98101\",\n \"PhoneNumber\":\"+2065550100\",\n \"Email\":\"john@example.com\",\n \"Fax\":\"+2065550101\"\n },\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n\"OperationId\":\"308c56712-faa4-40fe-94c8-b423069de3f6\"\n}</response>\n</example>\n</examples>\n"
|
|
},
|
|
"UpdateDomainContactPrivacy": {
|
|
"name": "UpdateDomainContactPrivacy",
|
|
"input": {
|
|
"shape_name": "UpdateDomainContactPrivacyRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"DomainName": {
|
|
"shape_name": "DomainName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>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.</p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"AdminPrivacy": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>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.</p>\n<p>Type: Boolean</p>\n<p>Default: None</p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
|
},
|
|
"RegistrantPrivacy": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>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.</p>\n<p>Type: Boolean</p>\n<p>Default: None</p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
|
},
|
|
"TechPrivacy": {
|
|
"shape_name": "Boolean",
|
|
"type": "boolean",
|
|
"documentation": "\n<p>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.</p>\n<p>Type: Boolean</p>\n<p>Default: None</p>\n<p>Valid values: <code>true</code> | <code>false</code></p>\n<p>Required: No</p>\n\n"
|
|
}
|
|
},
|
|
"documentation": "\n<p>The UpdateDomainContactPrivacy request includes the following elements.</p>\n"
|
|
},
|
|
"output": {
|
|
"shape_name": "UpdateDomainContactPrivacyResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"OperationId": {
|
|
"shape_name": "OperationId",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p>\n <p>Type: String</p>\n <p>Default: None</p>\n <p>Constraints: Maximum 255 characters.</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>The UpdateDomainContactPrivacy response includes the following element.</p>\n"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "DuplicateRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The request is already in progress for the domain.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "TLDRulesViolation",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The top-level domain does not support this operation.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "OperationLimitExceeded",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The number of operations or jobs running exceeded the allowed threshold for the account.</p>\n"
|
|
}
|
|
],
|
|
"documentation": "\n<p>This operation updates the specified domain contact's privacy setting. When the privacy\noption is enabled, personal information such as postal or email address is hidden from the\nresults of a public WHOIS query. The privacy services are provided by the AWS registrar,\nGandi. For more information, see the <a href=\"http://www.gandi.net/domain/whois/?currency=USD&amp;lang=en\">Gandi privacy\nfeatures</a>.</p>\n<p>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.</p>\n<examples>\n<example>\n<name>UpdateDomainContactPrivacy Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.UpdateDomainContactPrivacy\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n\"DomainName\":\"example.com\",\n\"AdminPrivacy\":true,\n\"RegistrantPrivacy\":true,\n\"TechPrivacy\":true,\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n\"OperationId\":\"777bc5da-fbf7-482c-b2ba-8946884a7dd6\"\n}</response>\n</example>\n</examples>\n"
|
|
},
|
|
"UpdateDomainNameservers": {
|
|
"name": "UpdateDomainNameservers",
|
|
"input": {
|
|
"shape_name": "UpdateDomainNameserversRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"DomainName": {
|
|
"shape_name": "DomainName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The name of a domain.</p>\n<p>Type: String</p>\n<p>Default: None</p>\n<p>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.</p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
},
|
|
"Nameservers": {
|
|
"shape_name": "NameserverList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "Nameserver",
|
|
"type": "structure",
|
|
"members": {
|
|
"Name": {
|
|
"shape_name": "HostName",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"pattern": "[a-zA-Z0-9_\\-.]*",
|
|
"documentation": "\n<p>The fully qualified host name of the name server.</p>\n<p>Type: String</p>\n<p>Constraint: Maximum 255 characterss</p>\n<p>Parent: <code>Nameservers</code></p>\n",
|
|
"required": true
|
|
},
|
|
"GlueIps": {
|
|
"shape_name": "GlueIpList",
|
|
"type": "list",
|
|
"members": {
|
|
"shape_name": "GlueIp",
|
|
"type": "string",
|
|
"max_length": 45,
|
|
"documentation": null
|
|
},
|
|
"documentation": "\n<p>Glue IP address of a name server entry. Glue IP addresses are required only when the name of the\nname server is a subdomain of the domain. For example, if your domain is example.com and the name\nserver for the domain is ns.example.com, you need to specify the IP address for ns.example.com.</p>\n<p>Type: List of IP addresses.</p>\n<p>Constraints: The list can contain only one IPv4 and one IPv6 address.</p>\n<p>Parent: <code>Nameservers</code></p>\n"
|
|
}
|
|
},
|
|
"documentation": "\n<p>Nameserver includes the following elements.</p>\n"
|
|
},
|
|
"documentation": "\n<p>A list of new name servers for the domain.</p>\n<p>Type: Complex</p>\n<p>Children: <code>Name</code>, <code>GlueIps</code></p>\n<p>Required: Yes</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>The UpdateDomainNameserver request includes the following elements.</p>\n"
|
|
},
|
|
"output": {
|
|
"shape_name": "UpdateDomainNameserversResponse",
|
|
"type": "structure",
|
|
"members": {
|
|
"OperationId": {
|
|
"shape_name": "OperationId",
|
|
"type": "string",
|
|
"max_length": 255,
|
|
"documentation": "\n<p>Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.</p>\n <p>Type: String</p>\n <p>Default: None</p>\n <p>Constraints: Maximum 255 characters.</p>\n",
|
|
"required": true
|
|
}
|
|
},
|
|
"documentation": "\n<p>The UpdateDomainNameservers response includes the following element.</p>\n"
|
|
},
|
|
"errors": [
|
|
{
|
|
"shape_name": "InvalidInput",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>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.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "DuplicateRequest",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The request is already in progress for the domain.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "TLDRulesViolation",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The top-level domain does not support this operation.</p>\n"
|
|
},
|
|
{
|
|
"shape_name": "OperationLimitExceeded",
|
|
"type": "structure",
|
|
"members": {
|
|
"message": {
|
|
"shape_name": "ErrorMessage",
|
|
"type": "string",
|
|
"documentation": null
|
|
}
|
|
},
|
|
"documentation": "\n <p>The number of operations or jobs running exceeded the allowed threshold for the account.</p>\n"
|
|
}
|
|
],
|
|
"documentation": "\n<p>This operation replaces the current set of name servers for the domain with the specified set of name servers.\nIf you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone\nfor the domain. </p>\n<p>If successful, this operation returns an operation ID that you can use to track the progress and completion of the action.\nIf the request is not completed successfully, the domain registrant will be notified by email.</p>\n<examples>\n<example>\n<name>UpdateDomainNameservers Example</name>\n<request>POST / HTTP/1.1\nhost:route53domains.us-east-1.amazonaws.com\nx-amz-date:20140711T205230Z\nauthorization:AWS4-HMAC-SHA256\n Credential=AKIAIOSFODNN7EXAMPLE/20140711/us-east-1/route53domains/aws4_request,\n SignedHeaders=content-length;content-type;host;user-agent;x-amz-date;x-amz-target,\n Signature=[calculated-signature]\nx-amz-target:Route53Domains_v20140515.UpdateDomainNameservers\nuser-agent:aws-sdk-java/1.8.3 Linux/2.6.18-164.el5PAE Java_HotSpot (TM )_Server_VM/24.60-b09/1.7.0_60\ncontent-type:application/x-amz-json-1.1\ncontent-length:[number of characters in the JSON string]\n{\n \"DomainName\":\"example.com\",\n \"Nameservers\":[\n {\n \"Name\":\"ns1.example.net\"\n },\n {\n \"Name\":\"ns1.example.com\",\n \"GlueIps\":[\n \"192.0.2.44\"\n ]\n }\n ]\n}</request>\n<response>HTTP/1.1 200\nContent-Length:[number of characters in the JSON string]\n{\n \"OperationId\":\"0b370c79-faa4-40fe-94c8-b423069de3f6\"\n}</response>\n</example>\n</examples>\n\n"
|
|
}
|
|
},
|
|
"retry": {
|
|
"__default__": {
|
|
"max_attempts": 5,
|
|
"delay": {
|
|
"type": "exponential",
|
|
"base": "rand",
|
|
"growth_factor": 2
|
|
},
|
|
"policies": {
|
|
"general_socket_errors": {
|
|
"applies_when": {
|
|
"socket_errors": [
|
|
"GENERAL_CONNECTION_ERROR"
|
|
]
|
|
}
|
|
},
|
|
"general_server_error": {
|
|
"applies_when": {
|
|
"response": {
|
|
"http_status_code": 500
|
|
}
|
|
}
|
|
},
|
|
"service_unavailable": {
|
|
"applies_when": {
|
|
"response": {
|
|
"http_status_code": 503
|
|
}
|
|
}
|
|
},
|
|
"limit_exceeded": {
|
|
"applies_when": {
|
|
"response": {
|
|
"http_status_code": 509
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} |