NOTE: For Version 3 of the AWS SDK for PHP, please see the V3 User Guide and V3 API Reference.

# Class Route53DomainsClient

Client to interact with Amazon Route 53 Domains

  Guzzle\Common\AbstractHasDispatcher implements Guzzle\Common\HasDispatcherInterface
  Guzzle\Http\Client implements Guzzle\Http\ClientInterface
  Guzzle\Service\Client implements Guzzle\Service\ClientInterface
  Aws\Common\Client\AbstractClient implements Aws\Common\Client\AwsClientInterface
  Aws\Route53Domains\Route53DomainsClient

Namespace: Aws\Route53Domains
Link: User guide
Link: API docs
Located at Aws/Route53Domains/Route53DomainsClient.php

## Methods summary

- `public static` `factory ( array|Collection $config = array() )`

  Basic factory method to create a new client. Extend this method in subclasses to build more complex clients.

- `public` `checkDomainAvailability ( array $args = array() )`

  Executes the CheckDomainAvailability operation.

- `public` `disableDomainAutoRenew ( array $args = array() )`

  Executes the DisableDomainAutoRenew operation.

- `public` `disableDomainTransferLock ( array $args = array() )`

  Executes the DisableDomainTransferLock operation.

- `public` `enableDomainAutoRenew ( array $args = array() )`

  Executes the EnableDomainAutoRenew operation.

- `public` `enableDomainTransferLock ( array $args = array() )`

  Executes the EnableDomainTransferLock operation.

- `public` `getDomainDetail ( array $args = array() )`

  Executes the GetDomainDetail operation.

- `public` `getOperationDetail ( array $args = array() )`

  Executes the GetOperationDetail operation.

- `public` `listDomains ( array $args = array() )`

  Executes the ListDomains operation.

- `public` `listOperations ( array $args = array() )`

  Executes the ListOperations operation.

- `public` `registerDomain ( array $args = array() )`

  Executes the RegisterDomain operation.

- `public` `retrieveDomainAuthCode ( array $args = array() )`

  Executes the RetrieveDomainAuthCode operation.

- `public` `transferDomain ( array $args = array() )`

  Executes the TransferDomain operation.

- `public` `updateDomainContact ( array $args = array() )`

  Executes the UpdateDomainContact operation.

- `public` `updateDomainContactPrivacy ( array $args = array() )`

  Executes the UpdateDomainContactPrivacy operation.

- `public` `updateDomainNameservers ( array $args = array() )`

  Executes the UpdateDomainNameservers operation.

## Methods detail

# `public static Client`
`factory( array|Collection $config = array() )`

Basic factory method to create a new client. Extend this method in subclasses to build more complex clients.

#### Parameters

$config
  `array|Collection`
  $config Configuration data

#### Returns

`Client`

#### Overrides

`Guzzle\Service\Client::factory`
# `public `Guzzle\Service\Resource\Model``
`checkDomainAvailability( array $args = array() )`

Executes the CheckDomainAvailability operation.

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.

#### Examples

