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

# Class SimpleDbClient

Client to interact with Amazon SimpleDB

  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\SimpleDb\SimpleDbClient

Namespace: Aws\SimpleDb
Link: User guide
Link: API docs
Located at Aws/SimpleDb/SimpleDbClient.php

## Methods summary

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

  Factory method to create a new Amazon SimpleDB client using an array of configuration options.

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

  Executes the BatchDeleteAttributes operation.

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

  Executes the BatchPutAttributes operation.

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

  Executes the CreateDomain operation.

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

  Executes the DeleteAttributes operation.

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

  Executes the DeleteDomain operation.

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

  Executes the DomainMetadata operation.

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

  Executes the GetAttributes operation.

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

  Executes the ListDomains operation.

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

  Executes the PutAttributes operation.

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

  Executes the Select operation.

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

  The input array uses the parameters of the ListDomains operation

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

  The input array uses the parameters of the Select operation

## Methods detail

# `public static `Aws\SimpleDb\SimpleDbClient``
`factory( array|`Guzzle\Common\Collection` $config = array() )`

Factory method to create a new Amazon SimpleDB client using an array of configuration options.

#### Parameters

$config
  `array|`Guzzle\Common\Collection``
  $config Client configuration data

#### Returns

``Aws\SimpleDb\SimpleDbClient``

#### Link

http://docs.aws.amazon.com/aws-sdk-php/v2/guide/configuration.html#client-configuration-options

#### Overrides

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

Executes the BatchDeleteAttributes operation.

#### Examples

- Basic formatting example

      $result = $client->batchDeleteAttributes(array(
          // DomainName is required
          'DomainName' => 'string',
          // Items is required
          'Items' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  'Attributes' => array(
                      array(
                          // Name is required
                          'Name' => 'string',
                          'AlternateNameEncoding' => 'string',
                          'Value' => 'string',
                          'AlternateValueEncoding' => 'string',
                      ),
                      // ... repeated
                  ),
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)
  - Items => (array<associative-array>)
    - (associative-array)
      - Name => (string)
      - Attributes => (array<associative-array>)
        - (associative-array)
          - Name => (string)
          - AlternateNameEncoding => (string)
          - Value => (string)
          - AlternateValueEncoding => (string)

#### Returns

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

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

Executes the BatchPutAttributes operation.

#### Examples

- Basic formatting example

      $result = $client->batchPutAttributes(array(
          // DomainName is required
          'DomainName' => 'string',
          // Items is required
          'Items' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Attributes is required
                  'Attributes' => array(
                      array(
                          // Name is required
                          'Name' => 'string',
                          // Value is required
                          'Value' => 'string',
                          'Replace' => true || false,
                      ),
                      // ... repeated
                  ),
              ),
              // ... repeated
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)
  - Items => (array<associative-array>)
    - (associative-array)
      - Name => (string)
      - Attributes => (array<associative-array>)
        - (associative-array)
          - Name => (string)
          - Value => (string)
          - Replace => (bool)

#### Returns

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

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

Executes the CreateDomain operation.

#### Examples

- Basic formatting example

      $result = $client->createDomain(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``
`deleteAttributes( array $args = array() )`

Executes the DeleteAttributes operation.

#### Examples

- Basic formatting example

      $result = $client->deleteAttributes(array(
          // DomainName is required
          'DomainName' => 'string',
          // ItemName is required
          'ItemName' => 'string',
          'Attributes' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  'AlternateNameEncoding' => 'string',
                  'Value' => 'string',
                  'AlternateValueEncoding' => 'string',
              ),
              // ... repeated
          ),
          'Expected' => array(
              'Name' => 'string',
              'Value' => 'string',
              'Exists' => true || false,
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)
  - ItemName => (string)
  - Attributes => (array<associative-array>)
    - (associative-array)
      - Name => (string)
      - AlternateNameEncoding => (string)
      - Value => (string)
      - AlternateValueEncoding => (string)
  - Expected => (associative-array)
    - Name => (string)
    - Value => (string)
    - Exists => (bool)

#### Returns

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

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

Executes the DeleteDomain operation.

#### Examples

- Basic formatting example

      $result = $client->deleteDomain(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``
`domainMetadata( array $args = array() )`

Executes the DomainMetadata operation.

#### Examples

- Basic formatting example

      $result = $client->domainMetadata(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

- ItemCount => (int)
- ItemNamesSizeBytes => (int)
- AttributeNameCount => (int)
- AttributeNamesSizeBytes => (int)
- AttributeValueCount => (int)
- AttributeValuesSizeBytes => (int)
- Timestamp => (int)

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

Executes the GetAttributes operation.

#### Examples

- Basic formatting example

      $result = $client->getAttributes(array(
          // DomainName is required
          'DomainName' => 'string',
          // ItemName is required
          'ItemName' => 'string',
          'AttributeNames' => array('string', ... ),
          'ConsistentRead' => true || false,
      ));

#### Parameters

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

#### Returns

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

- Attributes => (array<associative-array>)
  - (associative-array)
    - Name => (string)
    - AlternateNameEncoding => (string)
    - Value => (string)
    - AlternateValueEncoding => (string)

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

Executes the ListDomains operation.

#### Examples

- Basic formatting example

      $result = $client->listDomains(array(
          'MaxNumberOfDomains' => integer,
          'NextToken' => 'string',
      ));

#### Parameters

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

#### Returns

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

- DomainNames => (array<string>)
- NextToken => (string)

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

Executes the PutAttributes operation.

#### Examples

- Basic formatting example

      $result = $client->putAttributes(array(
          // DomainName is required
          'DomainName' => 'string',
          // ItemName is required
          'ItemName' => 'string',
          // Attributes is required
          'Attributes' => array(
              array(
                  // Name is required
                  'Name' => 'string',
                  // Value is required
                  'Value' => 'string',
                  'Replace' => true || false,
              ),
              // ... repeated
          ),
          'Expected' => array(
              'Name' => 'string',
              'Value' => 'string',
              'Exists' => true || false,
          ),
      ));

#### Parameters

$args
  `array`
  $arg Associative array containing the following keys (required keys are bold):
  - DomainName => (string)
  - ItemName => (string)
  - Attributes => (array<associative-array>)
    - (associative-array)
      - Name => (string)
      - Value => (string)
      - Replace => (bool)
  - Expected => (associative-array)
    - Name => (string)
    - Value => (string)
    - Exists => (bool)

#### Returns

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

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

Executes the Select operation.

#### Examples

- Basic formatting example

      $result = $client->select(array(
          // SelectExpression is required
          'SelectExpression' => 'string',
          'NextToken' => 'string',
          'ConsistentRead' => true || false,
      ));

#### Parameters

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

#### Returns

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

- Items => (array<associative-array>)
  - (associative-array)
    - Name => (string)
    - AlternateNameEncoding => (string)
    - Attributes => (array<associative-array>)
      - (associative-array)
        - Name => (string)
        - AlternateNameEncoding => (string)
        - Value => (string)
        - AlternateValueEncoding => (string)
- NextToken => (string)

# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getListDomainsIterator( array $args = array() )`

The input array uses the parameters of the ListDomains operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``
# `public `Guzzle\Service\Resource\ResourceIteratorInterface``
`getSelectIterator( array $args = array() )`

The input array uses the parameters of the Select operation

#### Parameters

$args
  `array`
  $args

#### Returns

``Guzzle\Service\Resource\ResourceIteratorInterface``

### 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` | `'2009-04-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`