BatchExecuteStatement

$result = $client->batchExecuteStatement([/* ... */]);
$promise = $client->batchExecuteStatementAsync([/* ... */]);

This operation allows you to perform batch reads or writes on data stored in DynamoDB, using PartiQL. Each read statement in a BatchExecuteStatement must specify an equality condition on all key attributes. This enforces that each SELECT statement in a batch returns at most a single item. For more information, see Running batch operations with PartiQL for DynamoDB .

Parameter Syntax

$result = $client->batchExecuteStatement([
    'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
    'Statements' => [ // REQUIRED
        [
            'ConsistentRead' => true || false,
            'Parameters' => [
                [
                    'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BOOL' => true || false,
                    'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                    'L' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'M' => [
                        '<AttributeName>' => [...], // RECURSIVE
                        // ...
                    ],
                    'N' => '<string>',
                    'NS' => ['<string>', ...],
                    'NULL' => true || false,
                    'S' => '<string>',
                    'SS' => ['<string>', ...],
                ],
                // ...
            ],
            'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
            'Statement' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ConsumedCapacity' => [
        [
            'CapacityUnits' => <float>,
            'GlobalSecondaryIndexes' => [
                '<IndexName>' => [
                    'CapacityUnits' => <float>,
                    'ReadCapacityUnits' => <float>,
                    'WriteCapacityUnits' => <float>,
                ],
                // ...
            ],
            'LocalSecondaryIndexes' => [
                '<IndexName>' => [
                    'CapacityUnits' => <float>,
                    'ReadCapacityUnits' => <float>,
                    'WriteCapacityUnits' => <float>,
                ],
                // ...
            ],
            'ReadCapacityUnits' => <float>,
            'Table' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            'TableName' => '<string>',
            'WriteCapacityUnits' => <float>,
        ],
        // ...
    ],
    'Responses' => [
        [
            'Error' => [
                'Code' => 'ConditionalCheckFailed|ItemCollectionSizeLimitExceeded|RequestLimitExceeded|ValidationError|ProvisionedThroughputExceeded|TransactionConflict|ThrottlingError|InternalServerError|ResourceNotFound|AccessDenied|DuplicateItem',
                'Item' => [
                    '<AttributeName>' => [
                        'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                        'BOOL' => true || false,
                        'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                        'L' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'M' => [
                            '<AttributeName>' => [...], // RECURSIVE
                            // ...
                        ],
                        'N' => '<string>',
                        'NS' => ['<string>', ...],
                        'NULL' => true || false,
                        'S' => '<string>',
                        'SS' => ['<string>', ...],
                    ],
                    // ...
                ],
                'Message' => '<string>',
            ],
            'Item' => [
                '<AttributeName>' => [
                    'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BOOL' => true || false,
                    'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                    'L' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'M' => [
                        '<AttributeName>' => [...], // RECURSIVE
                        // ...
                    ],
                    'N' => '<string>',
                    'NS' => ['<string>', ...],
                    'NULL' => true || false,
                    'S' => '<string>',
                    'SS' => ['<string>', ...],
                ],
                // ...
            ],
            'TableName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

RequestLimitExceeded:

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

InternalServerError:

An error occurred on the server side.

BatchGetItem

$result = $client->batchGetItem([/* ... */]);
$promise = $client->batchGetItemAsync([/* ... */]);

The BatchGetItem operation returns the attributes of one or more items from one or more tables. You identify requested items by primary key.

A single operation can retrieve up to 16 MB of data, which can contain as many as 100 items. BatchGetItem returns a partial result if the response size limit is exceeded, the table's provisioned throughput is exceeded, more than 1MB per partition is requested, or an internal processing failure occurs. If a partial result is returned, the operation returns a value for UnprocessedKeys. You can use this value to retry the operation starting with the next item to get.

For example, if you ask to retrieve 100 items, but each individual item is 300 KB in size, the system returns 52 items (so as not to exceed the 16 MB limit). It also returns an appropriate UnprocessedKeys value so you can get the next page of results. If desired, your application can include its own logic to assemble the pages of results into one dataset.

If none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchGetItem returns a ProvisionedThroughputExceededException. If at least one of the items is successfully processed, then BatchGetItem completes successfully, while returning the keys of the unread items in UnprocessedKeys.

By default, BatchGetItem performs eventually consistent reads on every table in the request. If you want strongly consistent reads instead, you can set ConsistentRead to true for any or all tables.

In order to minimize response latency, BatchGetItem may retrieve items in parallel.

When designing your application, keep in mind that DynamoDB does not return items in any particular order. To help parse the response by item, include the primary key values for the items in your request in the ProjectionExpression parameter.

If a requested item does not exist, it is not returned in the result. Requests for nonexistent items consume the minimum read capacity units according to the type of read. For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

Parameter Syntax

$result = $client->batchGetItem([
    'RequestItems' => [ // REQUIRED
        '<TableArn>' => [
            'AttributesToGet' => ['<string>', ...],
            'ConsistentRead' => true || false,
            'ExpressionAttributeNames' => ['<string>', ...],
            'Keys' => [ // REQUIRED
                [
                    '<AttributeName>' => [
                        'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                        'BOOL' => true || false,
                        'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                        'L' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'M' => [
                            '<AttributeName>' => [...], // RECURSIVE
                            // ...
                        ],
                        'N' => '<string>',
                        'NS' => ['<string>', ...],
                        'NULL' => true || false,
                        'S' => '<string>',
                        'SS' => ['<string>', ...],
                    ],
                    // ...
                ],
                // ...
            ],
            'ProjectionExpression' => '<string>',
        ],
        // ...
    ],
    'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
]);

Parameter Details

Result Syntax

[
    'ConsumedCapacity' => [
        [
            'CapacityUnits' => <float>,
            'GlobalSecondaryIndexes' => [
                '<IndexName>' => [
                    'CapacityUnits' => <float>,
                    'ReadCapacityUnits' => <float>,
                    'WriteCapacityUnits' => <float>,
                ],
                // ...
            ],
            'LocalSecondaryIndexes' => [
                '<IndexName>' => [
                    'CapacityUnits' => <float>,
                    'ReadCapacityUnits' => <float>,
                    'WriteCapacityUnits' => <float>,
                ],
                // ...
            ],
            'ReadCapacityUnits' => <float>,
            'Table' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            'TableName' => '<string>',
            'WriteCapacityUnits' => <float>,
        ],
        // ...
    ],
    'Responses' => [
        '<TableArn>' => [
            [
                '<AttributeName>' => [
                    'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BOOL' => true || false,
                    'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                    'L' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'M' => [
                        '<AttributeName>' => [...], // RECURSIVE
                        // ...
                    ],
                    'N' => '<string>',
                    'NS' => ['<string>', ...],
                    'NULL' => true || false,
                    'S' => '<string>',
                    'SS' => ['<string>', ...],
                ],
                // ...
            ],
            // ...
        ],
        // ...
    ],
    'UnprocessedKeys' => [
        '<TableArn>' => [
            'AttributesToGet' => ['<string>', ...],
            'ConsistentRead' => true || false,
            'ExpressionAttributeNames' => ['<string>', ...],
            'Keys' => [
                [
                    '<AttributeName>' => [
                        'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                        'BOOL' => true || false,
                        'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                        'L' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'M' => [
                            '<AttributeName>' => [...], // RECURSIVE
                            // ...
                        ],
                        'N' => '<string>',
                        'NS' => ['<string>', ...],
                        'NULL' => true || false,
                        'S' => '<string>',
                        'SS' => ['<string>', ...],
                    ],
                    // ...
                ],
                // ...
            ],
            'ProjectionExpression' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ProvisionedThroughputExceededException:

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

RequestLimitExceeded:

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

InternalServerError:

An error occurred on the server side.

Examples

Example 1: To retrieve multiple items from a table

This example reads multiple items from the Music table using a batch of three GetItem requests. Only the AlbumTitle attribute is returned.

$result = $client->batchGetItem([
    'RequestItems' => [
        'Music' => [
            'Keys' => [
                [
                    'Artist' => [
                        'S' => 'No One You Know',
                    ],
                    'SongTitle' => [
                        'S' => 'Call Me Today',
                    ],
                ],
                [
                    'Artist' => [
                        'S' => 'Acme Band',
                    ],
                    'SongTitle' => [
                        'S' => 'Happy Day',
                    ],
                ],
                [
                    'Artist' => [
                        'S' => 'No One You Know',
                    ],
                    'SongTitle' => [
                        'S' => 'Scared of My Shadow',
                    ],
                ],
            ],
            'ProjectionExpression' => 'AlbumTitle',
        ],
    ],
]);

Result syntax:

[
    'Responses' => [
        'Music' => [
            [
                'AlbumTitle' => [
                    'S' => 'Somewhat Famous',
                ],
            ],
            [
                'AlbumTitle' => [
                    'S' => 'Blue Sky Blues',
                ],
            ],
            [
                'AlbumTitle' => [
                    'S' => 'Louder Than Ever',
                ],
            ],
        ],
    ],
]

BatchWriteItem

$result = $client->batchWriteItem([/* ... */]);
$promise = $client->batchWriteItemAsync([/* ... */]);

The BatchWriteItem operation puts or deletes multiple items in one or more tables. A single call to BatchWriteItem can transmit up to 16MB of data over the network, consisting of up to 25 item put or delete operations. While individual items can be up to 400 KB once stored, it's important to note that an item's representation might be greater than 400KB while being sent in DynamoDB's JSON format for the API call. For more details on this distinction, see Naming Rules and Data Types.

The individual PutItem and DeleteItem operations specified in BatchWriteItem are atomic; however BatchWriteItem as a whole is not. If any requested operations fail because the table's provisioned throughput is exceeded or an internal processing failure occurs, the failed operations are returned in the UnprocessedItems response parameter. You can investigate and optionally resend the requests. Typically, you would call BatchWriteItem in a loop. Each iteration would check for unprocessed items and submit a new BatchWriteItem request with those unprocessed items until all items have been processed.

For tables and indexes with provisioned capacity, if none of the items can be processed due to insufficient provisioned throughput on all of the tables in the request, then BatchWriteItem returns a ProvisionedThroughputExceededException. For all tables and indexes, if none of the items can be processed due to other throttling scenarios (such as exceeding partition level limits), then BatchWriteItem returns a ThrottlingException.

With BatchWriteItem, you can efficiently write or delete large amounts of data, such as from Amazon EMR, or copy data from another database into DynamoDB. In order to improve performance with these large-scale operations, BatchWriteItem does not behave in the same way as individual PutItem and DeleteItem calls would. For example, you cannot specify conditions on individual put and delete requests, and BatchWriteItem does not return deleted items in the response.

If you use a programming language that supports concurrency, you can use threads to write items in parallel. Your application must include the necessary logic to manage the threads. With languages that don't support threading, you must update or delete the specified items one at a time. In both situations, BatchWriteItem performs the specified put and delete operations in parallel, giving you the power of the thread pool approach without having to introduce complexity into your application.

Parallel processing reduces latency, but each specified put and delete request consumes the same number of write capacity units whether it is processed in parallel or not. Delete operations on nonexistent items consume one write capacity unit.

If one or more of the following is true, DynamoDB rejects the entire batch write operation:

• One or more tables specified in the BatchWriteItem request does not exist.

• Primary key attributes specified on an item in the request do not match those in the corresponding table's primary key schema.

• You try to perform multiple operations on the same item in the same BatchWriteItem request. For example, you cannot put and delete the same item in the same BatchWriteItem request.

• Your request contains at least two items with identical hash and range keys (which essentially is two put operations).

• There are more than 25 requests in the batch.

• Any individual item in a batch exceeds 400 KB.

• The total request size exceeds 16 MB.

• Any individual items with keys exceeding the key length limits. For a partition key, the limit is 2048 bytes and for a sort key, the limit is 1024 bytes.

Parameter Syntax

$result = $client->batchWriteItem([
    'RequestItems' => [ // REQUIRED
        '<TableArn>' => [
            [
                'DeleteRequest' => [
                    'Key' => [ // REQUIRED
                        '<AttributeName>' => [
                            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                            'BOOL' => true || false,
                            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                            'L' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'M' => [
                                '<AttributeName>' => [...], // RECURSIVE
                                // ...
                            ],
                            'N' => '<string>',
                            'NS' => ['<string>', ...],
                            'NULL' => true || false,
                            'S' => '<string>',
                            'SS' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                'PutRequest' => [
                    'Item' => [ // REQUIRED
                        '<AttributeName>' => [
                            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                            'BOOL' => true || false,
                            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                            'L' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'M' => [
                                '<AttributeName>' => [...], // RECURSIVE
                                // ...
                            ],
                            'N' => '<string>',
                            'NS' => ['<string>', ...],
                            'NULL' => true || false,
                            'S' => '<string>',
                            'SS' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
        // ...
    ],
    'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
    'ReturnItemCollectionMetrics' => 'SIZE|NONE',
]);

Parameter Details

Result Syntax

[
    'ConsumedCapacity' => [
        [
            'CapacityUnits' => <float>,
            'GlobalSecondaryIndexes' => [
                '<IndexName>' => [
                    'CapacityUnits' => <float>,
                    'ReadCapacityUnits' => <float>,
                    'WriteCapacityUnits' => <float>,
                ],
                // ...
            ],
            'LocalSecondaryIndexes' => [
                '<IndexName>' => [
                    'CapacityUnits' => <float>,
                    'ReadCapacityUnits' => <float>,
                    'WriteCapacityUnits' => <float>,
                ],
                // ...
            ],
            'ReadCapacityUnits' => <float>,
            'Table' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            'TableName' => '<string>',
            'WriteCapacityUnits' => <float>,
        ],
        // ...
    ],
    'ItemCollectionMetrics' => [
        '<TableArn>' => [
            [
                'ItemCollectionKey' => [
                    '<AttributeName>' => [
                        'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                        'BOOL' => true || false,
                        'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                        'L' => [
                            [...], // RECURSIVE
                            // ...
                        ],
                        'M' => [
                            '<AttributeName>' => [...], // RECURSIVE
                            // ...
                        ],
                        'N' => '<string>',
                        'NS' => ['<string>', ...],
                        'NULL' => true || false,
                        'S' => '<string>',
                        'SS' => ['<string>', ...],
                    ],
                    // ...
                ],
                'SizeEstimateRangeGB' => [<float>, ...],
            ],
            // ...
        ],
        // ...
    ],
    'UnprocessedItems' => [
        '<TableArn>' => [
            [
                'DeleteRequest' => [
                    'Key' => [
                        '<AttributeName>' => [
                            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                            'BOOL' => true || false,
                            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                            'L' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'M' => [
                                '<AttributeName>' => [...], // RECURSIVE
                                // ...
                            ],
                            'N' => '<string>',
                            'NS' => ['<string>', ...],
                            'NULL' => true || false,
                            'S' => '<string>',
                            'SS' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                'PutRequest' => [
                    'Item' => [
                        '<AttributeName>' => [
                            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                            'BOOL' => true || false,
                            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                            'L' => [
                                [...], // RECURSIVE
                                // ...
                            ],
                            'M' => [
                                '<AttributeName>' => [...], // RECURSIVE
                                // ...
                            ],
                            'N' => '<string>',
                            'NS' => ['<string>', ...],
                            'NULL' => true || false,
                            'S' => '<string>',
                            'SS' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
            ],
            // ...
        ],
        // ...
    ],
]

Result Details

Errors

ProvisionedThroughputExceededException:

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

ItemCollectionSizeLimitExceededException:

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

RequestLimitExceeded:

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

InternalServerError:

An error occurred on the server side.

Examples

Example 1: To add multiple items to a table

This example adds three new items to the Music table using a batch of three PutItem requests.

$result = $client->batchWriteItem([
    'RequestItems' => [
        'Music' => [
            [
                'PutRequest' => [
                    'Item' => [
                        'AlbumTitle' => [
                            'S' => 'Somewhat Famous',
                        ],
                        'Artist' => [
                            'S' => 'No One You Know',
                        ],
                        'SongTitle' => [
                            'S' => 'Call Me Today',
                        ],
                    ],
                ],
            ],
            [
                'PutRequest' => [
                    'Item' => [
                        'AlbumTitle' => [
                            'S' => 'Songs About Life',
                        ],
                        'Artist' => [
                            'S' => 'Acme Band',
                        ],
                        'SongTitle' => [
                            'S' => 'Happy Day',
                        ],
                    ],
                ],
            ],
            [
                'PutRequest' => [
                    'Item' => [
                        'AlbumTitle' => [
                            'S' => 'Blue Sky Blues',
                        ],
                        'Artist' => [
                            'S' => 'No One You Know',
                        ],
                        'SongTitle' => [
                            'S' => 'Scared of My Shadow',
                        ],
                    ],
                ],
            ],
        ],
    ],
]);

Result syntax:

[
]

CreateBackup

$result = $client->createBackup([/* ... */]);
$promise = $client->createBackupAsync([/* ... */]);

Creates a backup for an existing table.

Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.

When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.

You can call CreateBackup at a maximum rate of 50 times per second.

All backups in DynamoDB work without consuming any provisioned throughput on the table.

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.

Along with data, the following are also included on the backups:

• Global secondary indexes (GSIs)

• Local secondary indexes (LSIs)

• Streams

• Provisioned read and write capacity

Parameter Syntax

$result = $client->createBackup([
    'BackupName' => '<string>', // REQUIRED
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'BackupDetails' => [
        'BackupArn' => '<string>',
        'BackupCreationDateTime' => <DateTime>,
        'BackupExpiryDateTime' => <DateTime>,
        'BackupName' => '<string>',
        'BackupSizeBytes' => <integer>,
        'BackupStatus' => 'CREATING|DELETED|AVAILABLE',
        'BackupType' => 'USER|SYSTEM|AWS_BACKUP',
    ],
]

Result Details

Errors

TableNotFoundException:

A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

TableInUseException:

A target table with the specified name is either being created or deleted.

ContinuousBackupsUnavailableException:

Backups have not yet been enabled for this table.

BackupInUseException:

There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

InternalServerError:

An error occurred on the server side.

CreateGlobalTable

$result = $client->createGlobalTable([/* ... */]);
$promise = $client->createGlobalTableAsync([/* ... */]);

Creates a global table from an existing table. A global table creates a replication relationship between two or more DynamoDB tables with the same table name in the provided Regions.

If you want to add a new replica table to a global table, each of the following conditions must be true:

• The table must have the same primary key as all of the other replicas.

• The table must have the same name as all of the other replicas.

• The table must have DynamoDB Streams enabled, with the stream containing both the new and the old images of the item.

• None of the replica tables in the global table can contain any data.

If global secondary indexes are specified, then the following conditions must also be met:

• The global secondary indexes must have the same name.

• The global secondary indexes must have the same hash key and sort key (if present).

If local secondary indexes are specified, then the following conditions must also be met:

• The local secondary indexes must have the same name.

• The local secondary indexes must have the same hash key and sort key (if present).

Parameter Syntax

$result = $client->createGlobalTable([
    'GlobalTableName' => '<string>', // REQUIRED
    'ReplicationGroup' => [ // REQUIRED
        [
            'RegionName' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'GlobalTableDescription' => [
        'CreationDateTime' => <DateTime>,
        'GlobalTableArn' => '<string>',
        'GlobalTableName' => '<string>',
        'GlobalTableStatus' => 'CREATING|ACTIVE|DELETING|UPDATING',
        'ReplicationGroup' => [
            [
                'GlobalSecondaryIndexes' => [
                    [
                        'IndexName' => '<string>',
                        'OnDemandThroughputOverride' => [
                            'MaxReadRequestUnits' => <integer>,
                        ],
                        'ProvisionedThroughputOverride' => [
                            'ReadCapacityUnits' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'KMSMasterKeyId' => '<string>',
                'OnDemandThroughputOverride' => [
                    'MaxReadRequestUnits' => <integer>,
                ],
                'ProvisionedThroughputOverride' => [
                    'ReadCapacityUnits' => <integer>,
                ],
                'RegionName' => '<string>',
                'ReplicaInaccessibleDateTime' => <DateTime>,
                'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS',
                'ReplicaStatusDescription' => '<string>',
                'ReplicaStatusPercentProgress' => '<string>',
                'ReplicaTableClassSummary' => [
                    'LastUpdateDateTime' => <DateTime>,
                    'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Errors

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

InternalServerError:

An error occurred on the server side.

GlobalTableAlreadyExistsException:

The specified global table already exists.

TableNotFoundException:

A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

CreateTable

$result = $client->createTable([/* ... */]);
$promise = $client->createTableAsync([/* ... */]);

The CreateTable operation adds a new table to your account. In an Amazon Web Services account, table names must be unique within each Region. That is, you can have two tables with same name if you create the tables in different Regions.

CreateTable is an asynchronous operation. Upon receiving a CreateTable request, DynamoDB immediately returns a response with a TableStatus of CREATING. After the table is created, DynamoDB sets the TableStatus to ACTIVE. You can perform read and write operations only on an ACTIVE table.

You can optionally define secondary indexes on the new table, as part of the CreateTable operation. If you want to create multiple tables with secondary indexes on them, you must create the tables sequentially. Only one table with secondary indexes can be in the CREATING state at any given time.

You can use the DescribeTable action to check the table status.

Parameter Syntax

$result = $client->createTable([
    'AttributeDefinitions' => [ // REQUIRED
        [
            'AttributeName' => '<string>', // REQUIRED
            'AttributeType' => 'S|N|B', // REQUIRED
        ],
        // ...
    ],
    'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
    'DeletionProtectionEnabled' => true || false,
    'GlobalSecondaryIndexes' => [
        [
            'IndexName' => '<string>', // REQUIRED
            'KeySchema' => [ // REQUIRED
                [
                    'AttributeName' => '<string>', // REQUIRED
                    'KeyType' => 'HASH|RANGE', // REQUIRED
                ],
                // ...
            ],
            'OnDemandThroughput' => [
                'MaxReadRequestUnits' => <integer>,
                'MaxWriteRequestUnits' => <integer>,
            ],
            'Projection' => [ // REQUIRED
                'NonKeyAttributes' => ['<string>', ...],
                'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
            ],
            'ProvisionedThroughput' => [
                'ReadCapacityUnits' => <integer>, // REQUIRED
                'WriteCapacityUnits' => <integer>, // REQUIRED
            ],
        ],
        // ...
    ],
    'KeySchema' => [ // REQUIRED
        [
            'AttributeName' => '<string>', // REQUIRED
            'KeyType' => 'HASH|RANGE', // REQUIRED
        ],
        // ...
    ],
    'LocalSecondaryIndexes' => [
        [
            'IndexName' => '<string>', // REQUIRED
            'KeySchema' => [ // REQUIRED
                [
                    'AttributeName' => '<string>', // REQUIRED
                    'KeyType' => 'HASH|RANGE', // REQUIRED
                ],
                // ...
            ],
            'Projection' => [ // REQUIRED
                'NonKeyAttributes' => ['<string>', ...],
                'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
            ],
        ],
        // ...
    ],
    'OnDemandThroughput' => [
        'MaxReadRequestUnits' => <integer>,
        'MaxWriteRequestUnits' => <integer>,
    ],
    'ProvisionedThroughput' => [
        'ReadCapacityUnits' => <integer>, // REQUIRED
        'WriteCapacityUnits' => <integer>, // REQUIRED
    ],
    'ResourcePolicy' => '<string>',
    'SSESpecification' => [
        'Enabled' => true || false,
        'KMSMasterKeyId' => '<string>',
        'SSEType' => 'AES256|KMS',
    ],
    'StreamSpecification' => [
        'StreamEnabled' => true || false, // REQUIRED
        'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
    ],
    'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
    'TableName' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'TableDescription' => [
        'ArchivalSummary' => [
            'ArchivalBackupArn' => '<string>',
            'ArchivalDateTime' => <DateTime>,
            'ArchivalReason' => '<string>',
        ],
        'AttributeDefinitions' => [
            [
                'AttributeName' => '<string>',
                'AttributeType' => 'S|N|B',
            ],
            // ...
        ],
        'BillingModeSummary' => [
            'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
            'LastUpdateToPayPerRequestDateTime' => <DateTime>,
        ],
        'CreationDateTime' => <DateTime>,
        'DeletionProtectionEnabled' => true || false,
        'GlobalSecondaryIndexes' => [
            [
                'Backfilling' => true || false,
                'IndexArn' => '<string>',
                'IndexName' => '<string>',
                'IndexSizeBytes' => <integer>,
                'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
                'ItemCount' => <integer>,
                'KeySchema' => [
                    [
                        'AttributeName' => '<string>',
                        'KeyType' => 'HASH|RANGE',
                    ],
                    // ...
                ],
                'OnDemandThroughput' => [
                    'MaxReadRequestUnits' => <integer>,
                    'MaxWriteRequestUnits' => <integer>,
                ],
                'Projection' => [
                    'NonKeyAttributes' => ['<string>', ...],
                    'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                ],
                'ProvisionedThroughput' => [
                    'LastDecreaseDateTime' => <DateTime>,
                    'LastIncreaseDateTime' => <DateTime>,
                    'NumberOfDecreasesToday' => <integer>,
                    'ReadCapacityUnits' => <integer>,
                    'WriteCapacityUnits' => <integer>,
                ],
            ],
            // ...
        ],
        'GlobalTableVersion' => '<string>',
        'ItemCount' => <integer>,
        'KeySchema' => [
            [
                'AttributeName' => '<string>',
                'KeyType' => 'HASH|RANGE',
            ],
            // ...
        ],
        'LatestStreamArn' => '<string>',
        'LatestStreamLabel' => '<string>',
        'LocalSecondaryIndexes' => [
            [
                'IndexArn' => '<string>',
                'IndexName' => '<string>',
                'IndexSizeBytes' => <integer>,
                'ItemCount' => <integer>,
                'KeySchema' => [
                    [
                        'AttributeName' => '<string>',
                        'KeyType' => 'HASH|RANGE',
                    ],
                    // ...
                ],
                'Projection' => [
                    'NonKeyAttributes' => ['<string>', ...],
                    'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                ],
            ],
            // ...
        ],
        'OnDemandThroughput' => [
            'MaxReadRequestUnits' => <integer>,
            'MaxWriteRequestUnits' => <integer>,
        ],
        'ProvisionedThroughput' => [
            'LastDecreaseDateTime' => <DateTime>,
            'LastIncreaseDateTime' => <DateTime>,
            'NumberOfDecreasesToday' => <integer>,
            'ReadCapacityUnits' => <integer>,
            'WriteCapacityUnits' => <integer>,
        ],
        'Replicas' => [
            [
                'GlobalSecondaryIndexes' => [
                    [
                        'IndexName' => '<string>',
                        'OnDemandThroughputOverride' => [
                            'MaxReadRequestUnits' => <integer>,
                        ],
                        'ProvisionedThroughputOverride' => [
                            'ReadCapacityUnits' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'KMSMasterKeyId' => '<string>',
                'OnDemandThroughputOverride' => [
                    'MaxReadRequestUnits' => <integer>,
                ],
                'ProvisionedThroughputOverride' => [
                    'ReadCapacityUnits' => <integer>,
                ],
                'RegionName' => '<string>',
                'ReplicaInaccessibleDateTime' => <DateTime>,
                'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS',
                'ReplicaStatusDescription' => '<string>',
                'ReplicaStatusPercentProgress' => '<string>',
                'ReplicaTableClassSummary' => [
                    'LastUpdateDateTime' => <DateTime>,
                    'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
                ],
            ],
            // ...
        ],
        'RestoreSummary' => [
            'RestoreDateTime' => <DateTime>,
            'RestoreInProgress' => true || false,
            'SourceBackupArn' => '<string>',
            'SourceTableArn' => '<string>',
        ],
        'SSEDescription' => [
            'InaccessibleEncryptionDateTime' => <DateTime>,
            'KMSMasterKeyArn' => '<string>',
            'SSEType' => 'AES256|KMS',
            'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING',
        ],
        'StreamSpecification' => [
            'StreamEnabled' => true || false,
            'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
        ],
        'TableArn' => '<string>',
        'TableClassSummary' => [
            'LastUpdateDateTime' => <DateTime>,
            'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
        ],
        'TableId' => '<string>',
        'TableName' => '<string>',
        'TableSizeBytes' => <integer>,
        'TableStatus' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
    ],
]

Result Details

Errors

ResourceInUseException:

The operation conflicts with the resource's availability. For example:

• You attempted to recreate an existing table.

• You tried to delete a table currently in the CREATING state.

• You tried to update a resource that was already being updated.

When appropriate, wait for the ongoing update to complete and attempt the request again.

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

InternalServerError:

An error occurred on the server side.

Examples

Example 1: To create a table

This example creates a table named Music.

$result = $client->createTable([
    'AttributeDefinitions' => [
        [
            'AttributeName' => 'Artist',
            'AttributeType' => 'S',
        ],
        [
            'AttributeName' => 'SongTitle',
            'AttributeType' => 'S',
        ],
    ],
    'KeySchema' => [
        [
            'AttributeName' => 'Artist',
            'KeyType' => 'HASH',
        ],
        [
            'AttributeName' => 'SongTitle',
            'KeyType' => 'RANGE',
        ],
    ],
    'ProvisionedThroughput' => [
        'ReadCapacityUnits' => 5,
        'WriteCapacityUnits' => 5,
    ],
    'TableName' => 'Music',
]);

Result syntax:

[
    'TableDescription' => [
        'AttributeDefinitions' => [
            [
                'AttributeName' => 'Artist',
                'AttributeType' => 'S',
            ],
            [
                'AttributeName' => 'SongTitle',
                'AttributeType' => 'S',
            ],
        ],
        'CreationDateTime' => ,
        'ItemCount' => 0,
        'KeySchema' => [
            [
                'AttributeName' => 'Artist',
                'KeyType' => 'HASH',
            ],
            [
                'AttributeName' => 'SongTitle',
                'KeyType' => 'RANGE',
            ],
        ],
        'ProvisionedThroughput' => [
            'ReadCapacityUnits' => 5,
            'WriteCapacityUnits' => 5,
        ],
        'TableName' => 'Music',
        'TableSizeBytes' => 0,
        'TableStatus' => 'CREATING',
    ],
]

DeleteBackup

$result = $client->deleteBackup([/* ... */]);
$promise = $client->deleteBackupAsync([/* ... */]);

Deletes an existing backup of a table.

You can call DeleteBackup at a maximum rate of 10 times per second.

Parameter Syntax

$result = $client->deleteBackup([
    'BackupArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'BackupDescription' => [
        'BackupDetails' => [
            'BackupArn' => '<string>',
            'BackupCreationDateTime' => <DateTime>,
            'BackupExpiryDateTime' => <DateTime>,
            'BackupName' => '<string>',
            'BackupSizeBytes' => <integer>,
            'BackupStatus' => 'CREATING|DELETED|AVAILABLE',
            'BackupType' => 'USER|SYSTEM|AWS_BACKUP',
        ],
        'SourceTableDetails' => [
            'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
            'ItemCount' => <integer>,
            'KeySchema' => [
                [
                    'AttributeName' => '<string>',
                    'KeyType' => 'HASH|RANGE',
                ],
                // ...
            ],
            'OnDemandThroughput' => [
                'MaxReadRequestUnits' => <integer>,
                'MaxWriteRequestUnits' => <integer>,
            ],
            'ProvisionedThroughput' => [
                'ReadCapacityUnits' => <integer>,
                'WriteCapacityUnits' => <integer>,
            ],
            'TableArn' => '<string>',
            'TableCreationDateTime' => <DateTime>,
            'TableId' => '<string>',
            'TableName' => '<string>',
            'TableSizeBytes' => <integer>,
        ],
        'SourceTableFeatureDetails' => [
            'GlobalSecondaryIndexes' => [
                [
                    'IndexName' => '<string>',
                    'KeySchema' => [
                        [
                            'AttributeName' => '<string>',
                            'KeyType' => 'HASH|RANGE',
                        ],
                        // ...
                    ],
                    'OnDemandThroughput' => [
                        'MaxReadRequestUnits' => <integer>,
                        'MaxWriteRequestUnits' => <integer>,
                    ],
                    'Projection' => [
                        'NonKeyAttributes' => ['<string>', ...],
                        'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                    ],
                    'ProvisionedThroughput' => [
                        'ReadCapacityUnits' => <integer>,
                        'WriteCapacityUnits' => <integer>,
                    ],
                ],
                // ...
            ],
            'LocalSecondaryIndexes' => [
                [
                    'IndexName' => '<string>',
                    'KeySchema' => [
                        [
                            'AttributeName' => '<string>',
                            'KeyType' => 'HASH|RANGE',
                        ],
                        // ...
                    ],
                    'Projection' => [
                        'NonKeyAttributes' => ['<string>', ...],
                        'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                    ],
                ],
                // ...
            ],
            'SSEDescription' => [
                'InaccessibleEncryptionDateTime' => <DateTime>,
                'KMSMasterKeyArn' => '<string>',
                'SSEType' => 'AES256|KMS',
                'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING',
            ],
            'StreamDescription' => [
                'StreamEnabled' => true || false,
                'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
            ],
            'TimeToLiveDescription' => [
                'AttributeName' => '<string>',
                'TimeToLiveStatus' => 'ENABLING|DISABLING|ENABLED|DISABLED',
            ],
        ],
    ],
]

Result Details

Errors

BackupNotFoundException:

Backup not found for the given BackupARN.

BackupInUseException:

There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

InternalServerError:

An error occurred on the server side.

DeleteItem

$result = $client->deleteItem([/* ... */]);
$promise = $client->deleteItemAsync([/* ... */]);

Deletes a single item in a table by primary key. You can perform a conditional delete operation that deletes the item if it exists, or if it has an expected attribute value.

In addition to deleting an item, you can also return the item's attribute values in the same operation, using the ReturnValues parameter.

Unless you specify conditions, the DeleteItem is an idempotent operation; running it multiple times on the same item or attribute does not result in an error response.

Conditional deletes are useful for deleting items only if specific conditions are met. If those conditions are met, DynamoDB performs the delete. Otherwise, the item is not deleted.

Parameter Syntax

$result = $client->deleteItem([
    'ConditionExpression' => '<string>',
    'ConditionalOperator' => 'AND|OR',
    'Expected' => [
        '<AttributeName>' => [
            'AttributeValueList' => [
                [
                    'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BOOL' => true || false,
                    'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                    'L' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'M' => [
                        '<AttributeName>' => [...], // RECURSIVE
                        // ...
                    ],
                    'N' => '<string>',
                    'NS' => ['<string>', ...],
                    'NULL' => true || false,
                    'S' => '<string>',
                    'SS' => ['<string>', ...],
                ],
                // ...
            ],
            'ComparisonOperator' => 'EQ|NE|IN|LE|LT|GE|GT|BETWEEN|NOT_NULL|NULL|CONTAINS|NOT_CONTAINS|BEGINS_WITH',
            'Exists' => true || false,
            'Value' => [
                'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                'BOOL' => true || false,
                'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                'L' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'M' => [
                    '<AttributeName>' => [...], // RECURSIVE
                    // ...
                ],
                'N' => '<string>',
                'NS' => ['<string>', ...],
                'NULL' => true || false,
                'S' => '<string>',
                'SS' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'ExpressionAttributeNames' => ['<string>', ...],
    'ExpressionAttributeValues' => [
        '<ExpressionAttributeValueVariable>' => [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'Key' => [ // REQUIRED
        '<AttributeName>' => [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
    'ReturnItemCollectionMetrics' => 'SIZE|NONE',
    'ReturnValues' => 'NONE|ALL_OLD|UPDATED_OLD|ALL_NEW|UPDATED_NEW',
    'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Attributes' => [
        '<AttributeName>' => [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'ConsumedCapacity' => [
        'CapacityUnits' => <float>,
        'GlobalSecondaryIndexes' => [
            '<IndexName>' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            // ...
        ],
        'LocalSecondaryIndexes' => [
            '<IndexName>' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            // ...
        ],
        'ReadCapacityUnits' => <float>,
        'Table' => [
            'CapacityUnits' => <float>,
            'ReadCapacityUnits' => <float>,
            'WriteCapacityUnits' => <float>,
        ],
        'TableName' => '<string>',
        'WriteCapacityUnits' => <float>,
    ],
    'ItemCollectionMetrics' => [
        'ItemCollectionKey' => [
            '<AttributeName>' => [
                'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                'BOOL' => true || false,
                'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                'L' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'M' => [
                    '<AttributeName>' => [...], // RECURSIVE
                    // ...
                ],
                'N' => '<string>',
                'NS' => ['<string>', ...],
                'NULL' => true || false,
                'S' => '<string>',
                'SS' => ['<string>', ...],
            ],
            // ...
        ],
        'SizeEstimateRangeGB' => [<float>, ...],
    ],
]

Result Details

Errors

ConditionalCheckFailedException:

A condition specified in the operation could not be evaluated.

ProvisionedThroughputExceededException:

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

ItemCollectionSizeLimitExceededException:

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

TransactionConflictException:

Operation was rejected because there is an ongoing transaction for the item.

RequestLimitExceeded:

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

InternalServerError:

An error occurred on the server side.

Examples

Example 1: To delete an item

This example deletes an item from the Music table.

$result = $client->deleteItem([
    'Key' => [
        'Artist' => [
            'S' => 'No One You Know',
        ],
        'SongTitle' => [
            'S' => 'Scared of My Shadow',
        ],
    ],
    'TableName' => 'Music',
]);

Result syntax:

[
    'ConsumedCapacity' => [
        'CapacityUnits' => 1,
        'TableName' => 'Music',
    ],
]

DeleteResourcePolicy

$result = $client->deleteResourcePolicy([/* ... */]);
$promise = $client->deleteResourcePolicyAsync([/* ... */]);

Deletes the resource-based policy attached to the resource, which can be a table or stream.

DeleteResourcePolicy is an idempotent operation; running it multiple times on the same resource doesn't result in an error response, unless you specify an ExpectedRevisionId, which will then return a PolicyNotFoundException.

Parameter Syntax

$result = $client->deleteResourcePolicy([
    'ExpectedRevisionId' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RevisionId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

InternalServerError:

An error occurred on the server side.

PolicyNotFoundException:

The operation tried to access a nonexistent resource-based policy.

If you specified an ExpectedRevisionId, it's possible that a policy is present for the resource but its revision ID didn't match the expected value.

ResourceInUseException:

The operation conflicts with the resource's availability. For example:

• You attempted to recreate an existing table.

• You tried to delete a table currently in the CREATING state.

• You tried to update a resource that was already being updated.

When appropriate, wait for the ongoing update to complete and attempt the request again.

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

DeleteTable

$result = $client->deleteTable([/* ... */]);
$promise = $client->deleteTableAsync([/* ... */]);

The DeleteTable operation deletes a table and all of its items. After a DeleteTable request, the specified table is in the DELETING state until DynamoDB completes the deletion. If the table is in the ACTIVE state, you can delete it. If a table is in CREATING or UPDATING states, then DynamoDB returns a ResourceInUseException. If the specified table does not exist, DynamoDB returns a ResourceNotFoundException. If table is already in the DELETING state, no error is returned.

When you delete a table, any indexes on that table are also deleted.

If you have DynamoDB Streams enabled on the table, then the corresponding stream on that table goes into the DISABLED state, and the stream is automatically deleted after 24 hours.

Use the DescribeTable action to check the status of the table.

Parameter Syntax

$result = $client->deleteTable([
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TableDescription' => [
        'ArchivalSummary' => [
            'ArchivalBackupArn' => '<string>',
            'ArchivalDateTime' => <DateTime>,
            'ArchivalReason' => '<string>',
        ],
        'AttributeDefinitions' => [
            [
                'AttributeName' => '<string>',
                'AttributeType' => 'S|N|B',
            ],
            // ...
        ],
        'BillingModeSummary' => [
            'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
            'LastUpdateToPayPerRequestDateTime' => <DateTime>,
        ],
        'CreationDateTime' => <DateTime>,
        'DeletionProtectionEnabled' => true || false,
        'GlobalSecondaryIndexes' => [
            [
                'Backfilling' => true || false,
                'IndexArn' => '<string>',
                'IndexName' => '<string>',
                'IndexSizeBytes' => <integer>,
                'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
                'ItemCount' => <integer>,
                'KeySchema' => [
                    [
                        'AttributeName' => '<string>',
                        'KeyType' => 'HASH|RANGE',
                    ],
                    // ...
                ],
                'OnDemandThroughput' => [
                    'MaxReadRequestUnits' => <integer>,
                    'MaxWriteRequestUnits' => <integer>,
                ],
                'Projection' => [
                    'NonKeyAttributes' => ['<string>', ...],
                    'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                ],
                'ProvisionedThroughput' => [
                    'LastDecreaseDateTime' => <DateTime>,
                    'LastIncreaseDateTime' => <DateTime>,
                    'NumberOfDecreasesToday' => <integer>,
                    'ReadCapacityUnits' => <integer>,
                    'WriteCapacityUnits' => <integer>,
                ],
            ],
            // ...
        ],
        'GlobalTableVersion' => '<string>',
        'ItemCount' => <integer>,
        'KeySchema' => [
            [
                'AttributeName' => '<string>',
                'KeyType' => 'HASH|RANGE',
            ],
            // ...
        ],
        'LatestStreamArn' => '<string>',
        'LatestStreamLabel' => '<string>',
        'LocalSecondaryIndexes' => [
            [
                'IndexArn' => '<string>',
                'IndexName' => '<string>',
                'IndexSizeBytes' => <integer>,
                'ItemCount' => <integer>,
                'KeySchema' => [
                    [
                        'AttributeName' => '<string>',
                        'KeyType' => 'HASH|RANGE',
                    ],
                    // ...
                ],
                'Projection' => [
                    'NonKeyAttributes' => ['<string>', ...],
                    'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                ],
            ],
            // ...
        ],
        'OnDemandThroughput' => [
            'MaxReadRequestUnits' => <integer>,
            'MaxWriteRequestUnits' => <integer>,
        ],
        'ProvisionedThroughput' => [
            'LastDecreaseDateTime' => <DateTime>,
            'LastIncreaseDateTime' => <DateTime>,
            'NumberOfDecreasesToday' => <integer>,
            'ReadCapacityUnits' => <integer>,
            'WriteCapacityUnits' => <integer>,
        ],
        'Replicas' => [
            [
                'GlobalSecondaryIndexes' => [
                    [
                        'IndexName' => '<string>',
                        'OnDemandThroughputOverride' => [
                            'MaxReadRequestUnits' => <integer>,
                        ],
                        'ProvisionedThroughputOverride' => [
                            'ReadCapacityUnits' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'KMSMasterKeyId' => '<string>',
                'OnDemandThroughputOverride' => [
                    'MaxReadRequestUnits' => <integer>,
                ],
                'ProvisionedThroughputOverride' => [
                    'ReadCapacityUnits' => <integer>,
                ],
                'RegionName' => '<string>',
                'ReplicaInaccessibleDateTime' => <DateTime>,
                'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS',
                'ReplicaStatusDescription' => '<string>',
                'ReplicaStatusPercentProgress' => '<string>',
                'ReplicaTableClassSummary' => [
                    'LastUpdateDateTime' => <DateTime>,
                    'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
                ],
            ],
            // ...
        ],
        'RestoreSummary' => [
            'RestoreDateTime' => <DateTime>,
            'RestoreInProgress' => true || false,
            'SourceBackupArn' => '<string>',
            'SourceTableArn' => '<string>',
        ],
        'SSEDescription' => [
            'InaccessibleEncryptionDateTime' => <DateTime>,
            'KMSMasterKeyArn' => '<string>',
            'SSEType' => 'AES256|KMS',
            'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING',
        ],
        'StreamSpecification' => [
            'StreamEnabled' => true || false,
            'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
        ],
        'TableArn' => '<string>',
        'TableClassSummary' => [
            'LastUpdateDateTime' => <DateTime>,
            'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
        ],
        'TableId' => '<string>',
        'TableName' => '<string>',
        'TableSizeBytes' => <integer>,
        'TableStatus' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
    ],
]

Result Details

Errors

ResourceInUseException:

The operation conflicts with the resource's availability. For example:

• You attempted to recreate an existing table.

• You tried to delete a table currently in the CREATING state.

• You tried to update a resource that was already being updated.

When appropriate, wait for the ongoing update to complete and attempt the request again.

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

InternalServerError:

An error occurred on the server side.

Examples

Example 1: To delete a table

This example deletes the Music table.

$result = $client->deleteTable([
    'TableName' => 'Music',
]);

Result syntax:

[
    'TableDescription' => [
        'ItemCount' => 0,
        'ProvisionedThroughput' => [
            'NumberOfDecreasesToday' => 1,
            'ReadCapacityUnits' => 5,
            'WriteCapacityUnits' => 5,
        ],
        'TableName' => 'Music',
        'TableSizeBytes' => 0,
        'TableStatus' => 'DELETING',
    ],
]

DescribeBackup

$result = $client->describeBackup([/* ... */]);
$promise = $client->describeBackupAsync([/* ... */]);

Describes an existing backup of a table.

You can call DescribeBackup at a maximum rate of 10 times per second.

Parameter Syntax

$result = $client->describeBackup([
    'BackupArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'BackupDescription' => [
        'BackupDetails' => [
            'BackupArn' => '<string>',
            'BackupCreationDateTime' => <DateTime>,
            'BackupExpiryDateTime' => <DateTime>,
            'BackupName' => '<string>',
            'BackupSizeBytes' => <integer>,
            'BackupStatus' => 'CREATING|DELETED|AVAILABLE',
            'BackupType' => 'USER|SYSTEM|AWS_BACKUP',
        ],
        'SourceTableDetails' => [
            'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
            'ItemCount' => <integer>,
            'KeySchema' => [
                [
                    'AttributeName' => '<string>',
                    'KeyType' => 'HASH|RANGE',
                ],
                // ...
            ],
            'OnDemandThroughput' => [
                'MaxReadRequestUnits' => <integer>,
                'MaxWriteRequestUnits' => <integer>,
            ],
            'ProvisionedThroughput' => [
                'ReadCapacityUnits' => <integer>,
                'WriteCapacityUnits' => <integer>,
            ],
            'TableArn' => '<string>',
            'TableCreationDateTime' => <DateTime>,
            'TableId' => '<string>',
            'TableName' => '<string>',
            'TableSizeBytes' => <integer>,
        ],
        'SourceTableFeatureDetails' => [
            'GlobalSecondaryIndexes' => [
                [
                    'IndexName' => '<string>',
                    'KeySchema' => [
                        [
                            'AttributeName' => '<string>',
                            'KeyType' => 'HASH|RANGE',
                        ],
                        // ...
                    ],
                    'OnDemandThroughput' => [
                        'MaxReadRequestUnits' => <integer>,
                        'MaxWriteRequestUnits' => <integer>,
                    ],
                    'Projection' => [
                        'NonKeyAttributes' => ['<string>', ...],
                        'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                    ],
                    'ProvisionedThroughput' => [
                        'ReadCapacityUnits' => <integer>,
                        'WriteCapacityUnits' => <integer>,
                    ],
                ],
                // ...
            ],
            'LocalSecondaryIndexes' => [
                [
                    'IndexName' => '<string>',
                    'KeySchema' => [
                        [
                            'AttributeName' => '<string>',
                            'KeyType' => 'HASH|RANGE',
                        ],
                        // ...
                    ],
                    'Projection' => [
                        'NonKeyAttributes' => ['<string>', ...],
                        'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                    ],
                ],
                // ...
            ],
            'SSEDescription' => [
                'InaccessibleEncryptionDateTime' => <DateTime>,
                'KMSMasterKeyArn' => '<string>',
                'SSEType' => 'AES256|KMS',
                'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING',
            ],
            'StreamDescription' => [
                'StreamEnabled' => true || false,
                'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
            ],
            'TimeToLiveDescription' => [
                'AttributeName' => '<string>',
                'TimeToLiveStatus' => 'ENABLING|DISABLING|ENABLED|DISABLED',
            ],
        ],
    ],
]

Result Details

Errors

BackupNotFoundException:

Backup not found for the given BackupARN.

InternalServerError:

An error occurred on the server side.

DescribeContinuousBackups

$result = $client->describeContinuousBackups([/* ... */]);
$promise = $client->describeContinuousBackupsAsync([/* ... */]);

Checks the status of continuous backups and point in time recovery on the specified table. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.

After continuous backups and point in time recovery are enabled, you can restore to any point in time within EarliestRestorableDateTime and LatestRestorableDateTime.

LatestRestorableDateTime is typically 5 minutes before the current time. You can restore your table to any point in time during the last 35 days.

You can call DescribeContinuousBackups at a maximum rate of 10 times per second.

Parameter Syntax

$result = $client->describeContinuousBackups([
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContinuousBackupsDescription' => [
        'ContinuousBackupsStatus' => 'ENABLED|DISABLED',
        'PointInTimeRecoveryDescription' => [
            'EarliestRestorableDateTime' => <DateTime>,
            'LatestRestorableDateTime' => <DateTime>,
            'PointInTimeRecoveryStatus' => 'ENABLED|DISABLED',
        ],
    ],
]

Result Details

Errors

TableNotFoundException:

A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

InternalServerError:

An error occurred on the server side.

DescribeContributorInsights

$result = $client->describeContributorInsights([/* ... */]);
$promise = $client->describeContributorInsightsAsync([/* ... */]);

Returns information about contributor insights for a given table or global secondary index.

Parameter Syntax

$result = $client->describeContributorInsights([
    'IndexName' => '<string>',
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ContributorInsightsRuleList' => ['<string>', ...],
    'ContributorInsightsStatus' => 'ENABLING|ENABLED|DISABLING|DISABLED|FAILED',
    'FailureException' => [
        'ExceptionDescription' => '<string>',
        'ExceptionName' => '<string>',
    ],
    'IndexName' => '<string>',
    'LastUpdateDateTime' => <DateTime>,
    'TableName' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

InternalServerError:

An error occurred on the server side.

DescribeEndpoints

$result = $client->describeEndpoints([/* ... */]);
$promise = $client->describeEndpointsAsync([/* ... */]);

Returns the regional endpoint information. For more information on policy permissions, please see Internetwork traffic privacy.

Parameter Syntax

$result = $client->describeEndpoints([
]);

Parameter Details

Result Syntax

[
    'Endpoints' => [
        [
            'Address' => '<string>',
            'CachePeriodInMinutes' => <integer>,
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

DescribeExport

$result = $client->describeExport([/* ... */]);
$promise = $client->describeExportAsync([/* ... */]);

Describes an existing table export.

Parameter Syntax

$result = $client->describeExport([
    'ExportArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ExportDescription' => [
        'BilledSizeBytes' => <integer>,
        'ClientToken' => '<string>',
        'EndTime' => <DateTime>,
        'ExportArn' => '<string>',
        'ExportFormat' => 'DYNAMODB_JSON|ION',
        'ExportManifest' => '<string>',
        'ExportStatus' => 'IN_PROGRESS|COMPLETED|FAILED',
        'ExportTime' => <DateTime>,
        'ExportType' => 'FULL_EXPORT|INCREMENTAL_EXPORT',
        'FailureCode' => '<string>',
        'FailureMessage' => '<string>',
        'IncrementalExportSpecification' => [
            'ExportFromTime' => <DateTime>,
            'ExportToTime' => <DateTime>,
            'ExportViewType' => 'NEW_IMAGE|NEW_AND_OLD_IMAGES',
        ],
        'ItemCount' => <integer>,
        'S3Bucket' => '<string>',
        'S3BucketOwner' => '<string>',
        'S3Prefix' => '<string>',
        'S3SseAlgorithm' => 'AES256|KMS',
        'S3SseKmsKeyId' => '<string>',
        'StartTime' => <DateTime>,
        'TableArn' => '<string>',
        'TableId' => '<string>',
    ],
]

Result Details

Errors

ExportNotFoundException:

The specified export was not found.

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

InternalServerError:

An error occurred on the server side.

DescribeGlobalTable

$result = $client->describeGlobalTable([/* ... */]);
$promise = $client->describeGlobalTableAsync([/* ... */]);

Returns information about the specified global table.

Parameter Syntax

$result = $client->describeGlobalTable([
    'GlobalTableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GlobalTableDescription' => [
        'CreationDateTime' => <DateTime>,
        'GlobalTableArn' => '<string>',
        'GlobalTableName' => '<string>',
        'GlobalTableStatus' => 'CREATING|ACTIVE|DELETING|UPDATING',
        'ReplicationGroup' => [
            [
                'GlobalSecondaryIndexes' => [
                    [
                        'IndexName' => '<string>',
                        'OnDemandThroughputOverride' => [
                            'MaxReadRequestUnits' => <integer>,
                        ],
                        'ProvisionedThroughputOverride' => [
                            'ReadCapacityUnits' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'KMSMasterKeyId' => '<string>',
                'OnDemandThroughputOverride' => [
                    'MaxReadRequestUnits' => <integer>,
                ],
                'ProvisionedThroughputOverride' => [
                    'ReadCapacityUnits' => <integer>,
                ],
                'RegionName' => '<string>',
                'ReplicaInaccessibleDateTime' => <DateTime>,
                'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS',
                'ReplicaStatusDescription' => '<string>',
                'ReplicaStatusPercentProgress' => '<string>',
                'ReplicaTableClassSummary' => [
                    'LastUpdateDateTime' => <DateTime>,
                    'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Errors

InternalServerError:

An error occurred on the server side.

GlobalTableNotFoundException:

The specified global table does not exist.

DescribeGlobalTableSettings

$result = $client->describeGlobalTableSettings([/* ... */]);
$promise = $client->describeGlobalTableSettingsAsync([/* ... */]);

Describes Region-specific settings for a global table.

Parameter Syntax

$result = $client->describeGlobalTableSettings([
    'GlobalTableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'GlobalTableName' => '<string>',
    'ReplicaSettings' => [
        [
            'RegionName' => '<string>',
            'ReplicaBillingModeSummary' => [
                'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
                'LastUpdateToPayPerRequestDateTime' => <DateTime>,
            ],
            'ReplicaGlobalSecondaryIndexSettings' => [
                [
                    'IndexName' => '<string>',
                    'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
                    'ProvisionedReadCapacityAutoScalingSettings' => [
                        'AutoScalingDisabled' => true || false,
                        'AutoScalingRoleArn' => '<string>',
                        'MaximumUnits' => <integer>,
                        'MinimumUnits' => <integer>,
                        'ScalingPolicies' => [
                            [
                                'PolicyName' => '<string>',
                                'TargetTrackingScalingPolicyConfiguration' => [
                                    'DisableScaleIn' => true || false,
                                    'ScaleInCooldown' => <integer>,
                                    'ScaleOutCooldown' => <integer>,
                                    'TargetValue' => <float>,
                                ],
                            ],
                            // ...
                        ],
                    ],
                    'ProvisionedReadCapacityUnits' => <integer>,
                    'ProvisionedWriteCapacityAutoScalingSettings' => [
                        'AutoScalingDisabled' => true || false,
                        'AutoScalingRoleArn' => '<string>',
                        'MaximumUnits' => <integer>,
                        'MinimumUnits' => <integer>,
                        'ScalingPolicies' => [
                            [
                                'PolicyName' => '<string>',
                                'TargetTrackingScalingPolicyConfiguration' => [
                                    'DisableScaleIn' => true || false,
                                    'ScaleInCooldown' => <integer>,
                                    'ScaleOutCooldown' => <integer>,
                                    'TargetValue' => <float>,
                                ],
                            ],
                            // ...
                        ],
                    ],
                    'ProvisionedWriteCapacityUnits' => <integer>,
                ],
                // ...
            ],
            'ReplicaProvisionedReadCapacityAutoScalingSettings' => [
                'AutoScalingDisabled' => true || false,
                'AutoScalingRoleArn' => '<string>',
                'MaximumUnits' => <integer>,
                'MinimumUnits' => <integer>,
                'ScalingPolicies' => [
                    [
                        'PolicyName' => '<string>',
                        'TargetTrackingScalingPolicyConfiguration' => [
                            'DisableScaleIn' => true || false,
                            'ScaleInCooldown' => <integer>,
                            'ScaleOutCooldown' => <integer>,
                            'TargetValue' => <float>,
                        ],
                    ],
                    // ...
                ],
            ],
            'ReplicaProvisionedReadCapacityUnits' => <integer>,
            'ReplicaProvisionedWriteCapacityAutoScalingSettings' => [
                'AutoScalingDisabled' => true || false,
                'AutoScalingRoleArn' => '<string>',
                'MaximumUnits' => <integer>,
                'MinimumUnits' => <integer>,
                'ScalingPolicies' => [
                    [
                        'PolicyName' => '<string>',
                        'TargetTrackingScalingPolicyConfiguration' => [
                            'DisableScaleIn' => true || false,
                            'ScaleInCooldown' => <integer>,
                            'ScaleOutCooldown' => <integer>,
                            'TargetValue' => <float>,
                        ],
                    ],
                    // ...
                ],
            ],
            'ReplicaProvisionedWriteCapacityUnits' => <integer>,
            'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS',
            'ReplicaTableClassSummary' => [
                'LastUpdateDateTime' => <DateTime>,
                'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

GlobalTableNotFoundException:

The specified global table does not exist.

InternalServerError:

An error occurred on the server side.

DescribeImport

$result = $client->describeImport([/* ... */]);
$promise = $client->describeImportAsync([/* ... */]);

Represents the properties of the import.

Parameter Syntax

$result = $client->describeImport([
    'ImportArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ImportTableDescription' => [
        'ClientToken' => '<string>',
        'CloudWatchLogGroupArn' => '<string>',
        'EndTime' => <DateTime>,
        'ErrorCount' => <integer>,
        'FailureCode' => '<string>',
        'FailureMessage' => '<string>',
        'ImportArn' => '<string>',
        'ImportStatus' => 'IN_PROGRESS|COMPLETED|CANCELLING|CANCELLED|FAILED',
        'ImportedItemCount' => <integer>,
        'InputCompressionType' => 'GZIP|ZSTD|NONE',
        'InputFormat' => 'DYNAMODB_JSON|ION|CSV',
        'InputFormatOptions' => [
            'Csv' => [
                'Delimiter' => '<string>',
                'HeaderList' => ['<string>', ...],
            ],
        ],
        'ProcessedItemCount' => <integer>,
        'ProcessedSizeBytes' => <integer>,
        'S3BucketSource' => [
            'S3Bucket' => '<string>',
            'S3BucketOwner' => '<string>',
            'S3KeyPrefix' => '<string>',
        ],
        'StartTime' => <DateTime>,
        'TableArn' => '<string>',
        'TableCreationParameters' => [
            'AttributeDefinitions' => [
                [
                    'AttributeName' => '<string>',
                    'AttributeType' => 'S|N|B',
                ],
                // ...
            ],
            'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
            'GlobalSecondaryIndexes' => [
                [
                    'IndexName' => '<string>',
                    'KeySchema' => [
                        [
                            'AttributeName' => '<string>',
                            'KeyType' => 'HASH|RANGE',
                        ],
                        // ...
                    ],
                    'OnDemandThroughput' => [
                        'MaxReadRequestUnits' => <integer>,
                        'MaxWriteRequestUnits' => <integer>,
                    ],
                    'Projection' => [
                        'NonKeyAttributes' => ['<string>', ...],
                        'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                    ],
                    'ProvisionedThroughput' => [
                        'ReadCapacityUnits' => <integer>,
                        'WriteCapacityUnits' => <integer>,
                    ],
                ],
                // ...
            ],
            'KeySchema' => [
                [
                    'AttributeName' => '<string>',
                    'KeyType' => 'HASH|RANGE',
                ],
                // ...
            ],
            'OnDemandThroughput' => [
                'MaxReadRequestUnits' => <integer>,
                'MaxWriteRequestUnits' => <integer>,
            ],
            'ProvisionedThroughput' => [
                'ReadCapacityUnits' => <integer>,
                'WriteCapacityUnits' => <integer>,
            ],
            'SSESpecification' => [
                'Enabled' => true || false,
                'KMSMasterKeyId' => '<string>',
                'SSEType' => 'AES256|KMS',
            ],
            'TableName' => '<string>',
        ],
        'TableId' => '<string>',
    ],
]

Result Details

Errors

ImportNotFoundException:

The specified import was not found.

DescribeKinesisStreamingDestination

$result = $client->describeKinesisStreamingDestination([/* ... */]);
$promise = $client->describeKinesisStreamingDestinationAsync([/* ... */]);

Returns information about the status of Kinesis streaming.

Parameter Syntax

$result = $client->describeKinesisStreamingDestination([
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'KinesisDataStreamDestinations' => [
        [
            'ApproximateCreationDateTimePrecision' => 'MILLISECOND|MICROSECOND',
            'DestinationStatus' => 'ENABLING|ACTIVE|DISABLING|DISABLED|ENABLE_FAILED|UPDATING',
            'DestinationStatusDescription' => '<string>',
            'StreamArn' => '<string>',
        ],
        // ...
    ],
    'TableName' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

InternalServerError:

An error occurred on the server side.

DescribeLimits

$result = $client->describeLimits([/* ... */]);
$promise = $client->describeLimitsAsync([/* ... */]);

Returns the current provisioned-capacity quotas for your Amazon Web Services account in a Region, both for the Region as a whole and for any one DynamoDB table that you create there.

When you establish an Amazon Web Services account, the account has initial quotas on the maximum read capacity units and write capacity units that you can provision across all of your DynamoDB tables in a given Region. Also, there are per-table quotas that apply when you create a table there. For more information, see Service, Account, and Table Quotas page in the Amazon DynamoDB Developer Guide.

Although you can increase these quotas by filing a case at Amazon Web Services Support Center, obtaining the increase is not instantaneous. The DescribeLimits action lets you write code to compare the capacity you are currently using to those quotas imposed by your account so that you have enough time to apply for an increase before you hit a quota.

For example, you could use one of the Amazon Web Services SDKs to do the following:

1. Call DescribeLimits for a particular Region to obtain your current account quotas on provisioned capacity there.

2. Create a variable to hold the aggregate read capacity units provisioned for all your tables in that Region, and one to hold the aggregate write capacity units. Zero them both.

3. Call ListTables to obtain a list of all your DynamoDB tables.

4. For each table name listed by ListTables, do the following:

   • Call DescribeTable with the table name.

   • Use the data returned by DescribeTable to add the read capacity units and write capacity units provisioned for the table itself to your variables.

   • If the table has one or more global secondary indexes (GSIs), loop over these GSIs and add their provisioned capacity values to your variables as well.

5. Report the account quotas for that Region returned by DescribeLimits, along with the total current provisioned capacity levels you have calculated.

This will let you see whether you are getting close to your account-level quotas.

The per-table quotas apply only when you are creating a new table. They restrict the sum of the provisioned capacity of the new table itself and all its global secondary indexes.

For existing tables and their GSIs, DynamoDB doesn't let you increase provisioned capacity extremely rapidly, but the only quota that applies is that the aggregate provisioned capacity over all your tables and GSIs cannot exceed either of the per-account quotas.

The DescribeLimits Request element has no content.

Parameter Syntax

$result = $client->describeLimits([
]);

Parameter Details

Result Syntax

[
    'AccountMaxReadCapacityUnits' => <integer>,
    'AccountMaxWriteCapacityUnits' => <integer>,
    'TableMaxReadCapacityUnits' => <integer>,
    'TableMaxWriteCapacityUnits' => <integer>,
]

Result Details

Errors

InternalServerError:

An error occurred on the server side.

Examples

Example 1: To determine capacity limits per table and account, in the current AWS region

The following example returns the maximum read and write capacity units per table, and for the AWS account, in the current AWS region.

$result = $client->describeLimits([
]);

Result syntax:

[
    'AccountMaxReadCapacityUnits' => 20000,
    'AccountMaxWriteCapacityUnits' => 20000,
    'TableMaxReadCapacityUnits' => 10000,
    'TableMaxWriteCapacityUnits' => 10000,
]

DescribeTable

$result = $client->describeTable([/* ... */]);
$promise = $client->describeTableAsync([/* ... */]);

Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.

Parameter Syntax

$result = $client->describeTable([
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Table' => [
        'ArchivalSummary' => [
            'ArchivalBackupArn' => '<string>',
            'ArchivalDateTime' => <DateTime>,
            'ArchivalReason' => '<string>',
        ],
        'AttributeDefinitions' => [
            [
                'AttributeName' => '<string>',
                'AttributeType' => 'S|N|B',
            ],
            // ...
        ],
        'BillingModeSummary' => [
            'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
            'LastUpdateToPayPerRequestDateTime' => <DateTime>,
        ],
        'CreationDateTime' => <DateTime>,
        'DeletionProtectionEnabled' => true || false,
        'GlobalSecondaryIndexes' => [
            [
                'Backfilling' => true || false,
                'IndexArn' => '<string>',
                'IndexName' => '<string>',
                'IndexSizeBytes' => <integer>,
                'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
                'ItemCount' => <integer>,
                'KeySchema' => [
                    [
                        'AttributeName' => '<string>',
                        'KeyType' => 'HASH|RANGE',
                    ],
                    // ...
                ],
                'OnDemandThroughput' => [
                    'MaxReadRequestUnits' => <integer>,
                    'MaxWriteRequestUnits' => <integer>,
                ],
                'Projection' => [
                    'NonKeyAttributes' => ['<string>', ...],
                    'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                ],
                'ProvisionedThroughput' => [
                    'LastDecreaseDateTime' => <DateTime>,
                    'LastIncreaseDateTime' => <DateTime>,
                    'NumberOfDecreasesToday' => <integer>,
                    'ReadCapacityUnits' => <integer>,
                    'WriteCapacityUnits' => <integer>,
                ],
            ],
            // ...
        ],
        'GlobalTableVersion' => '<string>',
        'ItemCount' => <integer>,
        'KeySchema' => [
            [
                'AttributeName' => '<string>',
                'KeyType' => 'HASH|RANGE',
            ],
            // ...
        ],
        'LatestStreamArn' => '<string>',
        'LatestStreamLabel' => '<string>',
        'LocalSecondaryIndexes' => [
            [
                'IndexArn' => '<string>',
                'IndexName' => '<string>',
                'IndexSizeBytes' => <integer>,
                'ItemCount' => <integer>,
                'KeySchema' => [
                    [
                        'AttributeName' => '<string>',
                        'KeyType' => 'HASH|RANGE',
                    ],
                    // ...
                ],
                'Projection' => [
                    'NonKeyAttributes' => ['<string>', ...],
                    'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                ],
            ],
            // ...
        ],
        'OnDemandThroughput' => [
            'MaxReadRequestUnits' => <integer>,
            'MaxWriteRequestUnits' => <integer>,
        ],
        'ProvisionedThroughput' => [
            'LastDecreaseDateTime' => <DateTime>,
            'LastIncreaseDateTime' => <DateTime>,
            'NumberOfDecreasesToday' => <integer>,
            'ReadCapacityUnits' => <integer>,
            'WriteCapacityUnits' => <integer>,
        ],
        'Replicas' => [
            [
                'GlobalSecondaryIndexes' => [
                    [
                        'IndexName' => '<string>',
                        'OnDemandThroughputOverride' => [
                            'MaxReadRequestUnits' => <integer>,
                        ],
                        'ProvisionedThroughputOverride' => [
                            'ReadCapacityUnits' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'KMSMasterKeyId' => '<string>',
                'OnDemandThroughputOverride' => [
                    'MaxReadRequestUnits' => <integer>,
                ],
                'ProvisionedThroughputOverride' => [
                    'ReadCapacityUnits' => <integer>,
                ],
                'RegionName' => '<string>',
                'ReplicaInaccessibleDateTime' => <DateTime>,
                'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS',
                'ReplicaStatusDescription' => '<string>',
                'ReplicaStatusPercentProgress' => '<string>',
                'ReplicaTableClassSummary' => [
                    'LastUpdateDateTime' => <DateTime>,
                    'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
                ],
            ],
            // ...
        ],
        'RestoreSummary' => [
            'RestoreDateTime' => <DateTime>,
            'RestoreInProgress' => true || false,
            'SourceBackupArn' => '<string>',
            'SourceTableArn' => '<string>',
        ],
        'SSEDescription' => [
            'InaccessibleEncryptionDateTime' => <DateTime>,
            'KMSMasterKeyArn' => '<string>',
            'SSEType' => 'AES256|KMS',
            'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING',
        ],
        'StreamSpecification' => [
            'StreamEnabled' => true || false,
            'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
        ],
        'TableArn' => '<string>',
        'TableClassSummary' => [
            'LastUpdateDateTime' => <DateTime>,
            'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
        ],
        'TableId' => '<string>',
        'TableName' => '<string>',
        'TableSizeBytes' => <integer>,
        'TableStatus' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

InternalServerError:

An error occurred on the server side.

Examples

Example 1: To describe a table

This example describes the Music table.

$result = $client->describeTable([
    'TableName' => 'Music',
]);

Result syntax:

[
    'Table' => [
        'AttributeDefinitions' => [
            [
                'AttributeName' => 'Artist',
                'AttributeType' => 'S',
            ],
            [
                'AttributeName' => 'SongTitle',
                'AttributeType' => 'S',
            ],
        ],
        'CreationDateTime' => ,
        'ItemCount' => 0,
        'KeySchema' => [
            [
                'AttributeName' => 'Artist',
                'KeyType' => 'HASH',
            ],
            [
                'AttributeName' => 'SongTitle',
                'KeyType' => 'RANGE',
            ],
        ],
        'ProvisionedThroughput' => [
            'NumberOfDecreasesToday' => 1,
            'ReadCapacityUnits' => 5,
            'WriteCapacityUnits' => 5,
        ],
        'TableName' => 'Music',
        'TableSizeBytes' => 0,
        'TableStatus' => 'ACTIVE',
    ],
]

DescribeTableReplicaAutoScaling

$result = $client->describeTableReplicaAutoScaling([/* ... */]);
$promise = $client->describeTableReplicaAutoScalingAsync([/* ... */]);

Describes auto scaling settings across replicas of the global table at once.

Parameter Syntax

$result = $client->describeTableReplicaAutoScaling([
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TableAutoScalingDescription' => [
        'Replicas' => [
            [
                'GlobalSecondaryIndexes' => [
                    [
                        'IndexName' => '<string>',
                        'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
                        'ProvisionedReadCapacityAutoScalingSettings' => [
                            'AutoScalingDisabled' => true || false,
                            'AutoScalingRoleArn' => '<string>',
                            'MaximumUnits' => <integer>,
                            'MinimumUnits' => <integer>,
                            'ScalingPolicies' => [
                                [
                                    'PolicyName' => '<string>',
                                    'TargetTrackingScalingPolicyConfiguration' => [
                                        'DisableScaleIn' => true || false,
                                        'ScaleInCooldown' => <integer>,
                                        'ScaleOutCooldown' => <integer>,
                                        'TargetValue' => <float>,
                                    ],
                                ],
                                // ...
                            ],
                        ],
                        'ProvisionedWriteCapacityAutoScalingSettings' => [
                            'AutoScalingDisabled' => true || false,
                            'AutoScalingRoleArn' => '<string>',
                            'MaximumUnits' => <integer>,
                            'MinimumUnits' => <integer>,
                            'ScalingPolicies' => [
                                [
                                    'PolicyName' => '<string>',
                                    'TargetTrackingScalingPolicyConfiguration' => [
                                        'DisableScaleIn' => true || false,
                                        'ScaleInCooldown' => <integer>,
                                        'ScaleOutCooldown' => <integer>,
                                        'TargetValue' => <float>,
                                    ],
                                ],
                                // ...
                            ],
                        ],
                    ],
                    // ...
                ],
                'RegionName' => '<string>',
                'ReplicaProvisionedReadCapacityAutoScalingSettings' => [
                    'AutoScalingDisabled' => true || false,
                    'AutoScalingRoleArn' => '<string>',
                    'MaximumUnits' => <integer>,
                    'MinimumUnits' => <integer>,
                    'ScalingPolicies' => [
                        [
                            'PolicyName' => '<string>',
                            'TargetTrackingScalingPolicyConfiguration' => [
                                'DisableScaleIn' => true || false,
                                'ScaleInCooldown' => <integer>,
                                'ScaleOutCooldown' => <integer>,
                                'TargetValue' => <float>,
                            ],
                        ],
                        // ...
                    ],
                ],
                'ReplicaProvisionedWriteCapacityAutoScalingSettings' => [
                    'AutoScalingDisabled' => true || false,
                    'AutoScalingRoleArn' => '<string>',
                    'MaximumUnits' => <integer>,
                    'MinimumUnits' => <integer>,
                    'ScalingPolicies' => [
                        [
                            'PolicyName' => '<string>',
                            'TargetTrackingScalingPolicyConfiguration' => [
                                'DisableScaleIn' => true || false,
                                'ScaleInCooldown' => <integer>,
                                'ScaleOutCooldown' => <integer>,
                                'TargetValue' => <float>,
                            ],
                        ],
                        // ...
                    ],
                ],
                'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS',
            ],
            // ...
        ],
        'TableName' => '<string>',
        'TableStatus' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

InternalServerError:

An error occurred on the server side.

DescribeTimeToLive

$result = $client->describeTimeToLive([/* ... */]);
$promise = $client->describeTimeToLiveAsync([/* ... */]);

Gives a description of the Time to Live (TTL) status on the specified table.

Parameter Syntax

$result = $client->describeTimeToLive([
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TimeToLiveDescription' => [
        'AttributeName' => '<string>',
        'TimeToLiveStatus' => 'ENABLING|DISABLING|ENABLED|DISABLED',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

InternalServerError:

An error occurred on the server side.

DisableKinesisStreamingDestination

$result = $client->disableKinesisStreamingDestination([/* ... */]);
$promise = $client->disableKinesisStreamingDestinationAsync([/* ... */]);

Stops replication from the DynamoDB table to the Kinesis data stream. This is done without deleting either of the resources.

Parameter Syntax

$result = $client->disableKinesisStreamingDestination([
    'EnableKinesisStreamingConfiguration' => [
        'ApproximateCreationDateTimePrecision' => 'MILLISECOND|MICROSECOND',
    ],
    'StreamArn' => '<string>', // REQUIRED
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DestinationStatus' => 'ENABLING|ACTIVE|DISABLING|DISABLED|ENABLE_FAILED|UPDATING',
    'EnableKinesisStreamingConfiguration' => [
        'ApproximateCreationDateTimePrecision' => 'MILLISECOND|MICROSECOND',
    ],
    'StreamArn' => '<string>',
    'TableName' => '<string>',
]

Result Details

Errors

InternalServerError:

An error occurred on the server side.

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

ResourceInUseException:

The operation conflicts with the resource's availability. For example:

• You attempted to recreate an existing table.

• You tried to delete a table currently in the CREATING state.

• You tried to update a resource that was already being updated.

When appropriate, wait for the ongoing update to complete and attempt the request again.

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

EnableKinesisStreamingDestination

$result = $client->enableKinesisStreamingDestination([/* ... */]);
$promise = $client->enableKinesisStreamingDestinationAsync([/* ... */]);

Starts table data replication to the specified Kinesis data stream at a timestamp chosen during the enable workflow. If this operation doesn't return results immediately, use DescribeKinesisStreamingDestination to check if streaming to the Kinesis data stream is ACTIVE.

Parameter Syntax

$result = $client->enableKinesisStreamingDestination([
    'EnableKinesisStreamingConfiguration' => [
        'ApproximateCreationDateTimePrecision' => 'MILLISECOND|MICROSECOND',
    ],
    'StreamArn' => '<string>', // REQUIRED
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DestinationStatus' => 'ENABLING|ACTIVE|DISABLING|DISABLED|ENABLE_FAILED|UPDATING',
    'EnableKinesisStreamingConfiguration' => [
        'ApproximateCreationDateTimePrecision' => 'MILLISECOND|MICROSECOND',
    ],
    'StreamArn' => '<string>',
    'TableName' => '<string>',
]

Result Details

Errors

InternalServerError:

An error occurred on the server side.

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

ResourceInUseException:

The operation conflicts with the resource's availability. For example:

• You attempted to recreate an existing table.

• You tried to delete a table currently in the CREATING state.

• You tried to update a resource that was already being updated.

When appropriate, wait for the ongoing update to complete and attempt the request again.

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

ExecuteStatement

$result = $client->executeStatement([/* ... */]);
$promise = $client->executeStatementAsync([/* ... */]);

This operation allows you to perform reads and singleton writes on data stored in DynamoDB, using PartiQL.

For PartiQL reads (SELECT statement), if the total number of processed items exceeds the maximum dataset size limit of 1 MB, the read stops and results are returned to the user as a LastEvaluatedKey value to continue the read in a subsequent operation. If the filter criteria in WHERE clause does not match any data, the read will return an empty result set.

A single SELECT statement response can return up to the maximum number of items (if using the Limit parameter) or a maximum of 1 MB of data (and then apply any filtering to the results using WHERE clause). If LastEvaluatedKey is present in the response, you need to paginate the result set. If NextToken is present, you need to paginate the result set and include NextToken.

Parameter Syntax

$result = $client->executeStatement([
    'ConsistentRead' => true || false,
    'Limit' => <integer>,
    'NextToken' => '<string>',
    'Parameters' => [
        [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
    'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
    'Statement' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ConsumedCapacity' => [
        'CapacityUnits' => <float>,
        'GlobalSecondaryIndexes' => [
            '<IndexName>' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            // ...
        ],
        'LocalSecondaryIndexes' => [
            '<IndexName>' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            // ...
        ],
        'ReadCapacityUnits' => <float>,
        'Table' => [
            'CapacityUnits' => <float>,
            'ReadCapacityUnits' => <float>,
            'WriteCapacityUnits' => <float>,
        ],
        'TableName' => '<string>',
        'WriteCapacityUnits' => <float>,
    ],
    'Items' => [
        [
            '<AttributeName>' => [
                'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                'BOOL' => true || false,
                'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                'L' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'M' => [
                    '<AttributeName>' => [...], // RECURSIVE
                    // ...
                ],
                'N' => '<string>',
                'NS' => ['<string>', ...],
                'NULL' => true || false,
                'S' => '<string>',
                'SS' => ['<string>', ...],
            ],
            // ...
        ],
        // ...
    ],
    'LastEvaluatedKey' => [
        '<AttributeName>' => [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ConditionalCheckFailedException:

A condition specified in the operation could not be evaluated.

ProvisionedThroughputExceededException:

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

ItemCollectionSizeLimitExceededException:

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

TransactionConflictException:

Operation was rejected because there is an ongoing transaction for the item.

RequestLimitExceeded:

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

InternalServerError:

An error occurred on the server side.

DuplicateItemException:

There was an attempt to insert an item with the same primary key as an item that already exists in the DynamoDB table.

ExecuteTransaction

$result = $client->executeTransaction([/* ... */]);
$promise = $client->executeTransactionAsync([/* ... */]);

This operation allows you to perform transactional reads or writes on data stored in DynamoDB, using PartiQL.

Parameter Syntax

$result = $client->executeTransaction([
    'ClientRequestToken' => '<string>',
    'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
    'TransactStatements' => [ // REQUIRED
        [
            'Parameters' => [
                [
                    'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BOOL' => true || false,
                    'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                    'L' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'M' => [
                        '<AttributeName>' => [...], // RECURSIVE
                        // ...
                    ],
                    'N' => '<string>',
                    'NS' => ['<string>', ...],
                    'NULL' => true || false,
                    'S' => '<string>',
                    'SS' => ['<string>', ...],
                ],
                // ...
            ],
            'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
            'Statement' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[
    'ConsumedCapacity' => [
        [
            'CapacityUnits' => <float>,
            'GlobalSecondaryIndexes' => [
                '<IndexName>' => [
                    'CapacityUnits' => <float>,
                    'ReadCapacityUnits' => <float>,
                    'WriteCapacityUnits' => <float>,
                ],
                // ...
            ],
            'LocalSecondaryIndexes' => [
                '<IndexName>' => [
                    'CapacityUnits' => <float>,
                    'ReadCapacityUnits' => <float>,
                    'WriteCapacityUnits' => <float>,
                ],
                // ...
            ],
            'ReadCapacityUnits' => <float>,
            'Table' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            'TableName' => '<string>',
            'WriteCapacityUnits' => <float>,
        ],
        // ...
    ],
    'Responses' => [
        [
            'Item' => [
                '<AttributeName>' => [
                    'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BOOL' => true || false,
                    'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                    'L' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'M' => [
                        '<AttributeName>' => [...], // RECURSIVE
                        // ...
                    ],
                    'N' => '<string>',
                    'NS' => ['<string>', ...],
                    'NULL' => true || false,
                    'S' => '<string>',
                    'SS' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

TransactionCanceledException:

The entire transaction request was canceled.

DynamoDB cancels a TransactWriteItems request under the following circumstances:

• A condition in one of the condition expressions is not met.

• A table in the TransactWriteItems request is in a different account or region.

• More than one action in the TransactWriteItems operation targets the same item.

• There is insufficient provisioned capacity for the transaction to be completed.

• An item size becomes too large (larger than 400 KB), or a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.

• There is a user error, such as an invalid data format.

• There is an ongoing TransactWriteItems operation that conflicts with a concurrent TransactWriteItems request. In this case the TransactWriteItems operation fails with a TransactionCanceledException.

DynamoDB cancels a TransactGetItems request under the following circumstances:

• There is an ongoing TransactGetItems operation that conflicts with a concurrent PutItem, UpdateItem, DeleteItem or TransactWriteItems request. In this case the TransactGetItems operation fails with a TransactionCanceledException.

• A table in the TransactGetItems request is in a different account or region.

• There is insufficient provisioned capacity for the transaction to be completed.

• There is a user error, such as an invalid data format.

If using Java, DynamoDB lists the cancellation reasons on the CancellationReasons property. This property is not set for other languages. Transaction cancellation reasons are ordered in the order of requested items, if an item has no error it will have None code and Null message.

Cancellation reason codes and possible error messages:

• No Errors:

  • Code: None

  • Message: null

• Conditional Check Failed:

  • Code: ConditionalCheckFailed

  • Message: The conditional request failed.

• Item Collection Size Limit Exceeded:

  • Code: ItemCollectionSizeLimitExceeded

  • Message: Collection size exceeded.

• Transaction Conflict:

  • Code: TransactionConflict

  • Message: Transaction is ongoing for the item.

• Provisioned Throughput Exceeded:

  • Code: ProvisionedThroughputExceeded

  • Messages:

    • The level of configured provisioned throughput for the table was exceeded. Consider increasing your provisioning level with the UpdateTable API.

      This Message is received when provisioned throughput is exceeded is on a provisioned DynamoDB table.

    • The level of configured provisioned throughput for one or more global secondary indexes of the table was exceeded. Consider increasing your provisioning level for the under-provisioned global secondary indexes with the UpdateTable API.

      This message is returned when provisioned throughput is exceeded is on a provisioned GSI.

• Throttling Error:

  • Code: ThrottlingError

  • Messages:

    • Throughput exceeds the current capacity of your table or index. DynamoDB is automatically scaling your table or index so please try again shortly. If exceptions persist, check if you have a hot key: https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/bp-partition-key-design.html.

      This message is returned when writes get throttled on an On-Demand table as DynamoDB is automatically scaling the table.

    • Throughput exceeds the current capacity for one or more global secondary indexes. DynamoDB is automatically scaling your index so please try again shortly.

      This message is returned when writes get throttled on an On-Demand GSI as DynamoDB is automatically scaling the GSI.

• Validation Error:

  • Code: ValidationError

  • Messages:

    • One or more parameter values were invalid.

    • The update expression attempted to update the secondary index key beyond allowed size limits.

    • The update expression attempted to update the secondary index key to unsupported type.

    • An operand in the update expression has an incorrect data type.

    • Item size to update has exceeded the maximum allowed size.

    • Number overflow. Attempting to store a number with magnitude larger than supported range.

    • Type mismatch for attribute to update.

    • Nesting Levels have exceeded supported limits.

    • The document path provided in the update expression is invalid for update.

    • The provided expression refers to an attribute that does not exist in the item.

TransactionInProgressException:

The transaction with the given request token is already in progress.

Recommended Settings

This is a general recommendation for handling the TransactionInProgressException. These settings help ensure that the client retries will trigger completion of the ongoing TransactWriteItems request.

• Set clientExecutionTimeout to a value that allows at least one retry to be processed after 5 seconds have elapsed since the first attempt for the TransactWriteItems operation.

• Set socketTimeout to a value a little lower than the requestTimeout setting.

• requestTimeout should be set based on the time taken for the individual retries of a single HTTP request for your use case, but setting it to 1 second or higher should work well to reduce chances of retries and TransactionInProgressException errors.

• Use exponential backoff when retrying and tune backoff if needed.

Assuming default retry policy, example timeout settings based on the guidelines above are as follows:

Example timeline:

• 0-1000 first attempt

• 1000-1500 first sleep/delay (default retry policy uses 500 ms as base delay for 4xx errors)

• 1500-2500 second attempt

• 2500-3500 second sleep/delay (500 * 2, exponential backoff)

• 3500-4500 third attempt

• 4500-6500 third sleep/delay (500 * 2^2)

• 6500-7500 fourth attempt (this can trigger inline recovery since 5 seconds have elapsed since the first attempt reached TC)

IdempotentParameterMismatchException:

DynamoDB rejected the request because you retried a request with a different payload but with an idempotent token that was already used.

ProvisionedThroughputExceededException:

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

RequestLimitExceeded:

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

InternalServerError:

An error occurred on the server side.

ExportTableToPointInTime

$result = $client->exportTableToPointInTime([/* ... */]);
$promise = $client->exportTableToPointInTimeAsync([/* ... */]);

Exports table data to an S3 bucket. The table must have point in time recovery enabled, and you can export data from any time within the point in time recovery window.

Parameter Syntax

$result = $client->exportTableToPointInTime([
    'ClientToken' => '<string>',
    'ExportFormat' => 'DYNAMODB_JSON|ION',
    'ExportTime' => <integer || string || DateTime>,
    'ExportType' => 'FULL_EXPORT|INCREMENTAL_EXPORT',
    'IncrementalExportSpecification' => [
        'ExportFromTime' => <integer || string || DateTime>,
        'ExportToTime' => <integer || string || DateTime>,
        'ExportViewType' => 'NEW_IMAGE|NEW_AND_OLD_IMAGES',
    ],
    'S3Bucket' => '<string>', // REQUIRED
    'S3BucketOwner' => '<string>',
    'S3Prefix' => '<string>',
    'S3SseAlgorithm' => 'AES256|KMS',
    'S3SseKmsKeyId' => '<string>',
    'TableArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ExportDescription' => [
        'BilledSizeBytes' => <integer>,
        'ClientToken' => '<string>',
        'EndTime' => <DateTime>,
        'ExportArn' => '<string>',
        'ExportFormat' => 'DYNAMODB_JSON|ION',
        'ExportManifest' => '<string>',
        'ExportStatus' => 'IN_PROGRESS|COMPLETED|FAILED',
        'ExportTime' => <DateTime>,
        'ExportType' => 'FULL_EXPORT|INCREMENTAL_EXPORT',
        'FailureCode' => '<string>',
        'FailureMessage' => '<string>',
        'IncrementalExportSpecification' => [
            'ExportFromTime' => <DateTime>,
            'ExportToTime' => <DateTime>,
            'ExportViewType' => 'NEW_IMAGE|NEW_AND_OLD_IMAGES',
        ],
        'ItemCount' => <integer>,
        'S3Bucket' => '<string>',
        'S3BucketOwner' => '<string>',
        'S3Prefix' => '<string>',
        'S3SseAlgorithm' => 'AES256|KMS',
        'S3SseKmsKeyId' => '<string>',
        'StartTime' => <DateTime>,
        'TableArn' => '<string>',
        'TableId' => '<string>',
    ],
]

Result Details

Errors

TableNotFoundException:

A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

PointInTimeRecoveryUnavailableException:

Point in time recovery has not yet been enabled for this source table.

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

InvalidExportTimeException:

The specified ExportTime is outside of the point in time recovery window.

ExportConflictException:

There was a conflict when writing to the specified S3 bucket.

InternalServerError:

An error occurred on the server side.

GetItem

$result = $client->getItem([/* ... */]);
$promise = $client->getItemAsync([/* ... */]);

The GetItem operation returns a set of attributes for the item with the given primary key. If there is no matching item, GetItem does not return any data and there will be no Item element in the response.

GetItem provides an eventually consistent read by default. If your application requires a strongly consistent read, set ConsistentRead to true. Although a strongly consistent read might take more time than an eventually consistent read, it always returns the last updated value.

Parameter Syntax

$result = $client->getItem([
    'AttributesToGet' => ['<string>', ...],
    'ConsistentRead' => true || false,
    'ExpressionAttributeNames' => ['<string>', ...],
    'Key' => [ // REQUIRED
        '<AttributeName>' => [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'ProjectionExpression' => '<string>',
    'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ConsumedCapacity' => [
        'CapacityUnits' => <float>,
        'GlobalSecondaryIndexes' => [
            '<IndexName>' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            // ...
        ],
        'LocalSecondaryIndexes' => [
            '<IndexName>' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            // ...
        ],
        'ReadCapacityUnits' => <float>,
        'Table' => [
            'CapacityUnits' => <float>,
            'ReadCapacityUnits' => <float>,
            'WriteCapacityUnits' => <float>,
        ],
        'TableName' => '<string>',
        'WriteCapacityUnits' => <float>,
    ],
    'Item' => [
        '<AttributeName>' => [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Errors

ProvisionedThroughputExceededException:

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

RequestLimitExceeded:

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

InternalServerError:

An error occurred on the server side.

Examples

Example 1: To read an item from a table

This example retrieves an item from the Music table. The table has a partition key and a sort key (Artist and SongTitle), so you must specify both of these attributes.

$result = $client->getItem([
    'Key' => [
        'Artist' => [
            'S' => 'Acme Band',
        ],
        'SongTitle' => [
            'S' => 'Happy Day',
        ],
    ],
    'TableName' => 'Music',
]);

Result syntax:

[
    'Item' => [
        'AlbumTitle' => [
            'S' => 'Songs About Life',
        ],
        'Artist' => [
            'S' => 'Acme Band',
        ],
        'SongTitle' => [
            'S' => 'Happy Day',
        ],
    ],
]

GetResourcePolicy

$result = $client->getResourcePolicy([/* ... */]);
$promise = $client->getResourcePolicyAsync([/* ... */]);

Returns the resource-based policy document attached to the resource, which can be a table or stream, in JSON format.

GetResourcePolicy follows an eventually consistent model. The following list describes the outcomes when you issue the GetResourcePolicy request immediately after issuing another request:

• If you issue a GetResourcePolicy request immediately after a PutResourcePolicy request, DynamoDB might return a PolicyNotFoundException.

• If you issue a GetResourcePolicyrequest immediately after a DeleteResourcePolicy request, DynamoDB might return the policy that was present before the deletion request.

• If you issue a GetResourcePolicy request immediately after a CreateTable request, which includes a resource-based policy, DynamoDB might return a ResourceNotFoundException or a PolicyNotFoundException.

Because GetResourcePolicy uses an eventually consistent query, the metadata for your policy or table might not be available at that moment. Wait for a few seconds, and then retry the GetResourcePolicy request.

After a GetResourcePolicy request returns a policy created using the PutResourcePolicy request, the policy will be applied in the authorization of requests to the resource. Because this process is eventually consistent, it will take some time to apply the policy to all requests to a resource. Policies that you attach while creating a table using the CreateTable request will always be applied to all requests for that table.

Parameter Syntax

$result = $client->getResourcePolicy([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Policy' => '<string>',
    'RevisionId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

InternalServerError:

An error occurred on the server side.

PolicyNotFoundException:

The operation tried to access a nonexistent resource-based policy.

If you specified an ExpectedRevisionId, it's possible that a policy is present for the resource but its revision ID didn't match the expected value.

ImportTable

$result = $client->importTable([/* ... */]);
$promise = $client->importTableAsync([/* ... */]);

Imports table data from an S3 bucket.

Parameter Syntax

$result = $client->importTable([
    'ClientToken' => '<string>',
    'InputCompressionType' => 'GZIP|ZSTD|NONE',
    'InputFormat' => 'DYNAMODB_JSON|ION|CSV', // REQUIRED
    'InputFormatOptions' => [
        'Csv' => [
            'Delimiter' => '<string>',
            'HeaderList' => ['<string>', ...],
        ],
    ],
    'S3BucketSource' => [ // REQUIRED
        'S3Bucket' => '<string>', // REQUIRED
        'S3BucketOwner' => '<string>',
        'S3KeyPrefix' => '<string>',
    ],
    'TableCreationParameters' => [ // REQUIRED
        'AttributeDefinitions' => [ // REQUIRED
            [
                'AttributeName' => '<string>', // REQUIRED
                'AttributeType' => 'S|N|B', // REQUIRED
            ],
            // ...
        ],
        'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
        'GlobalSecondaryIndexes' => [
            [
                'IndexName' => '<string>', // REQUIRED
                'KeySchema' => [ // REQUIRED
                    [
                        'AttributeName' => '<string>', // REQUIRED
                        'KeyType' => 'HASH|RANGE', // REQUIRED
                    ],
                    // ...
                ],
                'OnDemandThroughput' => [
                    'MaxReadRequestUnits' => <integer>,
                    'MaxWriteRequestUnits' => <integer>,
                ],
                'Projection' => [ // REQUIRED
                    'NonKeyAttributes' => ['<string>', ...],
                    'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                ],
                'ProvisionedThroughput' => [
                    'ReadCapacityUnits' => <integer>, // REQUIRED
                    'WriteCapacityUnits' => <integer>, // REQUIRED
                ],
            ],
            // ...
        ],
        'KeySchema' => [ // REQUIRED
            [
                'AttributeName' => '<string>', // REQUIRED
                'KeyType' => 'HASH|RANGE', // REQUIRED
            ],
            // ...
        ],
        'OnDemandThroughput' => [
            'MaxReadRequestUnits' => <integer>,
            'MaxWriteRequestUnits' => <integer>,
        ],
        'ProvisionedThroughput' => [
            'ReadCapacityUnits' => <integer>, // REQUIRED
            'WriteCapacityUnits' => <integer>, // REQUIRED
        ],
        'SSESpecification' => [
            'Enabled' => true || false,
            'KMSMasterKeyId' => '<string>',
            'SSEType' => 'AES256|KMS',
        ],
        'TableName' => '<string>', // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'ImportTableDescription' => [
        'ClientToken' => '<string>',
        'CloudWatchLogGroupArn' => '<string>',
        'EndTime' => <DateTime>,
        'ErrorCount' => <integer>,
        'FailureCode' => '<string>',
        'FailureMessage' => '<string>',
        'ImportArn' => '<string>',
        'ImportStatus' => 'IN_PROGRESS|COMPLETED|CANCELLING|CANCELLED|FAILED',
        'ImportedItemCount' => <integer>,
        'InputCompressionType' => 'GZIP|ZSTD|NONE',
        'InputFormat' => 'DYNAMODB_JSON|ION|CSV',
        'InputFormatOptions' => [
            'Csv' => [
                'Delimiter' => '<string>',
                'HeaderList' => ['<string>', ...],
            ],
        ],
        'ProcessedItemCount' => <integer>,
        'ProcessedSizeBytes' => <integer>,
        'S3BucketSource' => [
            'S3Bucket' => '<string>',
            'S3BucketOwner' => '<string>',
            'S3KeyPrefix' => '<string>',
        ],
        'StartTime' => <DateTime>,
        'TableArn' => '<string>',
        'TableCreationParameters' => [
            'AttributeDefinitions' => [
                [
                    'AttributeName' => '<string>',
                    'AttributeType' => 'S|N|B',
                ],
                // ...
            ],
            'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
            'GlobalSecondaryIndexes' => [
                [
                    'IndexName' => '<string>',
                    'KeySchema' => [
                        [
                            'AttributeName' => '<string>',
                            'KeyType' => 'HASH|RANGE',
                        ],
                        // ...
                    ],
                    'OnDemandThroughput' => [
                        'MaxReadRequestUnits' => <integer>,
                        'MaxWriteRequestUnits' => <integer>,
                    ],
                    'Projection' => [
                        'NonKeyAttributes' => ['<string>', ...],
                        'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                    ],
                    'ProvisionedThroughput' => [
                        'ReadCapacityUnits' => <integer>,
                        'WriteCapacityUnits' => <integer>,
                    ],
                ],
                // ...
            ],
            'KeySchema' => [
                [
                    'AttributeName' => '<string>',
                    'KeyType' => 'HASH|RANGE',
                ],
                // ...
            ],
            'OnDemandThroughput' => [
                'MaxReadRequestUnits' => <integer>,
                'MaxWriteRequestUnits' => <integer>,
            ],
            'ProvisionedThroughput' => [
                'ReadCapacityUnits' => <integer>,
                'WriteCapacityUnits' => <integer>,
            ],
            'SSESpecification' => [
                'Enabled' => true || false,
                'KMSMasterKeyId' => '<string>',
                'SSEType' => 'AES256|KMS',
            ],
            'TableName' => '<string>',
        ],
        'TableId' => '<string>',
    ],
]

Result Details

Errors

ResourceInUseException:

The operation conflicts with the resource's availability. For example:

• You attempted to recreate an existing table.

• You tried to delete a table currently in the CREATING state.

• You tried to update a resource that was already being updated.

When appropriate, wait for the ongoing update to complete and attempt the request again.

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

ImportConflictException:

There was a conflict when importing from the specified S3 source. This can occur when the current import conflicts with a previous import request that had the same client token.

ListBackups

$result = $client->listBackups([/* ... */]);
$promise = $client->listBackupsAsync([/* ... */]);

List DynamoDB backups that are associated with an Amazon Web Services account and weren't made with Amazon Web Services Backup. To list these backups for a given table, specify TableName. ListBackups returns a paginated list of results with at most 1 MB worth of items in a page. You can also specify a maximum number of entries to be returned in a page.

In the request, start time is inclusive, but end time is exclusive. Note that these boundaries are for the time at which the original backup was requested.

You can call ListBackups a maximum of five times per second.

If you want to retrieve the complete list of backups made with Amazon Web Services Backup, use the Amazon Web Services Backup list API.

Parameter Syntax

$result = $client->listBackups([
    'BackupType' => 'USER|SYSTEM|AWS_BACKUP|ALL',
    'ExclusiveStartBackupArn' => '<string>',
    'Limit' => <integer>,
    'TableName' => '<string>',
    'TimeRangeLowerBound' => <integer || string || DateTime>,
    'TimeRangeUpperBound' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'BackupSummaries' => [
        [
            'BackupArn' => '<string>',
            'BackupCreationDateTime' => <DateTime>,
            'BackupExpiryDateTime' => <DateTime>,
            'BackupName' => '<string>',
            'BackupSizeBytes' => <integer>,
            'BackupStatus' => 'CREATING|DELETED|AVAILABLE',
            'BackupType' => 'USER|SYSTEM|AWS_BACKUP',
            'TableArn' => '<string>',
            'TableId' => '<string>',
            'TableName' => '<string>',
        ],
        // ...
    ],
    'LastEvaluatedBackupArn' => '<string>',
]

Result Details

Errors

InternalServerError:

An error occurred on the server side.

ListContributorInsights

$result = $client->listContributorInsights([/* ... */]);
$promise = $client->listContributorInsightsAsync([/* ... */]);

Returns a list of ContributorInsightsSummary for a table and all its global secondary indexes.

Parameter Syntax

$result = $client->listContributorInsights([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TableName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ContributorInsightsSummaries' => [
        [
            'ContributorInsightsStatus' => 'ENABLING|ENABLED|DISABLING|DISABLED|FAILED',
            'IndexName' => '<string>',
            'TableName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

InternalServerError:

An error occurred on the server side.

ListExports

$result = $client->listExports([/* ... */]);
$promise = $client->listExportsAsync([/* ... */]);

Lists completed exports within the past 90 days.

Parameter Syntax

$result = $client->listExports([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'TableArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ExportSummaries' => [
        [
            'ExportArn' => '<string>',
            'ExportStatus' => 'IN_PROGRESS|COMPLETED|FAILED',
            'ExportType' => 'FULL_EXPORT|INCREMENTAL_EXPORT',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

InternalServerError:

An error occurred on the server side.

ListGlobalTables

$result = $client->listGlobalTables([/* ... */]);
$promise = $client->listGlobalTablesAsync([/* ... */]);

Lists all global tables that have a replica in the specified Region.

Parameter Syntax

$result = $client->listGlobalTables([
    'ExclusiveStartGlobalTableName' => '<string>',
    'Limit' => <integer>,
    'RegionName' => '<string>',
]);

Parameter Details

Result Syntax

[
    'GlobalTables' => [
        [
            'GlobalTableName' => '<string>',
            'ReplicationGroup' => [
                [
                    'RegionName' => '<string>',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'LastEvaluatedGlobalTableName' => '<string>',
]

Result Details

Errors

InternalServerError:

An error occurred on the server side.

ListImports

$result = $client->listImports([/* ... */]);
$promise = $client->listImportsAsync([/* ... */]);

Lists completed imports within the past 90 days.

Parameter Syntax

$result = $client->listImports([
    'NextToken' => '<string>',
    'PageSize' => <integer>,
    'TableArn' => '<string>',
]);

Parameter Details

Result Syntax

[
    'ImportSummaryList' => [
        [
            'CloudWatchLogGroupArn' => '<string>',
            'EndTime' => <DateTime>,
            'ImportArn' => '<string>',
            'ImportStatus' => 'IN_PROGRESS|COMPLETED|CANCELLING|CANCELLED|FAILED',
            'InputFormat' => 'DYNAMODB_JSON|ION|CSV',
            'S3BucketSource' => [
                'S3Bucket' => '<string>',
                'S3BucketOwner' => '<string>',
                'S3KeyPrefix' => '<string>',
            ],
            'StartTime' => <DateTime>,
            'TableArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

ListTables

$result = $client->listTables([/* ... */]);
$promise = $client->listTablesAsync([/* ... */]);

Returns an array of table names associated with the current account and endpoint. The output from ListTables is paginated, with each page returning a maximum of 100 table names.

Parameter Syntax

$result = $client->listTables([
    'ExclusiveStartTableName' => '<string>',
    'Limit' => <integer>,
]);

Parameter Details

Result Syntax

[
    'LastEvaluatedTableName' => '<string>',
    'TableNames' => ['<string>', ...],
]

Result Details

Errors

InternalServerError:

An error occurred on the server side.

Examples

Example 1: To list tables

This example lists all of the tables associated with the current AWS account and endpoint.

$result = $client->listTables([
]);

Result syntax:

[
    'TableNames' => [
        'Forum',
        'ProductCatalog',
        'Reply',
        'Thread',
    ],
]

ListTagsOfResource

$result = $client->listTagsOfResource([/* ... */]);
$promise = $client->listTagsOfResourceAsync([/* ... */]);

List all tags on an Amazon DynamoDB resource. You can call ListTagsOfResource up to 10 times per second, per account.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

Parameter Syntax

$result = $client->listTagsOfResource([
    'NextToken' => '<string>',
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

InternalServerError:

An error occurred on the server side.

PutItem

$result = $client->putItem([/* ... */]);
$promise = $client->putItemAsync([/* ... */]);

Creates a new item, or replaces an old item with a new item. If an item that has the same primary key as the new item already exists in the specified table, the new item completely replaces the existing item. You can perform a conditional put operation (add a new item if one with the specified primary key doesn't exist), or replace an existing item if it has certain attribute values. You can return the item's attribute values in the same operation, using the ReturnValues parameter.

When you add an item, the primary key attributes are the only required attributes.

Empty String and Binary attribute values are allowed. Attribute values of type String and Binary must have a length greater than zero if the attribute is used as a key attribute for a table or index. Set type attributes cannot be empty.

Invalid Requests with empty values will be rejected with a ValidationException exception.

For more information about PutItem, see Working with Items in the Amazon DynamoDB Developer Guide.

Parameter Syntax

$result = $client->putItem([
    'ConditionExpression' => '<string>',
    'ConditionalOperator' => 'AND|OR',
    'Expected' => [
        '<AttributeName>' => [
            'AttributeValueList' => [
                [
                    'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BOOL' => true || false,
                    'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                    'L' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'M' => [
                        '<AttributeName>' => [...], // RECURSIVE
                        // ...
                    ],
                    'N' => '<string>',
                    'NS' => ['<string>', ...],
                    'NULL' => true || false,
                    'S' => '<string>',
                    'SS' => ['<string>', ...],
                ],
                // ...
            ],
            'ComparisonOperator' => 'EQ|NE|IN|LE|LT|GE|GT|BETWEEN|NOT_NULL|NULL|CONTAINS|NOT_CONTAINS|BEGINS_WITH',
            'Exists' => true || false,
            'Value' => [
                'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                'BOOL' => true || false,
                'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                'L' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'M' => [
                    '<AttributeName>' => [...], // RECURSIVE
                    // ...
                ],
                'N' => '<string>',
                'NS' => ['<string>', ...],
                'NULL' => true || false,
                'S' => '<string>',
                'SS' => ['<string>', ...],
            ],
        ],
        // ...
    ],
    'ExpressionAttributeNames' => ['<string>', ...],
    'ExpressionAttributeValues' => [
        '<ExpressionAttributeValueVariable>' => [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'Item' => [ // REQUIRED
        '<AttributeName>' => [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
    'ReturnItemCollectionMetrics' => 'SIZE|NONE',
    'ReturnValues' => 'NONE|ALL_OLD|UPDATED_OLD|ALL_NEW|UPDATED_NEW',
    'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Attributes' => [
        '<AttributeName>' => [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'ConsumedCapacity' => [
        'CapacityUnits' => <float>,
        'GlobalSecondaryIndexes' => [
            '<IndexName>' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            // ...
        ],
        'LocalSecondaryIndexes' => [
            '<IndexName>' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            // ...
        ],
        'ReadCapacityUnits' => <float>,
        'Table' => [
            'CapacityUnits' => <float>,
            'ReadCapacityUnits' => <float>,
            'WriteCapacityUnits' => <float>,
        ],
        'TableName' => '<string>',
        'WriteCapacityUnits' => <float>,
    ],
    'ItemCollectionMetrics' => [
        'ItemCollectionKey' => [
            '<AttributeName>' => [
                'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                'BOOL' => true || false,
                'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                'L' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'M' => [
                    '<AttributeName>' => [...], // RECURSIVE
                    // ...
                ],
                'N' => '<string>',
                'NS' => ['<string>', ...],
                'NULL' => true || false,
                'S' => '<string>',
                'SS' => ['<string>', ...],
            ],
            // ...
        ],
        'SizeEstimateRangeGB' => [<float>, ...],
    ],
]

Result Details

Errors

ConditionalCheckFailedException:

A condition specified in the operation could not be evaluated.

ProvisionedThroughputExceededException:

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

ItemCollectionSizeLimitExceededException:

An item collection is too large. This exception is only returned for tables that have one or more local secondary indexes.

TransactionConflictException:

Operation was rejected because there is an ongoing transaction for the item.

RequestLimitExceeded:

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

InternalServerError:

An error occurred on the server side.

Examples

Example 1: To add an item to a table

This example adds a new item to the Music table.

$result = $client->putItem([
    'Item' => [
        'AlbumTitle' => [
            'S' => 'Somewhat Famous',
        ],
        'Artist' => [
            'S' => 'No One You Know',
        ],
        'SongTitle' => [
            'S' => 'Call Me Today',
        ],
    ],
    'ReturnConsumedCapacity' => 'TOTAL',
    'TableName' => 'Music',
]);

Result syntax:

[
    'ConsumedCapacity' => [
        'CapacityUnits' => 1,
        'TableName' => 'Music',
    ],
]

PutResourcePolicy

$result = $client->putResourcePolicy([/* ... */]);
$promise = $client->putResourcePolicyAsync([/* ... */]);

Attaches a resource-based policy document to the resource, which can be a table or stream. When you attach a resource-based policy using this API, the policy application is eventually consistent .

PutResourcePolicy is an idempotent operation; running it multiple times on the same resource using the same policy document will return the same revision ID. If you specify an ExpectedRevisionId that doesn't match the current policy's RevisionId, the PolicyNotFoundException will be returned.

Parameter Syntax

$result = $client->putResourcePolicy([
    'ConfirmRemoveSelfResourceAccess' => true || false,
    'ExpectedRevisionId' => '<string>',
    'Policy' => '<string>', // REQUIRED
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'RevisionId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

InternalServerError:

An error occurred on the server side.

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

PolicyNotFoundException:

The operation tried to access a nonexistent resource-based policy.

If you specified an ExpectedRevisionId, it's possible that a policy is present for the resource but its revision ID didn't match the expected value.

ResourceInUseException:

The operation conflicts with the resource's availability. For example:

• You attempted to recreate an existing table.

• You tried to delete a table currently in the CREATING state.

• You tried to update a resource that was already being updated.

When appropriate, wait for the ongoing update to complete and attempt the request again.

Query

$result = $client->query([/* ... */]);
$promise = $client->queryAsync([/* ... */]);

You must provide the name of the partition key attribute and a single value for that attribute. Query returns all items with that partition key value. Optionally, you can provide a sort key attribute and use a comparison operator to refine the search results.

Use the KeyConditionExpression parameter to provide a specific value for the partition key. The Query operation will return all of the items from the table or index with that partition key value. You can optionally narrow the scope of the Query operation by specifying a sort key value and a comparison operator in KeyConditionExpression. To further refine the Query results, you can optionally provide a FilterExpression. A FilterExpression determines which items within the results should be returned to you. All of the other results are discarded.

A Query operation always returns a result set. If no matching items are found, the result set will be empty. Queries that do not return results consume the minimum number of read capacity units for that type of read operation.

Query results are always sorted by the sort key value. If the data type of the sort key is Number, the results are returned in numeric order; otherwise, the results are returned in order of UTF-8 bytes. By default, the sort order is ascending. To reverse the order, set the ScanIndexForward parameter to false.

A single Query operation will read up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then apply any filtering to the results using FilterExpression. If LastEvaluatedKey is present in the response, you will need to paginate the result set. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.

FilterExpression is applied after a Query finishes, but before the results are returned. A FilterExpression cannot contain partition key or sort key attributes. You need to specify those attributes in the KeyConditionExpression.

You can query a table, a local secondary index, or a global secondary index. For a query on a table or on a local secondary index, you can set the ConsistentRead parameter to true and obtain a strongly consistent result. Global secondary indexes support eventually consistent reads only, so do not specify ConsistentRead when querying a global secondary index.

Parameter Syntax

$result = $client->query([
    'AttributesToGet' => ['<string>', ...],
    'ConditionalOperator' => 'AND|OR',
    'ConsistentRead' => true || false,
    'ExclusiveStartKey' => [
        '<AttributeName>' => [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'ExpressionAttributeNames' => ['<string>', ...],
    'ExpressionAttributeValues' => [
        '<ExpressionAttributeValueVariable>' => [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'FilterExpression' => '<string>',
    'IndexName' => '<string>',
    'KeyConditionExpression' => '<string>',
    'KeyConditions' => [
        '<AttributeName>' => [
            'AttributeValueList' => [
                [
                    'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BOOL' => true || false,
                    'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                    'L' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'M' => [
                        '<AttributeName>' => [...], // RECURSIVE
                        // ...
                    ],
                    'N' => '<string>',
                    'NS' => ['<string>', ...],
                    'NULL' => true || false,
                    'S' => '<string>',
                    'SS' => ['<string>', ...],
                ],
                // ...
            ],
            'ComparisonOperator' => 'EQ|NE|IN|LE|LT|GE|GT|BETWEEN|NOT_NULL|NULL|CONTAINS|NOT_CONTAINS|BEGINS_WITH', // REQUIRED
        ],
        // ...
    ],
    'Limit' => <integer>,
    'ProjectionExpression' => '<string>',
    'QueryFilter' => [
        '<AttributeName>' => [
            'AttributeValueList' => [
                [
                    'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BOOL' => true || false,
                    'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                    'L' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'M' => [
                        '<AttributeName>' => [...], // RECURSIVE
                        // ...
                    ],
                    'N' => '<string>',
                    'NS' => ['<string>', ...],
                    'NULL' => true || false,
                    'S' => '<string>',
                    'SS' => ['<string>', ...],
                ],
                // ...
            ],
            'ComparisonOperator' => 'EQ|NE|IN|LE|LT|GE|GT|BETWEEN|NOT_NULL|NULL|CONTAINS|NOT_CONTAINS|BEGINS_WITH', // REQUIRED
        ],
        // ...
    ],
    'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
    'ScanIndexForward' => true || false,
    'Select' => 'ALL_ATTRIBUTES|ALL_PROJECTED_ATTRIBUTES|SPECIFIC_ATTRIBUTES|COUNT',
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ConsumedCapacity' => [
        'CapacityUnits' => <float>,
        'GlobalSecondaryIndexes' => [
            '<IndexName>' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            // ...
        ],
        'LocalSecondaryIndexes' => [
            '<IndexName>' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            // ...
        ],
        'ReadCapacityUnits' => <float>,
        'Table' => [
            'CapacityUnits' => <float>,
            'ReadCapacityUnits' => <float>,
            'WriteCapacityUnits' => <float>,
        ],
        'TableName' => '<string>',
        'WriteCapacityUnits' => <float>,
    ],
    'Count' => <integer>,
    'Items' => [
        [
            '<AttributeName>' => [
                'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                'BOOL' => true || false,
                'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                'L' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'M' => [
                    '<AttributeName>' => [...], // RECURSIVE
                    // ...
                ],
                'N' => '<string>',
                'NS' => ['<string>', ...],
                'NULL' => true || false,
                'S' => '<string>',
                'SS' => ['<string>', ...],
            ],
            // ...
        ],
        // ...
    ],
    'LastEvaluatedKey' => [
        '<AttributeName>' => [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'ScannedCount' => <integer>,
]

Result Details

Errors

ProvisionedThroughputExceededException:

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

RequestLimitExceeded:

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

InternalServerError:

An error occurred on the server side.

Examples

Example 1: To query an item

This example queries items in the Music table. The table has a partition key and sort key (Artist and SongTitle), but this query only specifies the partition key value. It returns song titles by the artist named "No One You Know".

$result = $client->query([
    'ExpressionAttributeValues' => [
        ':v1' => [
            'S' => 'No One You Know',
        ],
    ],
    'KeyConditionExpression' => 'Artist = :v1',
    'ProjectionExpression' => 'SongTitle',
    'TableName' => 'Music',
]);

Result syntax:

[
    'ConsumedCapacity' => [
    ],
    'Count' => 2,
    'Items' => [
        [
            'SongTitle' => [
                'S' => 'Call Me Today',
            ],
        ],
    ],
    'ScannedCount' => 2,
]

RestoreTableFromBackup

$result = $client->restoreTableFromBackup([/* ... */]);
$promise = $client->restoreTableFromBackupAsync([/* ... */]);

Creates a new table from an existing backup. Any number of users can execute up to 50 concurrent restores (any type of restore) in a given account.

You can call RestoreTableFromBackup at a maximum rate of 10 times per second.

You must manually set up the following on the restored table:

• Auto scaling policies

• IAM policies

• Amazon CloudWatch metrics and alarms

• Tags

• Stream settings

• Time to Live (TTL) settings

Parameter Syntax

$result = $client->restoreTableFromBackup([
    'BackupArn' => '<string>', // REQUIRED
    'BillingModeOverride' => 'PROVISIONED|PAY_PER_REQUEST',
    'GlobalSecondaryIndexOverride' => [
        [
            'IndexName' => '<string>', // REQUIRED
            'KeySchema' => [ // REQUIRED
                [
                    'AttributeName' => '<string>', // REQUIRED
                    'KeyType' => 'HASH|RANGE', // REQUIRED
                ],
                // ...
            ],
            'OnDemandThroughput' => [
                'MaxReadRequestUnits' => <integer>,
                'MaxWriteRequestUnits' => <integer>,
            ],
            'Projection' => [ // REQUIRED
                'NonKeyAttributes' => ['<string>', ...],
                'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
            ],
            'ProvisionedThroughput' => [
                'ReadCapacityUnits' => <integer>, // REQUIRED
                'WriteCapacityUnits' => <integer>, // REQUIRED
            ],
        ],
        // ...
    ],
    'LocalSecondaryIndexOverride' => [
        [
            'IndexName' => '<string>', // REQUIRED
            'KeySchema' => [ // REQUIRED
                [
                    'AttributeName' => '<string>', // REQUIRED
                    'KeyType' => 'HASH|RANGE', // REQUIRED
                ],
                // ...
            ],
            'Projection' => [ // REQUIRED
                'NonKeyAttributes' => ['<string>', ...],
                'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
            ],
        ],
        // ...
    ],
    'OnDemandThroughputOverride' => [
        'MaxReadRequestUnits' => <integer>,
        'MaxWriteRequestUnits' => <integer>,
    ],
    'ProvisionedThroughputOverride' => [
        'ReadCapacityUnits' => <integer>, // REQUIRED
        'WriteCapacityUnits' => <integer>, // REQUIRED
    ],
    'SSESpecificationOverride' => [
        'Enabled' => true || false,
        'KMSMasterKeyId' => '<string>',
        'SSEType' => 'AES256|KMS',
    ],
    'TargetTableName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TableDescription' => [
        'ArchivalSummary' => [
            'ArchivalBackupArn' => '<string>',
            'ArchivalDateTime' => <DateTime>,
            'ArchivalReason' => '<string>',
        ],
        'AttributeDefinitions' => [
            [
                'AttributeName' => '<string>',
                'AttributeType' => 'S|N|B',
            ],
            // ...
        ],
        'BillingModeSummary' => [
            'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
            'LastUpdateToPayPerRequestDateTime' => <DateTime>,
        ],
        'CreationDateTime' => <DateTime>,
        'DeletionProtectionEnabled' => true || false,
        'GlobalSecondaryIndexes' => [
            [
                'Backfilling' => true || false,
                'IndexArn' => '<string>',
                'IndexName' => '<string>',
                'IndexSizeBytes' => <integer>,
                'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
                'ItemCount' => <integer>,
                'KeySchema' => [
                    [
                        'AttributeName' => '<string>',
                        'KeyType' => 'HASH|RANGE',
                    ],
                    // ...
                ],
                'OnDemandThroughput' => [
                    'MaxReadRequestUnits' => <integer>,
                    'MaxWriteRequestUnits' => <integer>,
                ],
                'Projection' => [
                    'NonKeyAttributes' => ['<string>', ...],
                    'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                ],
                'ProvisionedThroughput' => [
                    'LastDecreaseDateTime' => <DateTime>,
                    'LastIncreaseDateTime' => <DateTime>,
                    'NumberOfDecreasesToday' => <integer>,
                    'ReadCapacityUnits' => <integer>,
                    'WriteCapacityUnits' => <integer>,
                ],
            ],
            // ...
        ],
        'GlobalTableVersion' => '<string>',
        'ItemCount' => <integer>,
        'KeySchema' => [
            [
                'AttributeName' => '<string>',
                'KeyType' => 'HASH|RANGE',
            ],
            // ...
        ],
        'LatestStreamArn' => '<string>',
        'LatestStreamLabel' => '<string>',
        'LocalSecondaryIndexes' => [
            [
                'IndexArn' => '<string>',
                'IndexName' => '<string>',
                'IndexSizeBytes' => <integer>,
                'ItemCount' => <integer>,
                'KeySchema' => [
                    [
                        'AttributeName' => '<string>',
                        'KeyType' => 'HASH|RANGE',
                    ],
                    // ...
                ],
                'Projection' => [
                    'NonKeyAttributes' => ['<string>', ...],
                    'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                ],
            ],
            // ...
        ],
        'OnDemandThroughput' => [
            'MaxReadRequestUnits' => <integer>,
            'MaxWriteRequestUnits' => <integer>,
        ],
        'ProvisionedThroughput' => [
            'LastDecreaseDateTime' => <DateTime>,
            'LastIncreaseDateTime' => <DateTime>,
            'NumberOfDecreasesToday' => <integer>,
            'ReadCapacityUnits' => <integer>,
            'WriteCapacityUnits' => <integer>,
        ],
        'Replicas' => [
            [
                'GlobalSecondaryIndexes' => [
                    [
                        'IndexName' => '<string>',
                        'OnDemandThroughputOverride' => [
                            'MaxReadRequestUnits' => <integer>,
                        ],
                        'ProvisionedThroughputOverride' => [
                            'ReadCapacityUnits' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'KMSMasterKeyId' => '<string>',
                'OnDemandThroughputOverride' => [
                    'MaxReadRequestUnits' => <integer>,
                ],
                'ProvisionedThroughputOverride' => [
                    'ReadCapacityUnits' => <integer>,
                ],
                'RegionName' => '<string>',
                'ReplicaInaccessibleDateTime' => <DateTime>,
                'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS',
                'ReplicaStatusDescription' => '<string>',
                'ReplicaStatusPercentProgress' => '<string>',
                'ReplicaTableClassSummary' => [
                    'LastUpdateDateTime' => <DateTime>,
                    'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
                ],
            ],
            // ...
        ],
        'RestoreSummary' => [
            'RestoreDateTime' => <DateTime>,
            'RestoreInProgress' => true || false,
            'SourceBackupArn' => '<string>',
            'SourceTableArn' => '<string>',
        ],
        'SSEDescription' => [
            'InaccessibleEncryptionDateTime' => <DateTime>,
            'KMSMasterKeyArn' => '<string>',
            'SSEType' => 'AES256|KMS',
            'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING',
        ],
        'StreamSpecification' => [
            'StreamEnabled' => true || false,
            'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
        ],
        'TableArn' => '<string>',
        'TableClassSummary' => [
            'LastUpdateDateTime' => <DateTime>,
            'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
        ],
        'TableId' => '<string>',
        'TableName' => '<string>',
        'TableSizeBytes' => <integer>,
        'TableStatus' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
    ],
]

Result Details

Errors

TableAlreadyExistsException:

A target table with the specified name already exists.

TableInUseException:

A target table with the specified name is either being created or deleted.

BackupNotFoundException:

Backup not found for the given BackupARN.

BackupInUseException:

There is another ongoing conflicting backup control plane operation on the table. The backup is either being created, deleted or restored to a table.

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

InternalServerError:

An error occurred on the server side.

RestoreTableToPointInTime

$result = $client->restoreTableToPointInTime([/* ... */]);
$promise = $client->restoreTableToPointInTimeAsync([/* ... */]);

Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. You can restore your table to any point in time during the last 35 days. Any number of users can execute up to 50 concurrent restores (any type of restore) in a given account.

When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table.

Along with data, the following are also included on the new restored table using point in time recovery:

• Global secondary indexes (GSIs)

• Local secondary indexes (LSIs)

• Provisioned read and write capacity

• Encryption settings

  All these settings come from the current settings of the source table at the time of restore.

You must manually set up the following on the restored table:

• Auto scaling policies

• IAM policies

• Amazon CloudWatch metrics and alarms

• Tags

• Stream settings

• Time to Live (TTL) settings

• Point in time recovery settings

Parameter Syntax

$result = $client->restoreTableToPointInTime([
    'BillingModeOverride' => 'PROVISIONED|PAY_PER_REQUEST',
    'GlobalSecondaryIndexOverride' => [
        [
            'IndexName' => '<string>', // REQUIRED
            'KeySchema' => [ // REQUIRED
                [
                    'AttributeName' => '<string>', // REQUIRED
                    'KeyType' => 'HASH|RANGE', // REQUIRED
                ],
                // ...
            ],
            'OnDemandThroughput' => [
                'MaxReadRequestUnits' => <integer>,
                'MaxWriteRequestUnits' => <integer>,
            ],
            'Projection' => [ // REQUIRED
                'NonKeyAttributes' => ['<string>', ...],
                'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
            ],
            'ProvisionedThroughput' => [
                'ReadCapacityUnits' => <integer>, // REQUIRED
                'WriteCapacityUnits' => <integer>, // REQUIRED
            ],
        ],
        // ...
    ],
    'LocalSecondaryIndexOverride' => [
        [
            'IndexName' => '<string>', // REQUIRED
            'KeySchema' => [ // REQUIRED
                [
                    'AttributeName' => '<string>', // REQUIRED
                    'KeyType' => 'HASH|RANGE', // REQUIRED
                ],
                // ...
            ],
            'Projection' => [ // REQUIRED
                'NonKeyAttributes' => ['<string>', ...],
                'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
            ],
        ],
        // ...
    ],
    'OnDemandThroughputOverride' => [
        'MaxReadRequestUnits' => <integer>,
        'MaxWriteRequestUnits' => <integer>,
    ],
    'ProvisionedThroughputOverride' => [
        'ReadCapacityUnits' => <integer>, // REQUIRED
        'WriteCapacityUnits' => <integer>, // REQUIRED
    ],
    'RestoreDateTime' => <integer || string || DateTime>,
    'SSESpecificationOverride' => [
        'Enabled' => true || false,
        'KMSMasterKeyId' => '<string>',
        'SSEType' => 'AES256|KMS',
    ],
    'SourceTableArn' => '<string>',
    'SourceTableName' => '<string>',
    'TargetTableName' => '<string>', // REQUIRED
    'UseLatestRestorableTime' => true || false,
]);

Parameter Details

Result Syntax

[
    'TableDescription' => [
        'ArchivalSummary' => [
            'ArchivalBackupArn' => '<string>',
            'ArchivalDateTime' => <DateTime>,
            'ArchivalReason' => '<string>',
        ],
        'AttributeDefinitions' => [
            [
                'AttributeName' => '<string>',
                'AttributeType' => 'S|N|B',
            ],
            // ...
        ],
        'BillingModeSummary' => [
            'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
            'LastUpdateToPayPerRequestDateTime' => <DateTime>,
        ],
        'CreationDateTime' => <DateTime>,
        'DeletionProtectionEnabled' => true || false,
        'GlobalSecondaryIndexes' => [
            [
                'Backfilling' => true || false,
                'IndexArn' => '<string>',
                'IndexName' => '<string>',
                'IndexSizeBytes' => <integer>,
                'IndexStatus' => 'CREATING|UPDATING|DELETING|ACTIVE',
                'ItemCount' => <integer>,
                'KeySchema' => [
                    [
                        'AttributeName' => '<string>',
                        'KeyType' => 'HASH|RANGE',
                    ],
                    // ...
                ],
                'OnDemandThroughput' => [
                    'MaxReadRequestUnits' => <integer>,
                    'MaxWriteRequestUnits' => <integer>,
                ],
                'Projection' => [
                    'NonKeyAttributes' => ['<string>', ...],
                    'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                ],
                'ProvisionedThroughput' => [
                    'LastDecreaseDateTime' => <DateTime>,
                    'LastIncreaseDateTime' => <DateTime>,
                    'NumberOfDecreasesToday' => <integer>,
                    'ReadCapacityUnits' => <integer>,
                    'WriteCapacityUnits' => <integer>,
                ],
            ],
            // ...
        ],
        'GlobalTableVersion' => '<string>',
        'ItemCount' => <integer>,
        'KeySchema' => [
            [
                'AttributeName' => '<string>',
                'KeyType' => 'HASH|RANGE',
            ],
            // ...
        ],
        'LatestStreamArn' => '<string>',
        'LatestStreamLabel' => '<string>',
        'LocalSecondaryIndexes' => [
            [
                'IndexArn' => '<string>',
                'IndexName' => '<string>',
                'IndexSizeBytes' => <integer>,
                'ItemCount' => <integer>,
                'KeySchema' => [
                    [
                        'AttributeName' => '<string>',
                        'KeyType' => 'HASH|RANGE',
                    ],
                    // ...
                ],
                'Projection' => [
                    'NonKeyAttributes' => ['<string>', ...],
                    'ProjectionType' => 'ALL|KEYS_ONLY|INCLUDE',
                ],
            ],
            // ...
        ],
        'OnDemandThroughput' => [
            'MaxReadRequestUnits' => <integer>,
            'MaxWriteRequestUnits' => <integer>,
        ],
        'ProvisionedThroughput' => [
            'LastDecreaseDateTime' => <DateTime>,
            'LastIncreaseDateTime' => <DateTime>,
            'NumberOfDecreasesToday' => <integer>,
            'ReadCapacityUnits' => <integer>,
            'WriteCapacityUnits' => <integer>,
        ],
        'Replicas' => [
            [
                'GlobalSecondaryIndexes' => [
                    [
                        'IndexName' => '<string>',
                        'OnDemandThroughputOverride' => [
                            'MaxReadRequestUnits' => <integer>,
                        ],
                        'ProvisionedThroughputOverride' => [
                            'ReadCapacityUnits' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'KMSMasterKeyId' => '<string>',
                'OnDemandThroughputOverride' => [
                    'MaxReadRequestUnits' => <integer>,
                ],
                'ProvisionedThroughputOverride' => [
                    'ReadCapacityUnits' => <integer>,
                ],
                'RegionName' => '<string>',
                'ReplicaInaccessibleDateTime' => <DateTime>,
                'ReplicaStatus' => 'CREATING|CREATION_FAILED|UPDATING|DELETING|ACTIVE|REGION_DISABLED|INACCESSIBLE_ENCRYPTION_CREDENTIALS',
                'ReplicaStatusDescription' => '<string>',
                'ReplicaStatusPercentProgress' => '<string>',
                'ReplicaTableClassSummary' => [
                    'LastUpdateDateTime' => <DateTime>,
                    'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
                ],
            ],
            // ...
        ],
        'RestoreSummary' => [
            'RestoreDateTime' => <DateTime>,
            'RestoreInProgress' => true || false,
            'SourceBackupArn' => '<string>',
            'SourceTableArn' => '<string>',
        ],
        'SSEDescription' => [
            'InaccessibleEncryptionDateTime' => <DateTime>,
            'KMSMasterKeyArn' => '<string>',
            'SSEType' => 'AES256|KMS',
            'Status' => 'ENABLING|ENABLED|DISABLING|DISABLED|UPDATING',
        ],
        'StreamSpecification' => [
            'StreamEnabled' => true || false,
            'StreamViewType' => 'NEW_IMAGE|OLD_IMAGE|NEW_AND_OLD_IMAGES|KEYS_ONLY',
        ],
        'TableArn' => '<string>',
        'TableClassSummary' => [
            'LastUpdateDateTime' => <DateTime>,
            'TableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
        ],
        'TableId' => '<string>',
        'TableName' => '<string>',
        'TableSizeBytes' => <integer>,
        'TableStatus' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
    ],
]

Result Details

Errors

TableAlreadyExistsException:

A target table with the specified name already exists.

TableNotFoundException:

A source table with the name TableName does not currently exist within the subscriber's account or the subscriber is operating in the wrong Amazon Web Services Region.

TableInUseException:

A target table with the specified name is either being created or deleted.

LimitExceededException:

There is no limit to the number of daily on-demand backups that can be taken.

For most purposes, up to 500 simultaneous table operations are allowed per account. These operations include CreateTable, UpdateTable, DeleteTable,UpdateTimeToLive, RestoreTableFromBackup, and RestoreTableToPointInTime.

When you are creating a table with one or more secondary indexes, you can have up to 250 such requests running at a time. However, if the table or index specifications are complex, then DynamoDB might temporarily reduce the number of concurrent operations.

When importing into DynamoDB, up to 50 simultaneous import table operations are allowed per account.

There is a soft account quota of 2,500 tables.

GetRecords was called with a value of more than 1000 for the limit request parameter.

More than 2 processes are reading from the same streams shard at the same time. Exceeding this limit may result in request throttling.

InvalidRestoreTimeException:

An invalid restore time was specified. RestoreDateTime must be between EarliestRestorableDateTime and LatestRestorableDateTime.

PointInTimeRecoveryUnavailableException:

Point in time recovery has not yet been enabled for this source table.

InternalServerError:

An error occurred on the server side.

Scan

$result = $client->scan([/* ... */]);
$promise = $client->scanAsync([/* ... */]);

The Scan operation returns one or more items and item attributes by accessing every item in a table or a secondary index. To have DynamoDB return fewer items, you can provide a FilterExpression operation.

If the total size of scanned items exceeds the maximum dataset size limit of 1 MB, the scan completes and results are returned to the user. The LastEvaluatedKey value is also returned and the requestor can use the LastEvaluatedKey to continue the scan in a subsequent operation. Each scan response also includes number of items that were scanned (ScannedCount) as part of the request. If using a FilterExpression, a scan result can result in no items meeting the criteria and the Count will result in zero. If you did not use a FilterExpression in the scan request, then Count is the same as ScannedCount.

A single Scan operation first reads up to the maximum number of items set (if using the Limit parameter) or a maximum of 1 MB of data and then applies any filtering to the results if a FilterExpression is provided. If LastEvaluatedKey is present in the response, pagination is required to complete the full table scan. For more information, see Paginating the Results in the Amazon DynamoDB Developer Guide.

Scan operations proceed sequentially; however, for faster performance on a large table or secondary index, applications can request a parallel Scan operation by providing the Segment and TotalSegments parameters. For more information, see Parallel Scan in the Amazon DynamoDB Developer Guide.

By default, a Scan uses eventually consistent reads when accessing the items in a table. Therefore, the results from an eventually consistent Scan may not include the latest item changes at the time the scan iterates through each item in the table. If you require a strongly consistent read of each item as the scan iterates through the items in the table, you can set the ConsistentRead parameter to true. Strong consistency only relates to the consistency of the read at the item level.

Parameter Syntax

$result = $client->scan([
    'AttributesToGet' => ['<string>', ...],
    'ConditionalOperator' => 'AND|OR',
    'ConsistentRead' => true || false,
    'ExclusiveStartKey' => [
        '<AttributeName>' => [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'ExpressionAttributeNames' => ['<string>', ...],
    'ExpressionAttributeValues' => [
        '<ExpressionAttributeValueVariable>' => [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'FilterExpression' => '<string>',
    'IndexName' => '<string>',
    'Limit' => <integer>,
    'ProjectionExpression' => '<string>',
    'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
    'ScanFilter' => [
        '<AttributeName>' => [
            'AttributeValueList' => [
                [
                    'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                    'BOOL' => true || false,
                    'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                    'L' => [
                        [...], // RECURSIVE
                        // ...
                    ],
                    'M' => [
                        '<AttributeName>' => [...], // RECURSIVE
                        // ...
                    ],
                    'N' => '<string>',
                    'NS' => ['<string>', ...],
                    'NULL' => true || false,
                    'S' => '<string>',
                    'SS' => ['<string>', ...],
                ],
                // ...
            ],
            'ComparisonOperator' => 'EQ|NE|IN|LE|LT|GE|GT|BETWEEN|NOT_NULL|NULL|CONTAINS|NOT_CONTAINS|BEGINS_WITH', // REQUIRED
        ],
        // ...
    ],
    'Segment' => <integer>,
    'Select' => 'ALL_ATTRIBUTES|ALL_PROJECTED_ATTRIBUTES|SPECIFIC_ATTRIBUTES|COUNT',
    'TableName' => '<string>', // REQUIRED
    'TotalSegments' => <integer>,
]);

Parameter Details

Result Syntax

[
    'ConsumedCapacity' => [
        'CapacityUnits' => <float>,
        'GlobalSecondaryIndexes' => [
            '<IndexName>' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            // ...
        ],
        'LocalSecondaryIndexes' => [
            '<IndexName>' => [
                'CapacityUnits' => <float>,
                'ReadCapacityUnits' => <float>,
                'WriteCapacityUnits' => <float>,
            ],
            // ...
        ],
        'ReadCapacityUnits' => <float>,
        'Table' => [
            'CapacityUnits' => <float>,
            'ReadCapacityUnits' => <float>,
            'WriteCapacityUnits' => <float>,
        ],
        'TableName' => '<string>',
        'WriteCapacityUnits' => <float>,
    ],
    'Count' => <integer>,
    'Items' => [
        [
            '<AttributeName>' => [
                'B' => <string || resource || Psr\Http\Message\StreamInterface>,
                'BOOL' => true || false,
                'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
                'L' => [
                    [...], // RECURSIVE
                    // ...
                ],
                'M' => [
                    '<AttributeName>' => [...], // RECURSIVE
                    // ...
                ],
                'N' => '<string>',
                'NS' => ['<string>', ...],
                'NULL' => true || false,
                'S' => '<string>',
                'SS' => ['<string>', ...],
            ],
            // ...
        ],
        // ...
    ],
    'LastEvaluatedKey' => [
        '<AttributeName>' => [
            'B' => <string || resource || Psr\Http\Message\StreamInterface>,
            'BOOL' => true || false,
            'BS' => [<string || resource || Psr\Http\Message\StreamInterface>, ...],
            'L' => [
                [...], // RECURSIVE
                // ...
            ],
            'M' => [
                '<AttributeName>' => [...], // RECURSIVE
                // ...
            ],
            'N' => '<string>',
            'NS' => ['<string>', ...],
            'NULL' => true || false,
            'S' => '<string>',
            'SS' => ['<string>', ...],
        ],
        // ...
    ],
    'ScannedCount' => <integer>,
]

Result Details

Errors

ProvisionedThroughputExceededException:

Your request rate is too high. The Amazon Web Services SDKs for DynamoDB automatically retry requests that receive this exception. Your request is eventually successful, unless your retry queue is too large to finish. Reduce the frequency of requests and use exponential backoff. For more information, go to Error Retries and Exponential Backoff in the Amazon DynamoDB Developer Guide.

ResourceNotFoundException:

The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be ACTIVE.

RequestLimitExceeded:

Throughput exceeds the current throughput quota for your account. Please contact Amazon Web Services Support to request a quota increase.

InternalServerError:

An error occurred on the server side.

Examples

Example 1: To scan a table

This example scans the entire Music table, and then narrows the results to songs by the artist "No One You Know". For each item, only the album title and song title are returned.

$result = $client->scan([
    'ExpressionAttributeNames' => [
        '#AT' => 'AlbumTitle',
        '#ST' => 'SongTitle',
    ],
    'ExpressionAttributeValues' => [
        ':a' => [
            'S' => 'No One You Know',
        ],
    ],
    'FilterExpression' => 'Artist = :a',
    'ProjectionExpression' => '#ST, #AT',
    'TableName' => 'Music',
]);

Result syntax:

[
    'ConsumedCapacity' => [
    ],
    'Count' => 2,
    'Items' => [
        [
            'AlbumTitle' => [
                'S' => 'Somewhat Famous',
            ],
            'SongTitle' => [
                'S' => 'Call Me Today',
            ],
        ],
        [
            'AlbumTitle' => [
                'S' => 'Blue Sky Blues',
            ],
            'SongTitle' => [
                'S' => 'Scared of My Shadow',
            ],
        ],
    ],
    'ScannedCount' => 3,
]

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Associate a set of tags with an Amazon DynamoDB resource. You can then activate these user-defined tags so that they appear on the Billing and Cost Management console for cost allocation tracking. You can call TagResource up to five times per second, per account.

• TagResource is an asynchronous operation. If you issue a ListTagsOfResource request immediately after a TagResource request, DynamoDB might return your previous tag set, if there was one, or an empty tag set. This is because ListTagsOfResource uses an eventually consistent query, and the metadata for your tags or table might not be available at that moment. Wait for a few seconds, and then try the ListTagsOfResource request again.

• The application or removal of tags using TagResource and UntagResource APIs is eventually consistent. ListTagsOfResource API will only reflect the changes after a few seconds.

For an overview on tagging DynamoDB resources, see Tagging for DynamoDB in the Amazon DynamoDB Developer Guide.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details