- Basic formatting example

      $result = $client->checkDomainAvailability(array(
          // DomainName is required
          'DomainName' => 'string',
          'IdnLangCode' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)

    The name of a domain.

    Type: String

    Default: None

    Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

    Required: Yes

  - IdnLangCode => (string)

    Reserved for future use.

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Availability => (string)

  Whether the domain name is available for registering.

  You can only register domains designated as AVAILABLE.

  Type: String

  Valid values:

  - AVAILABLE – The domain name is available.
  - AVAILABLE_RESERVED – The domain name is reserved under specific conditions.
  - AVAILABLE_PREORDER – The domain name is available and can be preordered.
  - UNAVAILABLE – The domain name is not available.
  - UNAVAILABLE_PREMIUM – The domain name is not available.
  - UNAVAILABLE_RESTRICTED – The domain name is forbidden.
  - RESERVED – The domain name has been reserved for another person or organization.
  - DONT_KNOW – The TLD registry didn't reply with a definitive answer about whether the domain name is available. Amazon Route 53 can return this response for a variety of reasons, for example, the registry is performing maintenance. Try again later.

# `public `Guzzle\Service\Resource\Model``
`disableDomainAutoRenew( array $args = array() )`

Executes the DisableDomainAutoRenew operation.

This operation disables automatic renewal of domain registration for the specified domain.

Caution! Amazon Route 53 doesn't have a manual renewal process, so if you disable automatic renewal, registration for the domain will not be renewed when the expiration date passes, and you will lose control of the domain name.

#### Examples

- Basic formatting example

      $result = $client->disableDomainAutoRenew(array(
          // DomainName is required
          'DomainName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`disableDomainTransferLock( array $args = array() )`

Executes the DisableDomainTransferLock operation.

This operation removes the transfer lock on the domain (specifically the clientTransferProhibited status) to allow domain transfers. We recommend you refrain from performing this action unless you intend to transfer the domain to a different registrar. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

#### Examples

- Basic formatting example

      $result = $client->disableDomainTransferLock(array(
          // DomainName is required
          'DomainName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)

    The name of a domain.

    Type: String

    Default: None

    Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

    Required: Yes

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- OperationId => (string)

  Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

  Type: String

  Default: None

  Constraints: Maximum 255 characters.

# `public `Guzzle\Service\Resource\Model``
`enableDomainAutoRenew( array $args = array() )`

Executes the EnableDomainAutoRenew operation.

This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. The cost of renewing your domain registration is billed to your AWS account.

The period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see "Renewal, restoration, and deletion times" on the website for our registrar partner, Gandi. Route 53 requires that you renew before the end of the renewal period that is listed on the Gandi website so we can complete processing before the deadline.

#### Examples

- Basic formatting example

      $result = $client->enableDomainAutoRenew(array(
          // DomainName is required
          'DomainName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

# `public `Guzzle\Service\Resource\Model``
`enableDomainTransferLock( array $args = array() )`

Executes the EnableDomainTransferLock operation.

This operation sets the transfer lock on the domain (specifically the clientTransferProhibited status) to prevent domain transfers. Successful submission returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

#### Examples

- Basic formatting example

      $result = $client->enableDomainTransferLock(array(
          // DomainName is required
          'DomainName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)

    The name of a domain.

    Type: String

    Default: None

    Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

    Required: Yes

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- OperationId => (string)

  Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

  Type: String

  Default: None

  Constraints: Maximum 255 characters.

# `public `Guzzle\Service\Resource\Model``
`getDomainDetail( array $args = array() )`

Executes the GetDomainDetail operation.

This operation returns detailed information about the domain. The domain's contact information is also returned as part of the output.

#### Examples

- Basic formatting example

      $result = $client->getDomainDetail(array(
          // DomainName is required
          'DomainName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)

    The name of a domain.

    Type: String

    Default: None

    Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

    Required: Yes

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- DomainName => (string)

  The name of a domain.

  Type: String

- Nameservers => (array<associative-array>)

  The name of the domain.

  Type: String

  - (associative-array)

    Nameserver includes the following elements.

    - Name => (string)

      The fully qualified host name of the name server.

      Type: String

      Constraint: Maximum 255 characterss

      Parent: Nameservers

    - GlueIps => (array<string>)

      Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.

      Type: List of IP addresses.

      Constraints: The list can contain only one IPv4 and one IPv6 address.

      Parent: Nameservers

- AutoRenew => (bool)

  Specifies whether the domain registration is set to renew automatically.

  Type: Boolean

- AdminContact => (associative-array)

  Provides details about the domain administrative contact.

  Type: Complex

  Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

  - FirstName => (string)

    First name of contact.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - LastName => (string)

    Last name of contact.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - ContactType => (string)

    Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - OrganizationName => (string)

    Name of the organization for contact types other than PERSON.

    Type: String

    Default: None

    Constraints: Maximum 255 characters. Contact type must not be PERSON.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: No

  - AddressLine1 => (string)

    First line of the contact's address.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - AddressLine2 => (string)

    Second line of contact's address, if any.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: No

  - City => (string)

    The city of the contact's address.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - State => (string)

    The state or province of the contact's city.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: No

  - CountryCode => (string)

    Code for the country of the contact's address.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - ZipCode => (string)

    The zip or postal code of the contact's address.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: No

  - PhoneNumber => (string)

    The phone number of the contact.

    Type: String

    Default: None

    Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as "+1.1234567890".

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - Email => (string)

    Email address of the contact.

    Type: String

    Default: None

    Constraints: Maximum 254 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - Fax => (string)

    Fax number of the contact.

    Type: String

    Default: None

    Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890".

    Parents: RegistrantContact, AdminContact, TechContact

    Required: No

  - ExtraParams => (array<associative-array>)

    A list of name-value pairs for parameters required by certain top-level domains.

    Type: Complex

    Default: None

    Parents: RegistrantContact, AdminContact, TechContact

    Children: Name, Value

    Required: No

    - (associative-array)

      ExtraParam includes the following elements.

      - Name => (string)

        Name of the additional parameter required by the top-level domain.

        Type: String

        Default: None

        Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER

        Parent: ExtraParams

        Required: Yes

      - Value => (string)

        Values corresponding to the additional parameter names required by some top-level domains.

        Type: String

        Default: None

        Constraints: Maximum 2048 characters.

        Parent: ExtraParams

        Required: Yes

- RegistrantContact => (associative-array)

  Provides details about the domain registrant.

  Type: Complex

  Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

  - FirstName => (string)

    First name of contact.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - LastName => (string)

    Last name of contact.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - ContactType => (string)

    Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - OrganizationName => (string)

    Name of the organization for contact types other than PERSON.

    Type: String

    Default: None

    Constraints: Maximum 255 characters. Contact type must not be PERSON.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: No

  - AddressLine1 => (string)

    First line of the contact's address.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - AddressLine2 => (string)

    Second line of contact's address, if any.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: No

  - City => (string)

    The city of the contact's address.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - State => (string)

    The state or province of the contact's city.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: No

  - CountryCode => (string)

    Code for the country of the contact's address.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - ZipCode => (string)

    The zip or postal code of the contact's address.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: No

  - PhoneNumber => (string)

    The phone number of the contact.

    Type: String

    Default: None

    Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as "+1.1234567890".

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - Email => (string)

    Email address of the contact.

    Type: String

    Default: None

    Constraints: Maximum 254 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - Fax => (string)

    Fax number of the contact.

    Type: String

    Default: None

    Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890".

    Parents: RegistrantContact, AdminContact, TechContact

    Required: No

  - ExtraParams => (array<associative-array>)

    A list of name-value pairs for parameters required by certain top-level domains.

    Type: Complex

    Default: None

    Parents: RegistrantContact, AdminContact, TechContact

    Children: Name, Value

    Required: No

    - (associative-array)

      ExtraParam includes the following elements.

      - Name => (string)

        Name of the additional parameter required by the top-level domain.

        Type: String

        Default: None

        Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER

        Parent: ExtraParams

        Required: Yes

      - Value => (string)

        Values corresponding to the additional parameter names required by some top-level domains.

        Type: String

        Default: None

        Constraints: Maximum 2048 characters.

        Parent: ExtraParams

        Required: Yes

- TechContact => (associative-array)

  Provides details about the domain technical contact.

  Type: Complex

  Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

  - FirstName => (string)

    First name of contact.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - LastName => (string)

    Last name of contact.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - ContactType => (string)

    Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - OrganizationName => (string)

    Name of the organization for contact types other than PERSON.

    Type: String

    Default: None

    Constraints: Maximum 255 characters. Contact type must not be PERSON.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: No

  - AddressLine1 => (string)

    First line of the contact's address.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - AddressLine2 => (string)

    Second line of contact's address, if any.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: No

  - City => (string)

    The city of the contact's address.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - State => (string)

    The state or province of the contact's city.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: No

  - CountryCode => (string)

    Code for the country of the contact's address.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - ZipCode => (string)

    The zip or postal code of the contact's address.

    Type: String

    Default: None

    Constraints: Maximum 255 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: No

  - PhoneNumber => (string)

    The phone number of the contact.

    Type: String

    Default: None

    Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as "+1.1234567890".

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - Email => (string)

    Email address of the contact.

    Type: String

    Default: None

    Constraints: Maximum 254 characters.

    Parents: RegistrantContact, AdminContact, TechContact

    Required: Yes

  - Fax => (string)

    Fax number of the contact.

    Type: String

    Default: None

    Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890".

    Parents: RegistrantContact, AdminContact, TechContact

    Required: No

  - ExtraParams => (array<associative-array>)

    A list of name-value pairs for parameters required by certain top-level domains.

    Type: Complex

    Default: None

    Parents: RegistrantContact, AdminContact, TechContact

    Children: Name, Value

    Required: No

    - (associative-array)

      ExtraParam includes the following elements.

      - Name => (string)

        Name of the additional parameter required by the top-level domain.

        Type: String

        Default: None

        Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER

        Parent: ExtraParams

        Required: Yes

      - Value => (string)

        Values corresponding to the additional parameter names required by some top-level domains.

        Type: String

        Default: None

        Constraints: Maximum 2048 characters.

        Parent: ExtraParams

        Required: Yes

- AdminPrivacy => (bool)

  Specifies whether contact information for the admin contact is concealed from WHOIS queries. If the value is true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

  Type: Boolean

- RegistrantPrivacy => (bool)

  Specifies whether contact information for the registrant contact is concealed from WHOIS queries. If the value is true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

  Type: Boolean

- TechPrivacy => (bool)

  Specifies whether contact information for the tech contact is concealed from WHOIS queries. If the value is true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

  Type: Boolean

- RegistrarName => (string)

  Name of the registrar of the domain as identified in the registry. Amazon Route 53 domains are registered by registrar Gandi. The value is "GANDI SAS".

  Type: String

- WhoIsServer => (string)

  The fully qualified name of the WHOIS server that can answer the WHOIS query for the domain.

  Type: String

- RegistrarUrl => (string)

  Web address of the registrar.

  Type: String

- AbuseContactEmail => (string)

  Email address to contact to report incorrect contact information for a domain, to report that the domain is being used to send spam, to report that someone is cybersquatting on a domain name, or report some other type of abuse.

  Type: String

- AbuseContactPhone => (string)

  Phone number for reporting abuse.

  Type: String

- RegistryDomainId => (string)

  Reserved for future use.

- CreationDate => (string)

  The date when the domain was created as found in the response to a WHOIS query. The date format is Unix time.

- UpdatedDate => (string)

  The last updated date of the domain as found in the response to a WHOIS query. The date format is Unix time.

- ExpirationDate => (string)

  The date when the registration for the domain is set to expire. The date format is Unix time.

- Reseller => (string)

  Reseller of the domain. Domains registered or transferred using Amazon Route 53 domains will have "Amazon" as the reseller.

  Type: String

- DnsSec => (string)

  Reserved for future use.

- StatusList => (array<string>)

  An array of domain name status codes, also known as Extensible Provisioning Protocol (EPP) status codes.

  ICANN, the organization that maintains a central database of domain names, has developed a set of domain name status codes that tell you the status of a variety of operations on a domain name, for example, registering a domain name, transferring a domain name to another registrar, renewing the registration for a domain name, and so on. All registrars use this same set of status codes.

  For a current list of domain name status codes and an explanation of what each code means, go to the ICANN website and search for epp status codes. (Search on the ICANN website; web searches sometimes return an old version of the document.)

  Type: Array of String

# `public `Guzzle\Service\Resource\Model``
`getOperationDetail( array $args = array() )`

Executes the GetOperationDetail operation.

This operation returns the current status of an operation that is not completed.

#### Examples

- Basic formatting example

      $result = $client->getOperationDetail(array(
          // OperationId is required
          'OperationId' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - OperationId => (string)

    The identifier for the operation for which you want to get the status. Amazon Route 53 returned the identifier in the response to the original request.

    Type: String

    Default: None

    Required: Yes

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- OperationId => (string)

  The identifier for the operation.

  Type: String

- Status => (string)

  The current status of the requested operation in the system.

  Type: String

- Message => (string)

  Detailed information on the status including possible errors.

  Type: String

- DomainName => (string)

  The name of a domain.

  Type: String

- Type => (string)

  The type of operation that was requested.

  Type: String

- SubmittedDate => (string)

  The date when the request was submitted.

# `public `Guzzle\Service\Resource\Model``
`listDomains( array $args = array() )`

Executes the ListDomains operation.

This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.

#### Examples

- Basic formatting example

      $result = $client->listDomains(array(
          'Marker' => 'string',
          'MaxItems' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Marker => (string)

    For an initial request for a list of domains, omit this element. If the number of domains that are associated with the current AWS account is greater than the value that you specified for MaxItems, you can use Marker to return additional domains. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

    Type: String

    Default: None

    Constraints: The marker must match the value specified in the previous request.

    Required: No

  - MaxItems => (int)

    Number of domains to be returned.

    Type: Integer

    Default: 20

    Constraints: A numeral between 1 and 100.

    Required: No

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Domains => (array<associative-array>)

  A summary of domains.

  Type: Complex type containing a list of domain summaries.

  Children: AutoRenew, DomainName, Expiry, TransferLock

  - (associative-array)
    - DomainName => (string)

      The name of a domain.

      Type: String

    - AutoRenew => (bool)

      Indicates whether the domain is automatically renewed upon expiration.

      Type: Boolean

      Valid values: True | False

    - TransferLock => (bool)

      Indicates whether a domain is locked from unauthorized transfer to another party.

      Type: Boolean

      Valid values: True | False

    - Expiry => (string)

      Expiration date of the domain in Coordinated Universal Time (UTC).

      Type: Long

- NextPageMarker => (string)

  If there are more domains than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

  Type: String

  Parent: Operations

# `public `Guzzle\Service\Resource\Model``
`listOperations( array $args = array() )`

Executes the ListOperations operation.

This operation returns the operation IDs of operations that are not yet complete.

#### Examples

- Basic formatting example

      $result = $client->listOperations(array(
          'Marker' => 'string',
          'MaxItems' => integer,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - Marker => (string)

    For an initial request for a list of operations, omit this element. If the number of operations that are not yet complete is greater than the value that you specified for MaxItems, you can use Marker to return additional operations. Get the value of NextPageMarker from the previous response, and submit another request that includes the value of NextPageMarker in the Marker element.

    Type: String

    Default: None

    Required: No

  - MaxItems => (int)

    Number of domains to be returned.

    Type: Integer

    Default: 20

    Constraints: A value between 1 and 100.

    Required: No

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- Operations => (array<associative-array>)

  Lists summaries of the operations.

  Type: Complex type containing a list of operation summaries

  Children: OperationId, Status, SubmittedDate, Type

  - (associative-array)

    OperationSummary includes the following elements.

    - OperationId => (string)

      Identifier returned to track the requested action.

      Type: String

    - Status => (string)

      The current status of the requested operation in the system.

      Type: String

    - Type => (string)

      Type of the action requested.

      Type: String

      Valid values: REGISTER_DOMAIN | DELETE_DOMAIN | TRANSFER_IN_DOMAIN | UPDATE_DOMAIN_CONTACT | UPDATE_NAMESERVER | CHANGE_PRIVACY_PROTECTION | DOMAIN_LOCK

    - SubmittedDate => (string)

      The date when the request was submitted.

- NextPageMarker => (string)

  If there are more operations than you specified for MaxItems in the request, submit another request and include the value of NextPageMarker in the value of Marker.

  Type: String

  Parent: Operations

# `public `Guzzle\Service\Resource\Model``
`registerDomain( array $args = array() )`

Executes the RegisterDomain operation.

This operation registers a domain. Domains are registered by the AWS registrar partner, Gandi. For some top-level domains (TLDs), this operation requires extra parameters.

When you register a domain, Amazon Route 53 does the following:

- Creates a Amazon Route 53 hosted zone that has the same name as the domain. Amazon Route 53 assigns four name servers to your hosted zone and automatically updates your domain registration with the names of these name servers.
- Enables autorenew, so your domain registration will renew automatically each year. We'll notify you in advance of the renewal date so you can choose whether to renew the registration.
- Optionally enables privacy protection, so WHOIS queries return contact information for our registrar partner, Gandi, instead of the information you entered for registrant, admin, and tech contacts.
- If registration is successful, returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant is notified by email.
- Charges your AWS account an amount based on the top-level domain. For more information, see Amazon Route 53 Pricing.

#### Examples

- Basic formatting example

      $result = $client->registerDomain(array(
          // DomainName is required
          'DomainName' => 'string',
          'IdnLangCode' => 'string',
          // DurationInYears is required
          'DurationInYears' => integer,
          'AutoRenew' => true || false,
          // AdminContact is required
          'AdminContact' => array(
              'FirstName' => 'string',
              'LastName' => 'string',
              'ContactType' => 'string',
              'OrganizationName' => 'string',
              'AddressLine1' => 'string',
              'AddressLine2' => 'string',
              'City' => 'string',
              'State' => 'string',
              'CountryCode' => 'string',
              'ZipCode' => 'string',
              'PhoneNumber' => 'string',
              'Email' => 'string',
              'Fax' => 'string',
              'ExtraParams' => array(
                  array(
                      // Name is required
                      'Name' => 'string',
                      // Value is required
                      'Value' => 'string',
                  ),
                  // ... repeated
              ),
          ),
          // RegistrantContact is required
          'RegistrantContact' => array(
              'FirstName' => 'string',
              'LastName' => 'string',
              'ContactType' => 'string',
              'OrganizationName' => 'string',
              'AddressLine1' => 'string',
              'AddressLine2' => 'string',
              'City' => 'string',
              'State' => 'string',
              'CountryCode' => 'string',
              'ZipCode' => 'string',
              'PhoneNumber' => 'string',
              'Email' => 'string',
              'Fax' => 'string',
              'ExtraParams' => array(
                  array(
                      // Name is required
                      'Name' => 'string',
                      // Value is required
                      'Value' => 'string',
                  ),
                  // ... repeated
              ),
          ),
          // TechContact is required
          'TechContact' => array(
              'FirstName' => 'string',
              'LastName' => 'string',
              'ContactType' => 'string',
              'OrganizationName' => 'string',
              'AddressLine1' => 'string',
              'AddressLine2' => 'string',
              'City' => 'string',
              'State' => 'string',
              'CountryCode' => 'string',
              'ZipCode' => 'string',
              'PhoneNumber' => 'string',
              'Email' => 'string',
              'Fax' => 'string',
              'ExtraParams' => array(
                  array(
                      // Name is required
                      'Name' => 'string',
                      // Value is required
                      'Value' => 'string',
                  ),
                  // ... repeated
              ),
          ),
          'PrivacyProtectAdminContact' => true || false,
          'PrivacyProtectRegistrantContact' => true || false,
          'PrivacyProtectTechContact' => true || false,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)

    The name of a domain.

    Type: String

    Default: None

    Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

    Required: Yes

  - IdnLangCode => (string)

    Reserved for future use.

  - DurationInYears => (int)

    The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.

    Type: Integer

    Default: 1

    Valid values: Integer from 1 to 10

    Required: Yes

  - AutoRenew => (bool)

    Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.

    Type: Boolean

    Valid values: true | false

    Default: true

    Required: No

  - AdminContact => (associative-array)

    Provides detailed contact information.

    Type: Complex

    Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

    Required: Yes

    - FirstName => (string)

      First name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - LastName => (string)

      Last name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ContactType => (string: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY | RESELLER )

      Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - OrganizationName => (string)

      Name of the organization for contact types other than PERSON.

      Type: String

      Default: None

      Constraints: Maximum 255 characters. Contact type must not be PERSON.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - AddressLine1 => (string)

      First line of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - AddressLine2 => (string)

      Second line of contact's address, if any.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - City => (string)

      The city of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - State => (string)

      The state or province of the contact's city.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - CountryCode => (string: 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 )

      Code for the country of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ZipCode => (string)

      The zip or postal code of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - PhoneNumber => (string)

      The phone number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Email => (string)

      Email address of the contact.

      Type: String

      Default: None

      Constraints: Maximum 254 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Fax => (string)

      Fax number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - ExtraParams => (array<associative-array>)

      A list of name-value pairs for parameters required by certain top-level domains.

      Type: Complex

      Default: None

      Parents: RegistrantContact, AdminContact, TechContact

      Children: Name, Value

      Required: No

      - (associative-array)

        ExtraParam includes the following elements.

        - Name => (string: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER )

          Name of the additional parameter required by the top-level domain.

          Type: String

          Default: None

          Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER

          Parent: ExtraParams

          Required: Yes

        - Value => (string)

          Values corresponding to the additional parameter names required by some top-level domains.

          Type: String

          Default: None

          Constraints: Maximum 2048 characters.

          Parent: ExtraParams

          Required: Yes

  - RegistrantContact => (associative-array)

    Provides detailed contact information.

    Type: Complex

    Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

    Required: Yes

    - FirstName => (string)

      First name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - LastName => (string)

      Last name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ContactType => (string: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY | RESELLER )

      Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - OrganizationName => (string)

      Name of the organization for contact types other than PERSON.

      Type: String

      Default: None

      Constraints: Maximum 255 characters. Contact type must not be PERSON.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - AddressLine1 => (string)

      First line of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - AddressLine2 => (string)

      Second line of contact's address, if any.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - City => (string)

      The city of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - State => (string)

      The state or province of the contact's city.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - CountryCode => (string: 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 )

      Code for the country of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ZipCode => (string)

      The zip or postal code of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - PhoneNumber => (string)

      The phone number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Email => (string)

      Email address of the contact.

      Type: String

      Default: None

      Constraints: Maximum 254 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Fax => (string)

      Fax number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - ExtraParams => (array<associative-array>)

      A list of name-value pairs for parameters required by certain top-level domains.

      Type: Complex

      Default: None

      Parents: RegistrantContact, AdminContact, TechContact

      Children: Name, Value

      Required: No

      - (associative-array)

        ExtraParam includes the following elements.

        - Name => (string: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER )

          Name of the additional parameter required by the top-level domain.

          Type: String

          Default: None

          Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER

          Parent: ExtraParams

          Required: Yes

        - Value => (string)

          Values corresponding to the additional parameter names required by some top-level domains.

          Type: String

          Default: None

          Constraints: Maximum 2048 characters.

          Parent: ExtraParams

          Required: Yes

  - TechContact => (associative-array)

    Provides detailed contact information.

    Type: Complex

    Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

    Required: Yes

    - FirstName => (string)

      First name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - LastName => (string)

      Last name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ContactType => (string: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY | RESELLER )

      Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - OrganizationName => (string)

      Name of the organization for contact types other than PERSON.

      Type: String

      Default: None

      Constraints: Maximum 255 characters. Contact type must not be PERSON.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - AddressLine1 => (string)

      First line of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - AddressLine2 => (string)

      Second line of contact's address, if any.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - City => (string)

      The city of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - State => (string)

      The state or province of the contact's city.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - CountryCode => (string: 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 )

      Code for the country of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ZipCode => (string)

      The zip or postal code of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - PhoneNumber => (string)

      The phone number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Email => (string)

      Email address of the contact.

      Type: String

      Default: None

      Constraints: Maximum 254 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Fax => (string)

      Fax number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - ExtraParams => (array<associative-array>)

      A list of name-value pairs for parameters required by certain top-level domains.

      Type: Complex

      Default: None

      Parents: RegistrantContact, AdminContact, TechContact

      Children: Name, Value

      Required: No

      - (associative-array)

        ExtraParam includes the following elements.

        - Name => (string: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER )

          Name of the additional parameter required by the top-level domain.

          Type: String

          Default: None

          Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER

          Parent: ExtraParams

          Required: Yes

        - Value => (string)

          Values corresponding to the additional parameter names required by some top-level domains.

          Type: String

          Default: None

          Constraints: Maximum 2048 characters.

          Parent: ExtraParams

          Required: Yes

  - PrivacyProtectAdminContact => (bool)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

    Type: Boolean

    Default: true

    Valid values: true | false

    Required: No

  - PrivacyProtectRegistrantContact => (bool)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

    Type: Boolean

    Default: true

    Valid values: true | false

    Required: No

  - PrivacyProtectTechContact => (bool)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

    Type: Boolean

    Default: true

    Valid values: true | false

    Required: No

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- OperationId => (string)

  Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

  Type: String

  Default: None

  Constraints: Maximum 255 characters.

# `public `Guzzle\Service\Resource\Model``
`retrieveDomainAuthCode( array $args = array() )`

Executes the RetrieveDomainAuthCode operation.

This operation returns the AuthCode for the domain. To transfer a domain to another registrar, you provide this value to the new registrar.

#### Examples

- Basic formatting example

      $result = $client->retrieveDomainAuthCode(array(
          // DomainName is required
          'DomainName' => 'string',
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)

    The name of a domain.

    Type: String

    Default: None

    Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

    Required: Yes

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- AuthCode => (string)

  The authorization code for the domain.

  Type: String

# `public `Guzzle\Service\Resource\Model``
`transferDomain( array $args = array() )`

Executes the TransferDomain operation.

This operation transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered with the AWS registrar partner, Gandi.

For transfer requirements, a detailed procedure, and information about viewing the status of a domain transfer, see Transferring Registration for a Domain to Amazon Route 53 in the Amazon Route 53 Developer Guide.

If the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you consider transferring your DNS service to Amazon Route 53 or to another DNS service provider before you transfer your registration. Some registrars provide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar will not renew your domain registration and could end your DNS service at any time.

Caution! If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable.

If the transfer is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.

#### Examples

- Basic formatting example

      $result = $client->transferDomain(array(
          // DomainName is required
          'DomainName' => 'string',
          'IdnLangCode' => 'string',
          // DurationInYears is required
          'DurationInYears' => integer,
          'Nameservers' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  'GlueIps' => array('string', ... ),
              ),
              // ... repeated
          ),
          'AuthCode' => 'string',
          'AutoRenew' => true || false,
          // AdminContact is required
          'AdminContact' => array(
              'FirstName' => 'string',
              'LastName' => 'string',
              'ContactType' => 'string',
              'OrganizationName' => 'string',
              'AddressLine1' => 'string',
              'AddressLine2' => 'string',
              'City' => 'string',
              'State' => 'string',
              'CountryCode' => 'string',
              'ZipCode' => 'string',
              'PhoneNumber' => 'string',
              'Email' => 'string',
              'Fax' => 'string',
              'ExtraParams' => array(
                  array(
                      // Name is required
                      'Name' => 'string',
                      // Value is required
                      'Value' => 'string',
                  ),
                  // ... repeated
              ),
          ),
          // RegistrantContact is required
          'RegistrantContact' => array(
              'FirstName' => 'string',
              'LastName' => 'string',
              'ContactType' => 'string',
              'OrganizationName' => 'string',
              'AddressLine1' => 'string',
              'AddressLine2' => 'string',
              'City' => 'string',
              'State' => 'string',
              'CountryCode' => 'string',
              'ZipCode' => 'string',
              'PhoneNumber' => 'string',
              'Email' => 'string',
              'Fax' => 'string',
              'ExtraParams' => array(
                  array(
                      // Name is required
                      'Name' => 'string',
                      // Value is required
                      'Value' => 'string',
                  ),
                  // ... repeated
              ),
          ),
          // TechContact is required
          'TechContact' => array(
              'FirstName' => 'string',
              'LastName' => 'string',
              'ContactType' => 'string',
              'OrganizationName' => 'string',
              'AddressLine1' => 'string',
              'AddressLine2' => 'string',
              'City' => 'string',
              'State' => 'string',
              'CountryCode' => 'string',
              'ZipCode' => 'string',
              'PhoneNumber' => 'string',
              'Email' => 'string',
              'Fax' => 'string',
              'ExtraParams' => array(
                  array(
                      // Name is required
                      'Name' => 'string',
                      // Value is required
                      'Value' => 'string',
                  ),
                  // ... repeated
              ),
          ),
          'PrivacyProtectAdminContact' => true || false,
          'PrivacyProtectRegistrantContact' => true || false,
          'PrivacyProtectTechContact' => true || false,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)

    The name of a domain.

    Type: String

    Default: None

    Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

    Required: Yes

  - IdnLangCode => (string)

    Reserved for future use.

  - DurationInYears => (int)

    The number of years the domain will be registered. Domains are registered for a minimum of one year. The maximum period depends on the top-level domain.

    Type: Integer

    Default: 1

    Valid values: Integer from 1 to 10

    Required: Yes

  - Nameservers => (array<associative-array>)

    Contains details for the host and glue IP addresses.

    Type: Complex

    Children: GlueIps, Name

    Required: No

    - (associative-array)

      Nameserver includes the following elements.

      - Name => (string)

        The fully qualified host name of the name server.

        Type: String

        Constraint: Maximum 255 characterss

        Parent: Nameservers

      - GlueIps => (array<string>)

        Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.

        Type: List of IP addresses.

        Constraints: The list can contain only one IPv4 and one IPv6 address.

        Parent: Nameservers

  - AuthCode => (string)

    The authorization code for the domain. You get this value from the current registrar.

    Type: String

    Required: Yes

  - AutoRenew => (bool)

    Indicates whether the domain will be automatically renewed (true) or not (false). Autorenewal only takes effect after the account is charged.

    Type: Boolean

    Valid values: true | false

    Default: true

    Required: No

  - AdminContact => (associative-array)

    Provides detailed contact information.

    Type: Complex

    Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

    Required: Yes

    - FirstName => (string)

      First name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - LastName => (string)

      Last name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ContactType => (string: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY | RESELLER )

      Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - OrganizationName => (string)

      Name of the organization for contact types other than PERSON.

      Type: String

      Default: None

      Constraints: Maximum 255 characters. Contact type must not be PERSON.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - AddressLine1 => (string)

      First line of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - AddressLine2 => (string)

      Second line of contact's address, if any.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - City => (string)

      The city of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - State => (string)

      The state or province of the contact's city.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - CountryCode => (string: 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 )

      Code for the country of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ZipCode => (string)

      The zip or postal code of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - PhoneNumber => (string)

      The phone number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Email => (string)

      Email address of the contact.

      Type: String

      Default: None

      Constraints: Maximum 254 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Fax => (string)

      Fax number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - ExtraParams => (array<associative-array>)

      A list of name-value pairs for parameters required by certain top-level domains.

      Type: Complex

      Default: None

      Parents: RegistrantContact, AdminContact, TechContact

      Children: Name, Value

      Required: No

      - (associative-array)

        ExtraParam includes the following elements.

        - Name => (string: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER )

          Name of the additional parameter required by the top-level domain.

          Type: String

          Default: None

          Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER

          Parent: ExtraParams

          Required: Yes

        - Value => (string)

          Values corresponding to the additional parameter names required by some top-level domains.

          Type: String

          Default: None

          Constraints: Maximum 2048 characters.

          Parent: ExtraParams

          Required: Yes

  - RegistrantContact => (associative-array)

    Provides detailed contact information.

    Type: Complex

    Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

    Required: Yes

    - FirstName => (string)

      First name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - LastName => (string)

      Last name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ContactType => (string: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY | RESELLER )

      Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - OrganizationName => (string)

      Name of the organization for contact types other than PERSON.

      Type: String

      Default: None

      Constraints: Maximum 255 characters. Contact type must not be PERSON.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - AddressLine1 => (string)

      First line of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - AddressLine2 => (string)

      Second line of contact's address, if any.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - City => (string)

      The city of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - State => (string)

      The state or province of the contact's city.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - CountryCode => (string: 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 )

      Code for the country of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ZipCode => (string)

      The zip or postal code of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - PhoneNumber => (string)

      The phone number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Email => (string)

      Email address of the contact.

      Type: String

      Default: None

      Constraints: Maximum 254 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Fax => (string)

      Fax number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - ExtraParams => (array<associative-array>)

      A list of name-value pairs for parameters required by certain top-level domains.

      Type: Complex

      Default: None

      Parents: RegistrantContact, AdminContact, TechContact

      Children: Name, Value

      Required: No

      - (associative-array)

        ExtraParam includes the following elements.

        - Name => (string: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER )

          Name of the additional parameter required by the top-level domain.

          Type: String

          Default: None

          Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER

          Parent: ExtraParams

          Required: Yes

        - Value => (string)

          Values corresponding to the additional parameter names required by some top-level domains.

          Type: String

          Default: None

          Constraints: Maximum 2048 characters.

          Parent: ExtraParams

          Required: Yes

  - TechContact => (associative-array)

    Provides detailed contact information.

    Type: Complex

    Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

    Required: Yes

    - FirstName => (string)

      First name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - LastName => (string)

      Last name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ContactType => (string: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY | RESELLER )

      Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - OrganizationName => (string)

      Name of the organization for contact types other than PERSON.

      Type: String

      Default: None

      Constraints: Maximum 255 characters. Contact type must not be PERSON.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - AddressLine1 => (string)

      First line of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - AddressLine2 => (string)

      Second line of contact's address, if any.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - City => (string)

      The city of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - State => (string)

      The state or province of the contact's city.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - CountryCode => (string: 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 )

      Code for the country of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ZipCode => (string)

      The zip or postal code of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - PhoneNumber => (string)

      The phone number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Email => (string)

      Email address of the contact.

      Type: String

      Default: None

      Constraints: Maximum 254 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Fax => (string)

      Fax number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - ExtraParams => (array<associative-array>)

      A list of name-value pairs for parameters required by certain top-level domains.

      Type: Complex

      Default: None

      Parents: RegistrantContact, AdminContact, TechContact

      Children: Name, Value

      Required: No

      - (associative-array)

        ExtraParam includes the following elements.

        - Name => (string: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER )

          Name of the additional parameter required by the top-level domain.

          Type: String

          Default: None

          Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER

          Parent: ExtraParams

          Required: Yes

        - Value => (string)

          Values corresponding to the additional parameter names required by some top-level domains.

          Type: String

          Default: None

          Constraints: Maximum 2048 characters.

          Parent: ExtraParams

          Required: Yes

  - PrivacyProtectAdminContact => (bool)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

    Type: Boolean

    Default: true

    Valid values: true | false

    Required: No

  - PrivacyProtectRegistrantContact => (bool)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

    Type: Boolean

    Default: true

    Valid values: true | false

    Required: No

  - PrivacyProtectTechContact => (bool)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

    Type: Boolean

    Default: true

    Valid values: true | false

    Required: No

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- OperationId => (string)

  Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

  Type: String

  Default: None

  Constraints: Maximum 255 characters.

# `public `Guzzle\Service\Resource\Model``
`updateDomainContact( array $args = array() )`

Executes the UpdateDomainContact operation.

This operation updates the contact information for a particular domain. Information for at least one contact (registrant, administrator, or technical) must be supplied for update.

If the update is successful, this method returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

#### Examples

- Basic formatting example

      $result = $client->updateDomainContact(array(
          // DomainName is required
          'DomainName' => 'string',
          'AdminContact' => array(
              'FirstName' => 'string',
              'LastName' => 'string',
              'ContactType' => 'string',
              'OrganizationName' => 'string',
              'AddressLine1' => 'string',
              'AddressLine2' => 'string',
              'City' => 'string',
              'State' => 'string',
              'CountryCode' => 'string',
              'ZipCode' => 'string',
              'PhoneNumber' => 'string',
              'Email' => 'string',
              'Fax' => 'string',
              'ExtraParams' => array(
                  array(
                      // Name is required
                      'Name' => 'string',
                      // Value is required
                      'Value' => 'string',
                  ),
                  // ... repeated
              ),
          ),
          'RegistrantContact' => array(
              'FirstName' => 'string',
              'LastName' => 'string',
              'ContactType' => 'string',
              'OrganizationName' => 'string',
              'AddressLine1' => 'string',
              'AddressLine2' => 'string',
              'City' => 'string',
              'State' => 'string',
              'CountryCode' => 'string',
              'ZipCode' => 'string',
              'PhoneNumber' => 'string',
              'Email' => 'string',
              'Fax' => 'string',
              'ExtraParams' => array(
                  array(
                      // Name is required
                      'Name' => 'string',
                      // Value is required
                      'Value' => 'string',
                  ),
                  // ... repeated
              ),
          ),
          'TechContact' => array(
              'FirstName' => 'string',
              'LastName' => 'string',
              'ContactType' => 'string',
              'OrganizationName' => 'string',
              'AddressLine1' => 'string',
              'AddressLine2' => 'string',
              'City' => 'string',
              'State' => 'string',
              'CountryCode' => 'string',
              'ZipCode' => 'string',
              'PhoneNumber' => 'string',
              'Email' => 'string',
              'Fax' => 'string',
              'ExtraParams' => array(
                  array(
                      // Name is required
                      'Name' => 'string',
                      // Value is required
                      'Value' => 'string',
                  ),
                  // ... repeated
              ),
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)

    The name of a domain.

    Type: String

    Default: None

    Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

    Required: Yes

  - AdminContact => (associative-array)

    Provides detailed contact information.

    Type: Complex

    Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

    Required: Yes

    - FirstName => (string)

      First name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - LastName => (string)

      Last name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ContactType => (string: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY | RESELLER )

      Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - OrganizationName => (string)

      Name of the organization for contact types other than PERSON.

      Type: String

      Default: None

      Constraints: Maximum 255 characters. Contact type must not be PERSON.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - AddressLine1 => (string)

      First line of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - AddressLine2 => (string)

      Second line of contact's address, if any.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - City => (string)

      The city of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - State => (string)

      The state or province of the contact's city.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - CountryCode => (string: 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 )

      Code for the country of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ZipCode => (string)

      The zip or postal code of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - PhoneNumber => (string)

      The phone number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Email => (string)

      Email address of the contact.

      Type: String

      Default: None

      Constraints: Maximum 254 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Fax => (string)

      Fax number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - ExtraParams => (array<associative-array>)

      A list of name-value pairs for parameters required by certain top-level domains.

      Type: Complex

      Default: None

      Parents: RegistrantContact, AdminContact, TechContact

      Children: Name, Value

      Required: No

      - (associative-array)

        ExtraParam includes the following elements.

        - Name => (string: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER )

          Name of the additional parameter required by the top-level domain.

          Type: String

          Default: None

          Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER

          Parent: ExtraParams

          Required: Yes

        - Value => (string)

          Values corresponding to the additional parameter names required by some top-level domains.

          Type: String

          Default: None

          Constraints: Maximum 2048 characters.

          Parent: ExtraParams

          Required: Yes

  - RegistrantContact => (associative-array)

    Provides detailed contact information.

    Type: Complex

    Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

    Required: Yes

    - FirstName => (string)

      First name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - LastName => (string)

      Last name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ContactType => (string: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY | RESELLER )

      Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - OrganizationName => (string)

      Name of the organization for contact types other than PERSON.

      Type: String

      Default: None

      Constraints: Maximum 255 characters. Contact type must not be PERSON.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - AddressLine1 => (string)

      First line of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - AddressLine2 => (string)

      Second line of contact's address, if any.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - City => (string)

      The city of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - State => (string)

      The state or province of the contact's city.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - CountryCode => (string: 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 )

      Code for the country of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ZipCode => (string)

      The zip or postal code of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - PhoneNumber => (string)

      The phone number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Email => (string)

      Email address of the contact.

      Type: String

      Default: None

      Constraints: Maximum 254 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Fax => (string)

      Fax number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - ExtraParams => (array<associative-array>)

      A list of name-value pairs for parameters required by certain top-level domains.

      Type: Complex

      Default: None

      Parents: RegistrantContact, AdminContact, TechContact

      Children: Name, Value

      Required: No

      - (associative-array)

        ExtraParam includes the following elements.

        - Name => (string: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER )

          Name of the additional parameter required by the top-level domain.

          Type: String

          Default: None

          Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER

          Parent: ExtraParams

          Required: Yes

        - Value => (string)

          Values corresponding to the additional parameter names required by some top-level domains.

          Type: String

          Default: None

          Constraints: Maximum 2048 characters.

          Parent: ExtraParams

          Required: Yes

  - TechContact => (associative-array)

    Provides detailed contact information.

    Type: Complex

    Children: FirstName, MiddleName, LastName, ContactType, OrganizationName, AddressLine1, AddressLine2, City, State, CountryCode, ZipCode, PhoneNumber, Email, Fax, ExtraParams

    Required: Yes

    - FirstName => (string)

      First name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - LastName => (string)

      Last name of contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ContactType => (string: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY | RESELLER )

      Indicates whether the contact is a person, company, association, or public organization. If you choose an option other than PERSON, you must enter an organization name, and you can't enable privacy protection for the contact.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Valid values: PERSON | COMPANY | ASSOCIATION | PUBLIC_BODY

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - OrganizationName => (string)

      Name of the organization for contact types other than PERSON.

      Type: String

      Default: None

      Constraints: Maximum 255 characters. Contact type must not be PERSON.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - AddressLine1 => (string)

      First line of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - AddressLine2 => (string)

      Second line of contact's address, if any.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - City => (string)

      The city of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - State => (string)

      The state or province of the contact's city.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - CountryCode => (string: 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 )

      Code for the country of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - ZipCode => (string)

      The zip or postal code of the contact's address.

      Type: String

      Default: None

      Constraints: Maximum 255 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - PhoneNumber => (string)

      The phone number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code>]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Email => (string)

      Email address of the contact.

      Type: String

      Default: None

      Constraints: Maximum 254 characters.

      Parents: RegistrantContact, AdminContact, TechContact

      Required: Yes

    - Fax => (string)

      Fax number of the contact.

      Type: String

      Default: None

      Constraints: Phone number must be specified in the format "+[country dialing code].[number including any area code]". For example, a US phone number might appear as "+1.1234567890".

      Parents: RegistrantContact, AdminContact, TechContact

      Required: No

    - ExtraParams => (array<associative-array>)

      A list of name-value pairs for parameters required by certain top-level domains.

      Type: Complex

      Default: None

      Parents: RegistrantContact, AdminContact, TechContact

      Children: Name, Value

      Required: No

      - (associative-array)

        ExtraParam includes the following elements.

        - Name => (string: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER )

          Name of the additional parameter required by the top-level domain.

          Type: String

          Default: None

          Valid values: DUNS_NUMBER | BRAND_NUMBER | BIRTH_DEPARTMENT | BIRTH_DATE_IN_YYYY_MM_DD | BIRTH_COUNTRY | BIRTH_CITY | DOCUMENT_NUMBER | AU_ID_NUMBER | AU_ID_TYPE | CA_LEGAL_TYPE | ES_IDENTIFICATION | ES_IDENTIFICATION_TYPE | ES_LEGAL_FORM | FI_BUSINESS_NUMBER | FI_ID_NUMBER | IT_PIN | RU_PASSPORT_DATA | SE_ID_NUMBER | SG_ID_NUMBER | VAT_NUMBER

          Parent: ExtraParams

          Required: Yes

        - Value => (string)

          Values corresponding to the additional parameter names required by some top-level domains.

          Type: String

          Default: None

          Constraints: Maximum 2048 characters.

          Parent: ExtraParams

          Required: Yes

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- OperationId => (string)

  Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

  Type: String

  Default: None

  Constraints: Maximum 255 characters.

# `public `Guzzle\Service\Resource\Model``
`updateDomainContactPrivacy( array $args = array() )`

Executes the UpdateDomainContactPrivacy operation.

This operation updates the specified domain contact's privacy setting. When the privacy option is enabled, personal information such as postal or email address is hidden from the results of a public WHOIS query. The privacy services are provided by the AWS registrar, Gandi. For more information, see the Gandi privacy features.

This operation only affects the privacy of the specified contact type (registrant, administrator, or tech). Successful acceptance returns an operation ID that you can use with GetOperationDetail to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

#### Examples

- Basic formatting example

      $result = $client->updateDomainContactPrivacy(array(
          // DomainName is required
          'DomainName' => 'string',
          'AdminPrivacy' => true || false,
          'RegistrantPrivacy' => true || false,
          'TechPrivacy' => true || false,
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)

    The name of a domain.

    Type: String

    Default: None

    Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

    Required: Yes

  - AdminPrivacy => (bool)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

    Type: Boolean

    Default: None

    Valid values: true | false

    Required: No

  - RegistrantPrivacy => (bool)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

    Type: Boolean

    Default: None

    Valid values: true | false

    Required: No

  - TechPrivacy => (bool)

    Whether you want to conceal contact information from WHOIS queries. If you specify true, WHOIS ("who is") queries will return contact information for our registrar partner, Gandi, instead of the contact information that you enter.

    Type: Boolean

    Default: None

    Valid values: true | false

    Required: No

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- OperationId => (string)

  Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

  Type: String

  Default: None

  Constraints: Maximum 255 characters.

# `public `Guzzle\Service\Resource\Model``
`updateDomainNameservers( array $args = array() )`

Executes the UpdateDomainNameservers operation.

This operation replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.

If successful, this operation returns an operation ID that you can use to track the progress and completion of the action. If the request is not completed successfully, the domain registrant will be notified by email.

#### Examples

- Basic formatting example

      $result = $client->updateDomainNameservers(array(
          // DomainName is required
          'DomainName' => 'string',
          'FIAuthKey' => 'string',
          // Nameservers is required
          'Nameservers' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  'GlueIps' => array('string', ... ),
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)

    The name of a domain.

    Type: String

    Default: None

    Constraints: The domain name can contain only the letters a through z, the numbers 0 through 9, and hyphen (-). Internationalized Domain Names are not supported.

    Required: Yes

  - FIAuthKey => (string)

    The authorization key for .fi domains

  - Nameservers => (array<associative-array>)

    A list of new name servers for the domain.

    Type: Complex

    Children: Name, GlueIps

    Required: Yes

    - (associative-array)

      Nameserver includes the following elements.

      - Name => (string)

        The fully qualified host name of the name server.

        Type: String

        Constraint: Maximum 255 characterss

        Parent: Nameservers

      - GlueIps => (array<string>)

        Glue IP address of a name server entry. Glue IP addresses are required only when the name of the name server is a subdomain of the domain. For example, if your domain is example.com and the name server for the domain is ns.example.com, you need to specify the IP address for ns.example.com.

        Type: List of IP addresses.

        Constraints: The list can contain only one IPv4 and one IPv6 address.

        Parent: Nameservers

#### Returns

``Guzzle\Service\Resource\Model``
Returns a response Model object

- OperationId => (string)

  Identifier for tracking the progress of the request. To use this ID to query the operation status, use GetOperationDetail.

  Type: String

  Default: None

  Constraints: Maximum 255 characters.

### Methods inherited from Aws\Common\Client\AbstractClient

`__call()`, `__construct()`, `createRequest()`, `getAllEvents()`, `getApiVersion()`, `getCredentials()`, `getRegion()`, `getRegions()`, `getSignature()`, `getWaiter()`, `getWaiterFactory()`, `send()`, `setCredentials()`, `setRegion()`, `setWaiterFactory()`, `waitUntil()`

### Methods inherited from Guzzle\Service\Client

`execute()`, `executeMultiple()`, `getCommand()`, `getCommandFactory()`, `getDescription()`, `getInflector()`, `getIterator()`, `getResourceIteratorFactory()`, `prepareCommand()`, `setCommandFactory()`, `setDescription()`, `setInflector()`, `setResourceIteratorFactory()`

### Methods inherited from Guzzle\Http\Client

`delete()`, `expandTemplate()`, `extractPharCacert()`, `get()`, `getBaseUrl()`, `getConfig()`, `getCurlMulti()`, `getDefaultOption()`, `getDefaultUserAgent()`, `getUriTemplate()`, `head()`, `initSsl()`, `options()`, `patch()`, `post()`, `prepareRequest()`, `put()`, `sendMultiple()`, `setBaseUrl()`, `setConfig()`, `setCurlMulti()`, `setDefaultOption()`, `setRequestFactory()`, `setSslVerification()`, `setUriTemplate()`, `setUserAgent()`

### Methods inherited from Guzzle\Common\AbstractHasDispatcher

`addSubscriber()`, `dispatch()`, `getEventDispatcher()`, `setEventDispatcher()`

### Magic methods summary

## Constants summary

`string` | `LATEST_API_VERSION` | `'2014-05-15'` | #

### Constants inherited from Guzzle\Service\Client

`COMMAND_PARAMS`

### Constants inherited from Guzzle\Http\Client

`CURL_OPTIONS`, `DEFAULT_SELECT_TIMEOUT`, `DISABLE_REDIRECTS`, `MAX_HANDLES`, `REQUEST_OPTIONS`, `SSL_CERT_AUTHORITY`

### Constants inherited from Guzzle\Http\ClientInterface

`CREATE_REQUEST`, `HTTP_DATE`

## Properties summary

### Properties inherited from Aws\Common\Client\AbstractClient

`$aggregator`, `$credentials`, `$signature`, `$waiterFactory`

### Properties inherited from Guzzle\Service\Client

`$commandFactory`, `$inflector`, `$resourceIteratorFactory`, `$serviceDescription`

### Properties inherited from Guzzle\Http\Client

`$defaultHeaders`, `$requestFactory`, `$userAgent`

### Properties inherited from Guzzle\Common\AbstractHasDispatcher

`$eventDispatcher`