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

# Class DeleteRequest

Represents a batch delete request. It is composed of a table name and key

  Aws\DynamoDb\Model\BatchRequest\AbstractWriteRequest implements Aws\DynamoDb\Model\BatchRequest\WriteRequestInterface
  Aws\DynamoDb\Model\BatchRequest\DeleteRequest

Namespace: Aws\DynamoDb\Model\BatchRequest
Located at Aws/DynamoDb/Model/BatchRequest/DeleteRequest.php

## Methods summary

- `public static` `fromCommand ( Guzzle\Service\Command\AbstractCommand $command )`

  Factory that creates a DeleteRequest from a DeleteItem command

- `public` `__construct ( array $key, string $tableName )`

  Constructs a new delete request

- `public` `toArray ( )`

  The parameter form of the request

- `public` `getKey ( )`

  Get the key

## Methods detail

# `public static `Aws\DynamoDb\Model\BatchRequest\PutRequest``
`fromCommand( `Guzzle\Service\Command\AbstractCommand` $command )`

Factory that creates a DeleteRequest from a DeleteItem command

#### Parameters

$command
  ``Guzzle\Service\Command\AbstractCommand``
  $command The command to create the request from

#### Returns

``Aws\DynamoDb\Model\BatchRequest\PutRequest``

#### Throws

``Aws\Common\Exception\InvalidArgumentException``
if the command is not a DeleteItem command
# `public`
`__construct( array $key, string $tableName )`

Constructs a new delete request

#### Examples

- Use WriteRequestBatch to batch several DeleteItem requests

      // Remove items from the table
      $deleteBatch = WriteRequestBatch::factory($client);
      foreach ($itemIds as $itemId) {
          $key = array('id' => array('S' => $itemId));
          $deleteBatch->add(new DeleteRequest($key, $tableName));
      }
      $deleteBatch->flush();

#### Parameters

$key
  `array`
  $key The key of the item to delete
$tableName
  `string`
  $tableName The name of the table which has the item

# `public array`
`toArray( )`

The parameter form of the request

#### Returns

`array`
# `public array`
`getKey( )`

Get the key

#### Returns

`array`

### Methods inherited from Aws\DynamoDb\Model\BatchRequest\AbstractWriteRequest

`getTableName()`

### Magic methods summary

## Properties summary

`protected array` | $key | # The key of the item to delete

### Properties inherited from Aws\DynamoDb\Model\BatchRequest\AbstractWriteRequest

`$tableName`