SDK for PHP 3.x

ContinuousBackupsUnavailableException:

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.

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.

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.

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.

This documentation is for version 2017.11.29 (Legacy) of global tables, which should be avoided for new global tables. Customers should use Global Tables version 2019.11.21 (Current) when possible, because it provides greater flexibility, higher efficiency, and consumes less write capacity than 2017.11.29 (Legacy).

To determine which version you're using, see Determining the global table version you are using. To update existing global tables from version 2017.11.29 (Legacy) to version 2019.11.21 (Current), see Upgrading global tables.

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).

Write capacity settings should be set consistently across your replica tables and secondary indexes. DynamoDB strongly recommends enabling auto scaling to manage the write capacity settings for all of your global tables replicas and indexes.

If you prefer to manage write capacity settings manually, you should provision equal replicated write capacity units to your replica tables. You should also provision equal replicated write capacity units to matching secondary indexes across your global table.

Parameter Syntax

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

Parameter Details

Members

GlobalTableName

: Required: Yes
: Type: string

The global table name.

ReplicationGroup

: Required: Yes
: Type: Array of Replica structures

The Regions where the global table needs to be created.

Result Syntax

[
    'GlobalTableDescription' => [
        'CreationDateTime' => <DateTime>,
        'GlobalTableArn' => '<string>',
        'GlobalTableName' => '<string>',
        'GlobalTableStatus' => 'CREATING|ACTIVE|DELETING|UPDATING',
        'ReplicationGroup' => [
            [
                'GlobalSecondaryIndexes' => [
                    [
                        'IndexName' => '<string>',
                        'OnDemandThroughputOverride' => [
                            'MaxReadRequestUnits' => <integer>,
                        ],
                        'ProvisionedThroughputOverride' => [
                            'ReadCapacityUnits' => <integer>,
                        ],
                        'WarmThroughput' => [
                            'ReadUnitsPerSecond' => <integer>,
                            'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
                            'WriteUnitsPerSecond' => <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',
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
                    'WriteUnitsPerSecond' => <integer>,
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members

GlobalTableDescription

: Type: GlobalTableDescription structure

Contains the details of the global table.

Errors

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

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.

GlobalTableAlreadyExistsException:

An error occurred on the server side.

The specified global table already exists.

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
            ],
            'WarmThroughput' => [
                'ReadUnitsPerSecond' => <integer>,
                'WriteUnitsPerSecond' => <integer>,
            ],
        ],
        // ...
    ],
    '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
        ],
        // ...
    ],
    'WarmThroughput' => [
        'ReadUnitsPerSecond' => <integer>,
        'WriteUnitsPerSecond' => <integer>,
    ],
]);

Parameter Details

Members

AttributeDefinitions

: Required: Yes
: Type: Array of AttributeDefinition structures

An array of attributes that describe the key schema for the table and indexes.

BillingMode

: Type: string

Controls how you are charged for read and write throughput and how you manage capacity. This setting can be changed later.

PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

DeletionProtectionEnabled

: Type: boolean

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

GlobalSecondaryIndexes

: Type: Array of GlobalSecondaryIndex structures

One or more global secondary indexes (the maximum is 20) to be created on the table. Each global secondary index in the array includes the following:

IndexName - The name of the global secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the global secondary index.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
- ProjectionType - One of the following:
  - KEYS_ONLY - Only the index and primary keys are projected into the index.
  - INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.
  - ALL - All of the table attributes are projected into the index.
- NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.
ProvisionedThroughput - The provisioned throughput settings for the global secondary index, consisting of read and write capacity units.

KeySchema

: Required: Yes
: Type: Array of KeySchemaElement structures

Specifies the attributes that make up the primary key for a table or an index. The attributes in KeySchema must also be defined in the AttributeDefinitions array. For more information, see Data Model in the Amazon DynamoDB Developer Guide.

Each KeySchemaElement in the array is composed of:

AttributeName - The name of this key attribute.
KeyType - The role that the key attribute will assume:
- HASH - partition key
- RANGE - sort key

The partition key of an item is also known as its hash attribute. The term "hash attribute" derives from the DynamoDB usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.

The sort key of an item is also known as its range attribute. The term "range attribute" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.

For a simple primary key (partition key), you must provide exactly one element with a KeyType of HASH.

For a composite primary key (partition key and sort key), you must provide exactly two elements, in this order: The first element must have a KeyType of HASH, and the second element must have a KeyType of RANGE.

For more information, see Working with Tables in the Amazon DynamoDB Developer Guide.

LocalSecondaryIndexes

: Type: Array of LocalSecondaryIndex structures

One or more local secondary indexes (the maximum is 5) to be created on the table. Each index is scoped to a given partition key value. There is a 10 GB size limit per partition key value; otherwise, the size of a local secondary index is unconstrained.

Each local secondary index in the array includes the following:

IndexName - The name of the local secondary index. Must be unique only for this table.
KeySchema - Specifies the key schema for the local secondary index. The key schema must begin with the same partition key as the table.
Projection - Specifies attributes that are copied (projected) from the table into the index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Each attribute specification is composed of:
- ProjectionType - One of the following:
  - KEYS_ONLY - Only the index and primary keys are projected into the index.
  - INCLUDE - Only the specified table attributes are projected into the index. The list of projected attributes is in NonKeyAttributes.
  - ALL - All of the table attributes are projected into the index.
- NonKeyAttributes - A list of one or more non-key attribute names that are projected into the secondary index. The total count of attributes provided in NonKeyAttributes, summed across all of the secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total.

OnDemandThroughput

: Type: OnDemandThroughput structure

Sets the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

ProvisionedThroughput

: Type: ProvisionedThroughput structure

Represents the provisioned throughput settings for a specified table or index. The settings can be modified using the UpdateTable operation.

If you set BillingMode as PROVISIONED, you must specify this property. If you set BillingMode as PAY_PER_REQUEST, you cannot specify this property.

For current minimum and maximum provisioned throughput values, see Service, Account, and Table Quotas in the Amazon DynamoDB Developer Guide.

ResourcePolicy

: Type: string

An Amazon Web Services resource-based policy document in JSON format that will be attached to the table.

When you attach a resource-based policy while creating a table, the policy application is strongly consistent.

The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit. For a full list of all considerations that apply for resource-based policies, see Resource-based policy considerations.

You need to specify the CreateTable and PutResourcePolicy IAM actions for authorizing a user to create a table with a resource-based policy.

SSESpecification

: Type: SSESpecification structure

Represents the settings used to enable server-side encryption.

StreamSpecification

: Type: StreamSpecification structure

The settings for DynamoDB Streams on the table. These settings consist of:

StreamEnabled - Indicates whether DynamoDB Streams is to be enabled (true) or disabled (false).
StreamViewType - When an item in the table is modified, StreamViewType determines what information is written to the table's stream. Valid values for StreamViewType are:
- KEYS_ONLY - Only the key attributes of the modified item are written to the stream.
- NEW_IMAGE - The entire item, as it appears after it was modified, is written to the stream.
- OLD_IMAGE - The entire item, as it appeared before it was modified, is written to the stream.
- NEW_AND_OLD_IMAGES - Both the new and the old item images of the item are written to the stream.

TableClass

: Type: string

The table class of the new table. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

TableName

: Required: Yes
: Type: string

The name of the table to create. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Tags

: Type: Array of Tag structures

A list of key-value pairs to label the table. For more information, see Tagging for DynamoDB.

WarmThroughput

: Type: WarmThroughput structure

Represents the warm throughput (in read units per second and write units per second) for creating a table.

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>,
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
                    'WriteUnitsPerSecond' => <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>,
                        ],
                        'WarmThroughput' => [
                            'ReadUnitsPerSecond' => <integer>,
                            'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
                            'WriteUnitsPerSecond' => <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',
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
                    'WriteUnitsPerSecond' => <integer>,
                ],
            ],
            // ...
        ],
        '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',
        'WarmThroughput' => [
            'ReadUnitsPerSecond' => <integer>,
            'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
            'WriteUnitsPerSecond' => <integer>,
        ],
    ],
]

Result Details

Members

TableDescription

: Type: TableDescription structure

Represents the properties of the table.

Errors

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.

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

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.

BackupNotFoundException:

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

Members

BackupArn

: Required: Yes
: Type: string

The ARN associated with the backup.

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

Members

BackupDescription

: Type: BackupDescription structure

Contains the description of the backup created for the table.

Errors

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.

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

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.

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

Members

ConditionExpression

: Type: string

A condition that must be satisfied in order for a conditional DeleteItem to succeed.

An expression can contain any of the following:

Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT

For more information about condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.

ConditionalOperator

: Type: string

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Expected

: Type: Associative array of custom strings keys (AttributeName) to ExpectedAttributeValue structures

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

ExpressionAttributeNames

: Type: Associative array of custom strings keys (ExpressionAttributeNameVariable) to strings

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide). To work around this, you could specify the following for ExpressionAttributeNames:

{"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

#P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

ExpressionAttributeValues

: Type: Associative array of custom strings keys (ExpressionAttributeValueVariable) to AttributeValue structures

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Key

: Required: Yes
: Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures

A map of attribute names to AttributeValue objects, representing the primary key of the item to delete.

For the primary key, you must provide all of the key attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

ReturnConsumedCapacity

: Type: string

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.

ReturnItemCollectionMetrics

: Type: string

ReturnValues

: Type: string

Use ReturnValues if you want to get the item attributes as they appeared before they were deleted. For DeleteItem, the valid values are:

NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - The content of the old item is returned.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

The ReturnValues parameter is used by several DynamoDB operations; however, DeleteItem does not recognize any values other than NONE or ALL_OLD.

ReturnValuesOnConditionCheckFailure

: Type: string

An optional parameter that returns the item attributes for a DeleteItem operation that failed a condition check.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

TableName

: Required: Yes
: Type: string

The name of the table from which to delete the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

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

Members

Attributes

: Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures

A map of attribute names to AttributeValue objects, representing the item as it appeared before the DeleteItem operation. This map appears in the response only if ReturnValues was specified as ALL_OLD in the request.

ConsumedCapacity

: Type: ConsumedCapacity structure

The capacity units consumed by the DeleteItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Provisioned capacity mode in the Amazon DynamoDB Developer Guide.

ItemCollectionMetrics

: Type: ItemCollectionMetrics structure

Information about item collections, if any, that were affected by the DeleteItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.
SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

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.

To make sure that you don't inadvertently lock yourself out of your own resources, the root principal in your Amazon Web Services account can perform DeleteResourcePolicy requests, even if your resource-based policy explicitly denies the root principal's access.

DeleteResourcePolicy is an asynchronous operation. If you issue a GetResourcePolicy request immediately after running the DeleteResourcePolicy request, DynamoDB might still return the deleted policy. This is because the policy for your resource might not have been deleted yet. Wait for a few seconds, and then try the GetResourcePolicy request again.

Parameter Syntax

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

Parameter Details

Members

ExpectedRevisionId

: Type: string

A string value that you can use to conditionally delete your policy. When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, the request will fail and return a PolicyNotFoundException.

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the DynamoDB resource from which the policy will be removed. The resources you can specify include tables and streams. If you remove the policy of a table, it will also remove the permissions for the table's indexes defined in that policy document. This is because index permissions are defined in the table's policy.

Result Syntax

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

Result Details

Members

RevisionId

: Type: string

A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.

This value will be empty if you make a request against a resource without a policy.

Errors

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

PolicyNotFoundException:

An error occurred on the server side.

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.

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.

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

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.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

DynamoDB might continue to accept data read and write operations, such as GetItem and PutItem, on a table in the DELETING state until the table deletion is complete. For the full list of table states, see TableStatus.

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

Members

TableName

: Required: Yes
: Type: string

The name of the table to delete. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

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>,
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
                    'WriteUnitsPerSecond' => <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>,
                        ],
                        'WarmThroughput' => [
                            'ReadUnitsPerSecond' => <integer>,
                            'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
                            'WriteUnitsPerSecond' => <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',
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
                    'WriteUnitsPerSecond' => <integer>,
                ],
            ],
            // ...
        ],
        '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',
        'WarmThroughput' => [
            'ReadUnitsPerSecond' => <integer>,
            'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
            'WriteUnitsPerSecond' => <integer>,
        ],
    ],
]

Result Details

Members

TableDescription

: Type: TableDescription structure

Represents the properties of a table.

Errors

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.

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

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

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.

ExportNotFoundException:

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

Members

BackupArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) associated with the backup.

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

Members

BackupDescription

: Type: BackupDescription structure

Contains the description of the backup created for the table.

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

Members

TableName

: Required: Yes
: Type: string

Name of the table for which the customer wants to check the continuous backups and point in time recovery settings.

You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Result Syntax

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

Result Details

Members

ContinuousBackupsDescription

: Type: ContinuousBackupsDescription structure

Represents the continuous backups and point in time recovery settings on the table.

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

Members

IndexName

: Type: string

The name of the global secondary index to describe, if applicable.

TableName

: Required: Yes
: Type: string

The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Result Syntax

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

Result Details

Members

ContributorInsightsRuleList

: Type: Array of strings

List of names of the associated contributor insights rules.

ContributorInsightsStatus

: Type: string

Current status of contributor insights.

FailureException

: Type: FailureException structure

Returns information about the last failure that was encountered.

The most common exceptions for a FAILED status are:

LimitExceededException - Per-account Amazon CloudWatch Contributor Insights rule limit reached. Please disable Contributor Insights for other tables/indexes OR disable Contributor Insights rules before retrying.
AccessDeniedException - Amazon CloudWatch Contributor Insights rules cannot be modified due to insufficient permissions.
AccessDeniedException - Failed to create service-linked role for Contributor Insights due to insufficient permissions.
InternalServerError - Failed to create Amazon CloudWatch Contributor Insights rules. Please retry request.

IndexName

: Type: string

The name of the global secondary index being described.

LastUpdateDateTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Timestamp of the last time the status was changed.

TableName

: Type: string

The name of the table being described.

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

Members

Result Syntax

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

Result Details

Members

Endpoints

: Required: Yes
: Type: Array of Endpoint structures

List of endpoints.

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

Members

ExportArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) associated with the export.

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

Members

ExportDescription

: Type: ExportDescription structure

Represents the properties of the export.

Errors

The specified export was not found.

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

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.

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

Members

GlobalTableName

: Required: Yes
: Type: string

The name of the global table.

Result Syntax

[
    'GlobalTableDescription' => [
        'CreationDateTime' => <DateTime>,
        'GlobalTableArn' => '<string>',
        'GlobalTableName' => '<string>',
        'GlobalTableStatus' => 'CREATING|ACTIVE|DELETING|UPDATING',
        'ReplicationGroup' => [
            [
                'GlobalSecondaryIndexes' => [
                    [
                        'IndexName' => '<string>',
                        'OnDemandThroughputOverride' => [
                            'MaxReadRequestUnits' => <integer>,
                        ],
                        'ProvisionedThroughputOverride' => [
                            'ReadCapacityUnits' => <integer>,
                        ],
                        'WarmThroughput' => [
                            'ReadUnitsPerSecond' => <integer>,
                            'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
                            'WriteUnitsPerSecond' => <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',
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
                    'WriteUnitsPerSecond' => <integer>,
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members

GlobalTableDescription

: Type: GlobalTableDescription structure

Contains the details of the global table.

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

Members

GlobalTableName

: Required: Yes
: Type: string

The name of the global table to describe.

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

Members

GlobalTableName

: Type: string

The name of the global table.

ReplicaSettings

: Type: Array of ReplicaSettingsDescription structures

The Region-specific settings for the global table.

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

Members

ImportArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) associated with the table you're importing to.

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>,
                    ],
                    'WarmThroughput' => [
                        'ReadUnitsPerSecond' => <integer>,
                        'WriteUnitsPerSecond' => <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

Members

ImportTableDescription

: Required: Yes
: Type: ImportTableDescription structure

Represents the properties of the table created for the import, and parameters of the import. The import parameters include import status, how many items were processed, and how many errors were encountered.

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

Members

TableName

: Required: Yes
: Type: string

The name of the table being described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Result Syntax

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

Result Details

Members

KinesisDataStreamDestinations

: Type: Array of KinesisDataStreamDestination structures

The list of replica structures for the table being described.

TableName

: Type: string

The name of the table being described.

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:

Call DescribeLimits for a particular Region to obtain your current account quotas on provisioned capacity there.
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.
Call ListTables to obtain a list of all your DynamoDB tables.
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.
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.

DescribeLimits should only be called periodically. You can expect throttling errors if you call it more than once in a minute.

The DescribeLimits Request element has no content.

Parameter Syntax

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

Parameter Details

Members

Result Syntax

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

Result Details

Members

AccountMaxReadCapacityUnits

: Type: long (int|float)

The maximum total read capacity units that your account allows you to provision across all of your tables in this Region.

AccountMaxWriteCapacityUnits

: Type: long (int|float)

The maximum total write capacity units that your account allows you to provision across all of your tables in this Region.

TableMaxReadCapacityUnits

: Type: long (int|float)

The maximum read capacity units that your account allows you to provision for a new table that you are creating in this Region, including the read capacity units provisioned for its global secondary indexes (GSIs).

TableMaxWriteCapacityUnits

: Type: long (int|float)

The maximum write capacity units that your account allows you to provision for a new table that you are creating in this Region, including the write capacity units provisioned for its global secondary indexes (GSIs).

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.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

If you issue a DescribeTable request immediately after a CreateTable request, DynamoDB might return a ResourceNotFoundException. This is because DescribeTable uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the DescribeTable request again.

Parameter Syntax

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

Parameter Details

Members

TableName

: Required: Yes
: Type: string

The name of the table to describe. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

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>,
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
                    'WriteUnitsPerSecond' => <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>,
                        ],
                        'WarmThroughput' => [
                            'ReadUnitsPerSecond' => <integer>,
                            'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
                            'WriteUnitsPerSecond' => <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',
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
                    'WriteUnitsPerSecond' => <integer>,
                ],
            ],
            // ...
        ],
        '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',
        'WarmThroughput' => [
            'ReadUnitsPerSecond' => <integer>,
            'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
            'WriteUnitsPerSecond' => <integer>,
        ],
    ],
]

Result Details

Members

Table

: Type: TableDescription structure

The properties of the table.

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.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

Parameter Syntax

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

Parameter Details

Members

TableName

: Required: Yes
: Type: string

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

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

Members

TableAutoScalingDescription

: Type: TableAutoScalingDescription structure

Represents the auto scaling properties of the table.

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

Members

TableName

: Required: Yes
: Type: string

The name of the table to be described. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Result Syntax

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

Result Details

Members

TimeToLiveDescription

: Type: TimeToLiveDescription structure

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

Members

EnableKinesisStreamingConfiguration

: Type: EnableKinesisStreamingConfiguration structure

The source for the Kinesis streaming information that is being enabled.

StreamArn

: Required: Yes
: Type: string

The ARN for a Kinesis data stream.

TableName

: Required: Yes
: Type: string

The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Result Syntax

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

Result Details

Members

DestinationStatus

: Type: string

The current status of the replication.

EnableKinesisStreamingConfiguration

: Type: EnableKinesisStreamingConfiguration structure

The destination for the Kinesis streaming information that is being enabled.

StreamArn

: Type: string

The ARN for the specific Kinesis data stream.

TableName

: Type: string

The name of the table being modified.

Errors

An error occurred on the server side.

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

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.

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.

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

Members

EnableKinesisStreamingConfiguration

: Type: EnableKinesisStreamingConfiguration structure

The source for the Kinesis streaming information that is being enabled.

StreamArn

: Required: Yes
: Type: string

The ARN for a Kinesis data stream.

TableName

: Required: Yes
: Type: string

The name of the DynamoDB table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Result Syntax

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

Result Details

Members

DestinationStatus

: Type: string

The current status of the replication.

EnableKinesisStreamingConfiguration

: Type: EnableKinesisStreamingConfiguration structure

The destination for the Kinesis streaming information that is being enabled.

StreamArn

: Type: string

The ARN for the specific Kinesis data stream.

TableName

: Type: string

The name of the table being modified.

Errors

An error occurred on the server side.

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

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.

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.

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

Members

ConsistentRead

: Type: boolean

The consistency of a read operation. If set to true, then a strongly consistent read is used; otherwise, an eventually consistent read is used.

Limit

: Type: int

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, along with a key in LastEvaluatedKey to apply in a subsequent operation so you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation.

NextToken

: Type: string

Set this value to get remaining results, if NextToken was returned in the statement response.

Parameters

: Type: Array of AttributeValue structures

The parameters for the PartiQL statement, if any.

ReturnConsumedCapacity

: Type: string

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.

ReturnValuesOnConditionCheckFailure

: Type: string

An optional parameter that returns the item attributes for an ExecuteStatement operation that failed a condition check.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

Statement

: Required: Yes
: Type: string

The PartiQL statement representing the operation to run.

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

Members

ConsumedCapacity

: Type: ConsumedCapacity structure

The capacity units consumed by an operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the request asked for it. For more information, see Provisioned capacity mode in the Amazon DynamoDB Developer Guide.

Items

: Type: Array of AttributeValue structuress

If a read operation was used, this property will contain the result of the read operation; a map of attribute names and their values. For the write operations this value will be empty.

LastEvaluatedKey

: Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request. If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved. If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

NextToken

: Type: string

If the response of a read request exceeds the response payload limit DynamoDB will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results.

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.

The entire transaction must consist of either read statements or write statements, you cannot mix both in one transaction. The EXISTS function is an exception and can be used to check the condition of specific attributes of the item in a similar manner to ConditionCheck in the TransactWriteItems API.

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

Members

ClientRequestToken

: Type: string

Set this value to get remaining results, if NextToken was returned in the statement response.

ReturnConsumedCapacity

: Type: string

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response. For more information, see TransactGetItems and TransactWriteItems.

TransactStatements

: Required: Yes
: Type: Array of ParameterizedStatement structures

The list of PartiQL statements representing the transaction to run.

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

Members

ConsumedCapacity

: Type: Array of ConsumedCapacity structures

The capacity units consumed by the entire operation. The values of the list are ordered according to the ordering of the statements.

Responses

: Type: Array of ItemResponse structures

The response to a PartiQL transaction.

Errors

TransactionCanceledException:

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

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.

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

Members

ClientToken

: Type: string

Providing a ClientToken makes the call to ExportTableToPointInTimeInput idempotent, meaning that multiple identical calls have the same effect as one single call.

A client token is valid for 8 hours after the first request that uses it is completed. After 8 hours, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 8 hours, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an ImportConflictException.

ExportFormat

: Type: string

The format for the exported data. Valid values for ExportFormat are DYNAMODB_JSON or ION.

ExportTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Time in the past from which to export table data, counted in seconds from the start of the Unix epoch. The table export will be a snapshot of the table's state at this point in time.

ExportType

: Type: string

Choice of whether to execute as a full export or incremental export. Valid values are FULL_EXPORT or INCREMENTAL_EXPORT. The default value is FULL_EXPORT. If INCREMENTAL_EXPORT is provided, the IncrementalExportSpecification must also be used.

IncrementalExportSpecification

: Type: IncrementalExportSpecification structure

Optional object containing the parameters specific to an incremental export.

S3Bucket

: Required: Yes
: Type: string

The name of the Amazon S3 bucket to export the snapshot to.

S3BucketOwner

: Type: string

The ID of the Amazon Web Services account that owns the bucket the export will be stored in.

S3BucketOwner is a required parameter when exporting to a S3 bucket in another account.

S3Prefix

: Type: string

The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.

S3SseAlgorithm

: Type: string

Type of encryption used on the bucket where export data will be stored. Valid values for S3SseAlgorithm are:

AES256 - server-side encryption with Amazon S3 managed keys
KMS - server-side encryption with KMS managed keys

S3SseKmsKeyId

: Type: string

The ID of the KMS managed key used to encrypt the S3 bucket where export data will be stored (if applicable).

TableArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) associated with the table to export.

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

Members

ExportDescription

: Type: ExportDescription structure

Contains a description of the table export.

Errors

PointInTimeRecoveryUnavailableException:

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.

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

InvalidExportTimeException:

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

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.

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

ExportConflictException:

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

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

Members

AttributesToGet

: Type: Array of strings

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

ConsistentRead

: Type: boolean

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

ExpressionAttributeNames

: Type: Associative array of custom strings keys (ExpressionAttributeNameVariable) to strings

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

Percentile

{"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

#P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

Key

: Required: Yes
: Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures

A map of attribute names to AttributeValue objects, representing the primary key of the item to retrieve.

For the primary key, you must provide all of the attributes. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide values for both the partition key and the sort key.

ProjectionExpression

: Type: string

A string that identifies one or more attributes to retrieve from the table. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes are returned. If any of the requested attributes are not found, they do not appear in the result.

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

ReturnConsumedCapacity

: Type: string

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.

TableName

: Required: Yes
: Type: string

The name of the table containing the requested item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

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

Members

ConsumedCapacity

: Type: ConsumedCapacity structure

The capacity units consumed by the GetItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.

Item

: Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures

A map of attribute names to AttributeValue objects, as specified by ProjectionExpression.

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

Members

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy is attached. The resources you can specify include tables and streams.

Result Syntax

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

Result Details

Members

Policy

: Type: string

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

RevisionId

: Type: string

A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.

Errors

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

PolicyNotFoundException:

An error occurred on the server side.

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
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'WriteUnitsPerSecond' => <integer>,
                ],
            ],
            // ...
        ],
        '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

Members

ClientToken

: Type: string

Providing a ClientToken makes the call to ImportTableInput idempotent, meaning that multiple identical calls have the same effect as one single call.

If you submit a request with the same client token but a change in other parameters within the 8-hour idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

InputCompressionType

: Type: string

Type of compression to be used on the input coming from the imported table.

InputFormat

: Required: Yes
: Type: string

The format of the source data. Valid values for ImportFormat are CSV, DYNAMODB_JSON or ION.

InputFormatOptions

: Type: InputFormatOptions structure

Additional properties that specify how the input is formatted,

S3BucketSource

: Required: Yes
: Type: S3BucketSource structure

The S3 bucket that provides the source for the import.

TableCreationParameters

: Required: Yes
: Type: TableCreationParameters structure

Parameters for the table to import the data into.

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>,
                    ],
                    'WarmThroughput' => [
                        'ReadUnitsPerSecond' => <integer>,
                        'WriteUnitsPerSecond' => <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

Members

ImportTableDescription

: Required: Yes
: Type: ImportTableDescription structure

Errors

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.

ImportConflictException:

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

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.

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

Members

BackupType

: Type: string

The backups from the table specified by BackupType are listed.

Where BackupType can be:

USER - On-demand backup created by you. (The default setting if no other backup types are specified.)
SYSTEM - On-demand backup automatically created by DynamoDB.
ALL - All types of on-demand backups (USER and SYSTEM).

ExclusiveStartBackupArn

: Type: string

LastEvaluatedBackupArn is the Amazon Resource Name (ARN) of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

Limit

: Type: int

Maximum number of backups to return at once.

TableName

: Type: string

Lists the backups from the table specified in TableName. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

TimeRangeLowerBound

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Only backups created after this time are listed. TimeRangeLowerBound is inclusive.

TimeRangeUpperBound

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Only backups created before this time are listed. TimeRangeUpperBound is exclusive.

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

Members

BackupSummaries

: Type: Array of BackupSummary structures

List of BackupSummary objects.

LastEvaluatedBackupArn

: Type: string

The ARN of the backup last evaluated when the current page of results was returned, inclusive of the current page of results. This value may be specified as the ExclusiveStartBackupArn of a new ListBackups operation in order to fetch the next page of results.

If LastEvaluatedBackupArn is empty, then the last page of results has been processed and there are no more results to be retrieved.

If LastEvaluatedBackupArn is not empty, this may or may not indicate that there is more data to be returned. All results are guaranteed to have been returned if and only if no value for LastEvaluatedBackupArn is returned.

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

Members

MaxResults

: Type: int

Maximum number of results to return per page.

NextToken

: Type: string

A token to for the desired page, if there is one.

TableName

: Type: string

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Result Syntax

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

Result Details

Members

ContributorInsightsSummaries

: Type: Array of ContributorInsightsSummary structures

A list of ContributorInsightsSummary.

NextToken

: Type: string

A token to go to the next page if there is one.

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

Members

MaxResults

: Type: int

Maximum number of results to return per page.

NextToken

: Type: string

An optional string that, if supplied, must be copied from the output of a previous call to ListExports. When provided in this manner, the API fetches the next page of results.

TableArn

: Type: string

The Amazon Resource Name (ARN) associated with the exported table.

Result Syntax

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

Result Details

Members

ExportSummaries

: Type: Array of ExportSummary structures

A list of ExportSummary objects.

NextToken

: Type: string

If this value is returned, there are additional results to be displayed. To retrieve them, call ListExports again, with NextToken set to this value.

Errors

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

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.

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

Members

ExclusiveStartGlobalTableName

: Type: string

The first global table name that this operation will evaluate.

Limit

: Type: int

The maximum number of table names to return, if the parameter is not specified DynamoDB defaults to 100.

If the number of global tables DynamoDB finds reaches this limit, it stops the operation and returns the table names collected up to that point, with a table name in the LastEvaluatedGlobalTableName to apply in a subsequent operation to the ExclusiveStartGlobalTableName parameter.

RegionName

: Type: string

Lists the global tables in a specific Region.

Result Syntax

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

Result Details

Members

GlobalTables

: Type: Array of GlobalTable structures

List of global table names.

LastEvaluatedGlobalTableName

: Type: string

Last evaluated global table name.

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

Members

NextToken

: Type: string

An optional string that, if supplied, must be copied from the output of a previous call to ListImports. When provided in this manner, the API fetches the next page of results.

PageSize

: Type: int

The number of ImportSummary objects returned in a single page.

TableArn

: Type: string

The Amazon Resource Name (ARN) associated with the table that was imported to.

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

Members

ImportSummaryList

: Type: Array of ImportSummary structures

A list of ImportSummary objects.

NextToken

: Type: string

If this value is returned, there are additional results to be displayed. To retrieve them, call ListImports again, with NextToken set to this value.

Errors

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

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

Members

ExclusiveStartTableName

: Type: string

The first table name that this operation will evaluate. Use the value that was returned for LastEvaluatedTableName in a previous operation, so that you can obtain the next page of results.

Limit

: Type: int

A maximum number of table names to return. If this parameter is not specified, the limit is 100.

Result Syntax

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

Result Details

Members

LastEvaluatedTableName

: Type: string

The name of the last table in the current page of results. Use this value as the ExclusiveStartTableName in a new request to obtain the next page of results, until all the table names are returned.

If you do not receive a LastEvaluatedTableName value in the response, this means that there are no more table names to be retrieved.

TableNames

: Type: Array of strings

The names of the tables associated with the current account at the current endpoint. The maximum size of this array is 100.

If LastEvaluatedTableName also appears in the output, you can use this value as the ExclusiveStartTableName parameter in a subsequent ListTables request and obtain the next page of results.

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

Members

NextToken

: Type: string

An optional string that, if supplied, must be copied from the output of a previous call to ListTagOfResource. When provided in this manner, this API fetches the next page of results.

ResourceArn

: Required: Yes
: Type: string

The Amazon DynamoDB resource with tags to be listed. This value is an Amazon Resource Name (ARN).

Result Syntax

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

Result Details

Members

NextToken

: Type: string

If this value is returned, there are additional results to be displayed. To retrieve them, call ListTagsOfResource again, with NextToken set to this value.

Tags

: Type: Array of Tag structures

The tags currently associated with the Amazon DynamoDB resource.

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.

To prevent a new item from replacing an existing item, use a conditional expression that contains the attribute_not_exists function with the name of the attribute being used as the partition key for the table. Since every record must contain that attribute, the attribute_not_exists function will only succeed if no matching item exists.

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

Members

ConditionExpression

: Type: string

A condition that must be satisfied in order for a conditional PutItem operation to succeed.

An expression can contain any of the following:

Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT

For more information on condition expressions, see Condition Expressions in the Amazon DynamoDB Developer Guide.

ConditionalOperator

: Type: string

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Expected

: Type: Associative array of custom strings keys (AttributeName) to ExpectedAttributeValue structures

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

ExpressionAttributeNames

: Type: Associative array of custom strings keys (ExpressionAttributeNameVariable) to strings

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

Percentile

{"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

#P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

ExpressionAttributeValues

: Type: Associative array of custom strings keys (ExpressionAttributeValueVariable) to AttributeValue structures

One or more values that can be substituted in an expression.

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Item

: Required: Yes
: Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures

A map of attribute name/value pairs, one for each attribute. Only the primary key attributes are required; you can optionally provide other attribute name-value pairs for the item.

You must provide all of the attributes for the primary key. For example, with a simple primary key, you only need to provide a value for the partition key. For a composite primary key, you must provide both values for both the partition key and the sort key.

If you specify any attributes that are part of an index key, then the data types for those attributes must match those of the schema in the table's attribute definition.

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.

For more information about primary keys, see Primary Key in the Amazon DynamoDB Developer Guide.

Each element in the Item map is an AttributeValue object.

ReturnConsumedCapacity

: Type: string

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.

ReturnItemCollectionMetrics

: Type: string

ReturnValues

: Type: string

Use ReturnValues if you want to get the item attributes as they appeared before they were updated with the PutItem request. For PutItem, the valid values are:

NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - If PutItem overwrote an attribute name-value pair, then the content of the old item is returned.

The values returned are strongly consistent.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

The ReturnValues parameter is used by several DynamoDB operations; however, PutItem does not recognize any values other than NONE or ALL_OLD.

ReturnValuesOnConditionCheckFailure

: Type: string

An optional parameter that returns the item attributes for a PutItem operation that failed a condition check.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

TableName

: Required: Yes
: Type: string

The name of the table to contain the item. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

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

Members

Attributes

: Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures

The attribute values as they appeared before the PutItem operation, but only if ReturnValues is specified as ALL_OLD in the request. Each element consists of an attribute name and an attribute value.

ConsumedCapacity

: Type: ConsumedCapacity structure

The capacity units consumed by the PutItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide.

ItemCollectionMetrics

: Type: ItemCollectionMetrics structure

Information about item collections, if any, that were affected by the PutItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.
SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

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.

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

Parameter Syntax

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

Parameter Details

Members

ConfirmRemoveSelfResourceAccess

: Type: boolean

Set this parameter to true to confirm that you want to remove your permissions to change the policy of this resource in the future.

ExpectedRevisionId

: Type: string

A string value that you can use to conditionally update your policy. You can provide the revision ID of your existing policy to make mutating requests against that policy.

When you provide an expected revision ID, if the revision ID of the existing policy on the resource doesn't match or if there's no policy attached to the resource, your request will be rejected with a PolicyNotFoundException.

To conditionally attach a policy when no policy exists for the resource, specify NO_POLICY for the revision ID.

Policy

: Required: Yes
: Type: string

An Amazon Web Services resource-based policy document in JSON format.

The maximum size supported for a resource-based policy document is 20 KB. DynamoDB counts whitespaces when calculating the size of a policy against this limit.
Within a resource-based policy, if the action for a DynamoDB service-linked role (SLR) to replicate data for a global table is denied, adding or deleting a replica will fail with an error.

For a full list of all considerations that apply while attaching a resource-based policy, see Resource-based policy considerations.

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the DynamoDB resource to which the policy will be attached. The resources you can specify include tables and streams.

You can control index permissions using the base table's policy. To specify the same permission level for your table and its indexes, you can provide both the table and index Amazon Resource Name (ARN)s in the Resource field of a given Statement in your policy document. Alternatively, to specify different permissions for your table, indexes, or both, you can define multiple Statement fields in your policy document.

Result Syntax

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

Result Details

Members

RevisionId

: Type: string

A unique string that represents the revision ID of the policy. If you're comparing revision IDs, make sure to always use string comparison logic.

Errors

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

An error occurred on the server side.

PolicyNotFoundException:

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

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.

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.

TableAlreadyExistsException:

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.

DynamoDB calculates the number of read capacity units consumed based on item size, not on the amount of data that is returned to an application. The number of capacity units consumed will be the same whether you request all of the attributes (the default behavior) or just some of them (using a projection expression). The number will also be the same whether or not you use a FilterExpression.

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.

A Query operation can return an empty result set and a LastEvaluatedKey if all the items read for the page of results are filtered out.

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

Members

AttributesToGet

: Type: Array of strings

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

ConditionalOperator

: Type: string

This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

ConsistentRead

: Type: boolean

Determines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.

Strongly consistent reads are not supported on global secondary indexes. If you query a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

ExclusiveStartKey

: Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number, or Binary. No set data types are allowed.

ExpressionAttributeNames

: Type: Associative array of custom strings keys (ExpressionAttributeNameVariable) to strings

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

Percentile

{"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

#P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

ExpressionAttributeValues

: Type: Associative array of custom strings keys (ExpressionAttributeValueVariable) to AttributeValue structures

One or more values that can be substituted in an expression.

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

FilterExpression

: Type: string

A string that contains conditions that DynamoDB applies after the Query operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression does not allow key attributes. You cannot define a filter expression based on a partition key or a sort key.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

IndexName

: Type: string

The name of an index to query. This index can be any local secondary index or global secondary index on the table. Note that if you use the IndexName parameter, you must also provide TableName.

KeyConditionExpression

: Type: string

The condition that specifies the key values for items to be retrieved by the Query action.

The condition must perform an equality test on a single partition key value.

The condition can optionally perform one of several comparison tests on a single sort key value. This allows Query to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.

The partition key equality test is required, and must be specified in the following format:

partitionKeyName = :partitionkeyval

If you also want to provide a condition for the sort key, it must be combined using AND with the condition for the sort key. Following is an example, using the = comparison operator for the sort key:

partitionKeyName = :partitionkeyval AND sortKeyName = :sortkeyval

Valid comparisons for the sort key condition are as follows:

sortKeyName = :sortkeyval - true if the sort key value is equal to :sortkeyval.
sortKeyName < :sortkeyval - true if the sort key value is less than :sortkeyval.
sortKeyName <= :sortkeyval - true if the sort key value is less than or equal to :sortkeyval.
sortKeyName > :sortkeyval - true if the sort key value is greater than :sortkeyval.
sortKeyName >= :sortkeyval - true if the sort key value is greater than or equal to :sortkeyval.
sortKeyName BETWEEN :sortkeyval1 AND :sortkeyval2 - true if the sort key value is greater than or equal to :sortkeyval1, and less than or equal to :sortkeyval2.
begins_with ( sortKeyName, :sortkeyval ) - true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name begins_with is case-sensitive.

Use the ExpressionAttributeValues parameter to replace tokens such as :partitionval and :sortval with actual values at runtime.

You can optionally use the ExpressionAttributeNames parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following KeyConditionExpression parameter causes an error because Size is a reserved word:

Size = :myval

To work around this, define a placeholder (such a #S) to represent the attribute name Size. KeyConditionExpression then is as follows:

#S = :myval

For a list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.

For more information on ExpressionAttributeNames and ExpressionAttributeValues, see Using Placeholders for Attribute Names and Values in the Amazon DynamoDB Developer Guide.

KeyConditions

: Type: Associative array of custom strings keys (AttributeName) to Condition structures

This is a legacy parameter. Use KeyConditionExpression instead. For more information, see KeyConditions in the Amazon DynamoDB Developer Guide.

Limit

: Type: int

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Query and Scan in the Amazon DynamoDB Developer Guide.

ProjectionExpression

: Type: string

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Accessing Item Attributes in the Amazon DynamoDB Developer Guide.

QueryFilter

: Type: Associative array of custom strings keys (AttributeName) to Condition structures

This is a legacy parameter. Use FilterExpression instead. For more information, see QueryFilter in the Amazon DynamoDB Developer Guide.

ReturnConsumedCapacity

: Type: string

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.

ScanIndexForward

: Type: boolean

Specifies the order for index traversal: If true (default), the traversal is performed in ascending order; if false, the traversal is performed in descending order.

Items with the same partition key value are stored in sorted order by sort key. If the sort key data type is Number, the results are stored in numeric order. For type String, the results are stored in order of UTF-8 bytes. For type Binary, DynamoDB treats each byte of the binary data as unsigned.

If ScanIndexForward is true, DynamoDB returns the results in the order in which they are stored (by sort key value). This is the default behavior. If ScanIndexForward is false, DynamoDB reads the results in reverse order by sort key value, and then returns the results to the client.

Select

: Type: string

The attributes to be returned in the result. You can retrieve all item attributes, specific item attributes, the count of matching items, or in the case of an index, some or all of the attributes projected into the index.

ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.
COUNT - Returns the number of matching items, rather than the matching items themselves. Note that this uses the same quantity of read capacity units as getting the items, and is subject to the same item size calculations.
SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression. This return value is equivalent to specifying ProjectionExpression without specifying any value for Select.

If you query or scan a local secondary index and request only attributes that are projected into that index, the operation will read only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If neither Select nor ProjectionExpression are specified, DynamoDB defaults to ALL_ATTRIBUTES when accessing a table, and ALL_PROJECTED_ATTRIBUTES when accessing an index. You cannot use both Select and ProjectionExpression together in a single request, unless the value for Select is SPECIFIC_ATTRIBUTES. (This usage is equivalent to specifying ProjectionExpression without any value for Select.)

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

TableName

: Required: Yes
: Type: string

The name of the table containing the requested items. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

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

Members

ConsumedCapacity

: Type: ConsumedCapacity structure

The capacity units consumed by the Query operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.

Count

: Type: int

The number of items in the response.

If you used a QueryFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count and ScannedCount are the same.

Items

: Type: Array of AttributeValue structuress

An array of item attributes that match the query criteria. Each element in this array consists of an attribute name and the value for that attribute.

LastEvaluatedKey

: Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

If LastEvaluatedKey is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when LastEvaluatedKey is empty.

ScannedCount

: Type: int

The number of items evaluated, before any QueryFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Query operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

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
            ],
            'WarmThroughput' => [
                'ReadUnitsPerSecond' => <integer>,
                'WriteUnitsPerSecond' => <integer>,
            ],
        ],
        // ...
    ],
    '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

Members

BackupArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) associated with the backup.

BillingModeOverride

: Type: string

The billing mode of the restored table.

GlobalSecondaryIndexOverride

: Type: Array of GlobalSecondaryIndex structures

List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

LocalSecondaryIndexOverride

: Type: Array of LocalSecondaryIndex structures

List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

OnDemandThroughputOverride

: Type: OnDemandThroughput structure

Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

ProvisionedThroughputOverride

: Type: ProvisionedThroughput structure

Provisioned throughput settings for the restored table.

SSESpecificationOverride

: Type: SSESpecification structure

The new server-side encryption settings for the restored table.

TargetTableName

: Required: Yes
: Type: string

The name of the new table to which the backup must be restored.

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>,
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
                    'WriteUnitsPerSecond' => <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>,
                        ],
                        'WarmThroughput' => [
                            'ReadUnitsPerSecond' => <integer>,
                            'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
                            'WriteUnitsPerSecond' => <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',
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
                    'WriteUnitsPerSecond' => <integer>,
                ],
            ],
            // ...
        ],
        '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',
        'WarmThroughput' => [
            'ReadUnitsPerSecond' => <integer>,
            'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
            'WriteUnitsPerSecond' => <integer>,
        ],
    ],
]

Result Details

Members

TableDescription

: Type: TableDescription structure

The description of the table created from an existing backup.

Errors

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.

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

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.

TableAlreadyExistsException:

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
            ],
            'WarmThroughput' => [
                'ReadUnitsPerSecond' => <integer>,
                'WriteUnitsPerSecond' => <integer>,
            ],
        ],
        // ...
    ],
    '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

Members

BillingModeOverride

: Type: string

The billing mode of the restored table.

GlobalSecondaryIndexOverride

: Type: Array of GlobalSecondaryIndex structures

List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

LocalSecondaryIndexOverride

: Type: Array of LocalSecondaryIndex structures

List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

OnDemandThroughputOverride

: Type: OnDemandThroughput structure

Sets the maximum number of read and write units for the specified on-demand table. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

ProvisionedThroughputOverride

: Type: ProvisionedThroughput structure

Provisioned throughput settings for the restored table.

RestoreDateTime

: Type: timestamp (string|DateTime or anything parsable by strtotime)

Time in the past to restore the table to.

SSESpecificationOverride

: Type: SSESpecification structure

The new server-side encryption settings for the restored table.

SourceTableArn

: Type: string

The DynamoDB table that will be restored. This value is an Amazon Resource Name (ARN).

SourceTableName

: Type: string

Name of the source table that is being restored.

TargetTableName

: Required: Yes
: Type: string

The name of the new table to which it must be restored to.

UseLatestRestorableTime

: Type: boolean

Restore the table to the latest possible time. LatestRestorableDateTime is typically 5 minutes before the current time.

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>,
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
                    'WriteUnitsPerSecond' => <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>,
                        ],
                        'WarmThroughput' => [
                            'ReadUnitsPerSecond' => <integer>,
                            'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
                            'WriteUnitsPerSecond' => <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',
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
                    'WriteUnitsPerSecond' => <integer>,
                ],
            ],
            // ...
        ],
        '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',
        'WarmThroughput' => [
            'ReadUnitsPerSecond' => <integer>,
            'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
            'WriteUnitsPerSecond' => <integer>,
        ],
    ],
]

Result Details

Members

TableDescription

: Type: TableDescription structure

Represents the properties of a table.

Errors

A target table with the specified name already exists.

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.

InvalidRestoreTimeException:

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

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.

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.

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.

Count and ScannedCount only return the count of items specific to a single scan request and, unless the table is less than 1MB, do not represent the total number of items in the table.

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.

DynamoDB does not provide snapshot isolation for a scan operation when the ConsistentRead parameter is set to true. Thus, a DynamoDB scan operation does not guarantee that all reads in a scan see a consistent snapshot of the table when the scan operation was requested.

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

Members

AttributesToGet

: Type: Array of strings

This is a legacy parameter. Use ProjectionExpression instead. For more information, see AttributesToGet in the Amazon DynamoDB Developer Guide.

ConditionalOperator

: Type: string

This is a legacy parameter. Use FilterExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

ConsistentRead

: Type: boolean

A Boolean value that determines the read consistency model during the scan:

If ConsistentRead is false, then the data returned from Scan might not contain the results from other recently completed write operations (PutItem, UpdateItem, or DeleteItem).
If ConsistentRead is true, then all of the write operations that completed before the Scan began are guaranteed to be contained in the Scan response.

The default setting for ConsistentRead is false.

The ConsistentRead parameter is not supported on global secondary indexes. If you scan a global secondary index with ConsistentRead set to true, you will receive a ValidationException.

ExclusiveStartKey

: Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures

The primary key of the first item that this operation will evaluate. Use the value that was returned for LastEvaluatedKey in the previous operation.

The data type for ExclusiveStartKey must be String, Number or Binary. No set data types are allowed.

In a parallel scan, a Scan request that includes ExclusiveStartKey must specify the same segment whose previous Scan returned the corresponding value of LastEvaluatedKey.

ExpressionAttributeNames

: Type: Associative array of custom strings keys (ExpressionAttributeNameVariable) to strings

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

Percentile

{"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

#P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information on expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

ExpressionAttributeValues

: Type: Associative array of custom strings keys (ExpressionAttributeValueVariable) to AttributeValue structures

One or more values that can be substituted in an expression.

Use the : (colon) character in an expression to dereference an attribute value. For example, suppose that you wanted to check whether the value of the ProductStatus attribute was one of the following:

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

FilterExpression

: Type: string

A string that contains conditions that DynamoDB applies after the Scan operation, but before the data is returned to you. Items that do not satisfy the FilterExpression criteria are not returned.

A FilterExpression is applied after the items have already been read; the process of filtering does not consume any additional read capacity units.

For more information, see Filter Expressions in the Amazon DynamoDB Developer Guide.

IndexName

: Type: string

The name of a secondary index to scan. This index can be any local secondary index or global secondary index. Note that if you use the IndexName parameter, you must also provide TableName.

Limit

: Type: int

The maximum number of items to evaluate (not necessarily the number of matching items). If DynamoDB processes the number of items up to the limit while processing the results, it stops the operation and returns the matching values up to that point, and a key in LastEvaluatedKey to apply in a subsequent operation, so that you can pick up where you left off. Also, if the processed dataset size exceeds 1 MB before DynamoDB reaches this limit, it stops the operation and returns the matching values up to the limit, and a key in LastEvaluatedKey to apply in a subsequent operation to continue the operation. For more information, see Working with Queries in the Amazon DynamoDB Developer Guide.

ProjectionExpression

: Type: string

A string that identifies one or more attributes to retrieve from the specified table or index. These attributes can include scalars, sets, or elements of a JSON document. The attributes in the expression must be separated by commas.

If no attribute names are specified, then all attributes will be returned. If any of the requested attributes are not found, they will not appear in the result.

For more information, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

ReturnConsumedCapacity

: Type: string

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.

ScanFilter

: Type: Associative array of custom strings keys (AttributeName) to Condition structures

This is a legacy parameter. Use FilterExpression instead. For more information, see ScanFilter in the Amazon DynamoDB Developer Guide.

Segment

: Type: int

For a parallel Scan request, Segment identifies an individual segment to be scanned by an application worker.

Segment IDs are zero-based, so the first segment is always 0. For example, if you want to use four application threads to scan a table or an index, then the first thread specifies a Segment value of 0, the second thread specifies 1, and so on.

The value of LastEvaluatedKey returned from a parallel Scan request must be used as ExclusiveStartKey with the same segment ID in a subsequent Scan operation.

The value for Segment must be greater than or equal to 0, and less than the value provided for TotalSegments.

If you provide Segment, you must also provide TotalSegments.

Select

: Type: string

ALL_ATTRIBUTES - Returns all of the item attributes from the specified table or index. If you query a local secondary index, then for each matching item in the index, DynamoDB fetches the entire item from the parent table. If the index is configured to project all item attributes, then all of the data can be obtained from the local secondary index, and no fetching is required.
ALL_PROJECTED_ATTRIBUTES - Allowed only when querying an index. Retrieves all attributes that have been projected into the index. If the index is configured to project all attributes, this return value is equivalent to specifying ALL_ATTRIBUTES.
COUNT - Returns the number of matching items, rather than the matching items themselves. Note that this uses the same quantity of read capacity units as getting the items, and is subject to the same item size calculations.
SPECIFIC_ATTRIBUTES - Returns only the attributes listed in ProjectionExpression. This return value is equivalent to specifying ProjectionExpression without specifying any value for Select.

If you query or scan a local secondary index and request only attributes that are projected into that index, the operation reads only the index and not the table. If any of the requested attributes are not projected into the local secondary index, DynamoDB fetches each of these attributes from the parent table. This extra fetching incurs additional throughput cost and latency.

If you query or scan a global secondary index, you can only request attributes that are projected into the index. Global secondary index queries cannot fetch attributes from the parent table.

If you use the ProjectionExpression parameter, then the value for Select can only be SPECIFIC_ATTRIBUTES. Any other value for Select will return an error.

TableName

: Required: Yes
: Type: string

The name of the table containing the requested items or if you provide IndexName, the name of the table to which that index belongs.

You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

TotalSegments

: Type: int

For a parallel Scan request, TotalSegments represents the total number of segments into which the Scan operation will be divided. The value of TotalSegments corresponds to the number of application workers that will perform the parallel scan. For example, if you want to use four application threads to scan a table or an index, specify a TotalSegments value of 4.

The value for TotalSegments must be greater than or equal to 1, and less than or equal to 1000000. If you specify a TotalSegments value of 1, the Scan operation will be sequential rather than parallel.

If you specify TotalSegments, you must also specify Segment.

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

Members

ConsumedCapacity

: Type: ConsumedCapacity structure

The capacity units consumed by the Scan operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unit consumption for read operations in the Amazon DynamoDB Developer Guide.

Count

: Type: int

The number of items in the response.

If you set ScanFilter in the request, then Count is the number of items returned after the filter was applied, and ScannedCount is the number of matching items before the filter was applied.

If you did not use a filter in the request, then Count is the same as ScannedCount.

Items

: Type: Array of AttributeValue structuress

An array of item attributes that match the scan criteria. Each element in this array consists of an attribute name and the value for that attribute.

LastEvaluatedKey

: Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures

The primary key of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.

If LastEvaluatedKey is empty, then the "last page" of results has been processed and there is no more data to be retrieved.

ScannedCount

: Type: int

The number of items evaluated, before any ScanFilter is applied. A high ScannedCount value with few, or no, Count results indicates an inefficient Scan operation. For more information, see Count and ScannedCount in the Amazon DynamoDB Developer Guide.

If you did not use a filter in the request, then ScannedCount is the same as Count.

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

Members

ResourceArn

: Required: Yes
: Type: string

Identifies the Amazon DynamoDB resource to which tags should be added. This value is an Amazon Resource Name (ARN).

Tags

: Required: Yes
: Type: Array of Tag structures

The tags to be assigned to the Amazon DynamoDB resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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

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.

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

An error occurred on the server side.

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.

TransactGetItems

$result = $client->transactGetItems([/* ... */]);
$promise = $client->transactGetItemsAsync([/* ... */]);

TransactGetItems is a synchronous operation that atomically retrieves multiple items from one or more tables (but not from indexes) in a single account and Region. A TransactGetItems call can contain up to 100 TransactGetItem objects, each of which contains a Get structure that specifies an item to retrieve from a table in the account and Region. A call to TransactGetItems cannot retrieve items from tables in more than one Amazon Web Services account or Region. The aggregate size of the items in the transaction cannot exceed 4 MB.

DynamoDB rejects the entire TransactGetItems request if any of the following is true:

A conflicting operation is in the process of updating an item to be read.
There is insufficient provisioned capacity for the transaction to be completed.
There is a user error, such as an invalid data format.
The aggregate size of the items in the transaction exceeded 4 MB.

Parameter Syntax

$result = $client->transactGetItems([
    'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
    'TransactItems' => [ // REQUIRED
        [
            'Get' => [ // REQUIRED
                '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>',
                'TableName' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members

ReturnConsumedCapacity

: Type: string

A value of TOTAL causes consumed capacity information to be returned, and a value of NONE prevents that information from being returned. No other value is valid.

TransactItems

: Required: Yes
: Type: Array of TransactGetItem structures

An ordered array of up to 100 TransactGetItem objects, each of which contains a Get structure.

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

Members

ConsumedCapacity

: Type: Array of ConsumedCapacity structures

If the ReturnConsumedCapacity value was TOTAL, this is an array of ConsumedCapacity objects, one for each table addressed by TransactGetItem objects in the TransactItems parameter. These ConsumedCapacity objects report the read-capacity units consumed by the TransactGetItems call in that table.

Responses

: Type: Array of ItemResponse structures

An ordered array of up to 100 ItemResponse objects, each of which corresponds to the TransactGetItem object in the same position in the TransactItems array. Each ItemResponse object contains a Map of the name-value pairs that are the projected attributes of the requested item.

If a requested item could not be retrieved, the corresponding ItemResponse object is Null, or if the requested item has no projected attributes, the corresponding ItemResponse object is an empty Map.

Errors

TransactionCanceledException:

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

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.

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.

ProvisionedThroughputExceededException:

RequestLimitExceeded:

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

An error occurred on the server side.

TransactWriteItems

$result = $client->transactWriteItems([/* ... */]);
$promise = $client->transactWriteItemsAsync([/* ... */]);

TransactWriteItems is a synchronous write operation that groups up to 100 action requests. These actions can target items in different tables, but not in different Amazon Web Services accounts or Regions, and no two actions can target the same item. For example, you cannot both ConditionCheck and Update the same item. The aggregate size of the items in the transaction cannot exceed 4 MB.

The actions are completed atomically so that either all of them succeed, or all of them fail. They are defined by the following objects:

Put — Initiates a PutItem operation to write a new item. This structure specifies the primary key of the item to be written, the name of the table to write it in, an optional condition expression that must be satisfied for the write to succeed, a list of the item's attributes, and a field indicating whether to retrieve the item's attributes if the condition is not met.
Update — Initiates an UpdateItem operation to update an existing item. This structure specifies the primary key of the item to be updated, the name of the table where it resides, an optional condition expression that must be satisfied for the update to succeed, an expression that defines one or more attributes to be updated, and a field indicating whether to retrieve the item's attributes if the condition is not met.
Delete — Initiates a DeleteItem operation to delete an existing item. This structure specifies the primary key of the item to be deleted, the name of the table where it resides, an optional condition expression that must be satisfied for the deletion to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met.
ConditionCheck — Applies a condition to an item that is not being modified by the transaction. This structure specifies the primary key of the item to be checked, the name of the table where it resides, a condition expression that must be satisfied for the transaction to succeed, and a field indicating whether to retrieve the item's attributes if the condition is not met.

DynamoDB rejects the entire TransactWriteItems request if any of the following is true:

A condition in one of the condition expressions is not met.
An ongoing operation is in the process of updating the same item.
There is insufficient provisioned capacity for the transaction to be completed.
An item size becomes too large (bigger than 400 KB), a local secondary index (LSI) becomes too large, or a similar validation error occurs because of changes made by the transaction.
The aggregate size of the items in the transaction exceeds 4 MB.
There is a user error, such as an invalid data format.

Parameter Syntax

$result = $client->transactWriteItems([
    'ClientRequestToken' => '<string>',
    'ReturnConsumedCapacity' => 'INDEXES|TOTAL|NONE',
    'ReturnItemCollectionMetrics' => 'SIZE|NONE',
    'TransactItems' => [ // REQUIRED
        [
            'ConditionCheck' => [
                'ConditionExpression' => '<string>', // REQUIRED
                '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>', ...],
                    ],
                    // ...
                ],
                'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
                'TableName' => '<string>', // REQUIRED
            ],
            'Delete' => [
                'ConditionExpression' => '<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>', ...],
                    ],
                    // ...
                ],
                'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
                'TableName' => '<string>', // REQUIRED
            ],
            'Put' => [
                'ConditionExpression' => '<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>', ...],
                    ],
                    // ...
                ],
                'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
                'TableName' => '<string>', // REQUIRED
            ],
            'Update' => [
                'ConditionExpression' => '<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>', ...],
                    ],
                    // ...
                ],
                'ReturnValuesOnConditionCheckFailure' => 'ALL_OLD|NONE',
                'TableName' => '<string>', // REQUIRED
                'UpdateExpression' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members

ClientRequestToken

: Type: string

Providing a ClientRequestToken makes the call to TransactWriteItems idempotent, meaning that multiple identical calls have the same effect as one single call.

Although multiple identical calls using the same client request token produce the same result on the server (no side effects), the responses to the calls might not be the same. If the ReturnConsumedCapacity parameter is set, then the initial TransactWriteItems call returns the amount of write capacity units consumed in making the changes. Subsequent TransactWriteItems calls with the same client token return the number of read capacity units consumed in reading the item.

A client request token is valid for 10 minutes after the first request that uses it is completed. After 10 minutes, any request with the same client token is treated as a new request. Do not resubmit the same request with the same client token for more than 10 minutes, or the result might not be idempotent.

If you submit a request with the same client token but a change in other parameters within the 10-minute idempotency window, DynamoDB returns an IdempotentParameterMismatch exception.

ReturnConsumedCapacity

: Type: string

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.

ReturnItemCollectionMetrics

: Type: string

Determines whether item collection metrics are returned. If set to SIZE, the response includes statistics about item collections (if any), that were modified during the operation and are returned in the response. If set to NONE (the default), no statistics are returned.

TransactItems

: Required: Yes
: Type: Array of TransactWriteItem structures

An ordered array of up to 100 TransactWriteItem objects, each of which contains a ConditionCheck, Put, Update, or Delete object. These can operate on items in different tables, but the tables must reside in the same Amazon Web Services account and Region, and no two of them can operate on the same item.

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>, ...],
            ],
            // ...
        ],
        // ...
    ],
]

Result Details

Members

ConsumedCapacity

: Type: Array of ConsumedCapacity structures

The capacity units consumed by the entire TransactWriteItems operation. The values of the list are ordered according to the ordering of the TransactItems request parameter.

ItemCollectionMetrics

: Type: Associative array of custom strings keys (TableArn) to ItemCollectionMetrics structuress

A list of tables that were processed by TransactWriteItems and, for each table, information about any item collections that were affected by individual UpdateItem, PutItem, or DeleteItem operations.

Errors

TransactionCanceledException:

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

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.

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

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:

RequestLimitExceeded:

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

An error occurred on the server side.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes the association of tags from an Amazon DynamoDB resource. You can call UntagResource up to five times per second, per account.

UntagResource is an asynchronous operation. If you issue a ListTagsOfResource request immediately after an UntagResource 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->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

: Required: Yes
: Type: string

The DynamoDB resource that the tags will be removed from. This value is an Amazon Resource Name (ARN).

TagKeys

: Required: Yes
: Type: Array of strings

A list of tag keys. Existing tags of the resource whose keys are members of this list will be removed from the DynamoDB resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

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

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.

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

An error occurred on the server side.

GlobalTableNotFoundException:

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.

UpdateContinuousBackups

$result = $client->updateContinuousBackups([/* ... */]);
$promise = $client->updateContinuousBackupsAsync([/* ... */]);

UpdateContinuousBackups enables or disables point in time recovery for the specified table. A successful UpdateContinuousBackups call returns the current ContinuousBackupsDescription. Continuous backups are ENABLED on all tables at table creation. If point in time recovery is enabled, PointInTimeRecoveryStatus will be set to ENABLED.

Once 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.

Parameter Syntax

$result = $client->updateContinuousBackups([
    'PointInTimeRecoverySpecification' => [ // REQUIRED
        'PointInTimeRecoveryEnabled' => true || false, // REQUIRED
    ],
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Members

PointInTimeRecoverySpecification

: Required: Yes
: Type: PointInTimeRecoverySpecification structure

Represents the settings used to enable point in time recovery.

TableName

: Required: Yes
: Type: string

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Result Syntax

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

Result Details

Members

ContinuousBackupsDescription

: Type: ContinuousBackupsDescription structure

Represents the continuous backups and point in time recovery settings on the table.

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.
ContinuousBackupsUnavailableException:: Backups have not yet been enabled for this table.
InternalServerError:: An error occurred on the server side.

UpdateContributorInsights

$result = $client->updateContributorInsights([/* ... */]);
$promise = $client->updateContributorInsightsAsync([/* ... */]);

Updates the status for contributor insights for a specific table or index. CloudWatch Contributor Insights for DynamoDB graphs display the partition key and (if applicable) sort key of frequently accessed items and frequently throttled items in plaintext. If you require the use of Amazon Web Services Key Management Service (KMS) to encrypt this table’s partition key and sort key data with an Amazon Web Services managed key or customer managed key, you should not enable CloudWatch Contributor Insights for DynamoDB for this table.

Parameter Syntax

$result = $client->updateContributorInsights([
    'ContributorInsightsAction' => 'ENABLE|DISABLE', // REQUIRED
    'IndexName' => '<string>',
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Members

ContributorInsightsAction

: Required: Yes
: Type: string

Represents the contributor insights action.

IndexName

: Type: string

The global secondary index name, if applicable.

TableName

: Required: Yes
: Type: string

The name of the table. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

Result Syntax

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

Result Details

Members

ContributorInsightsStatus

: Type: string

The status of contributor insights

IndexName

: Type: string

The name of the global secondary index, if applicable.

TableName

: Type: string

The name of the table.

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.

UpdateGlobalTable

$result = $client->updateGlobalTable([/* ... */]);
$promise = $client->updateGlobalTableAsync([/* ... */]);

Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, have the same name as the global table, have the same key schema, have DynamoDB Streams enabled, and have the same provisioned and maximum write capacity units.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version). If you are using global tables Version 2019.11.21 you can use UpdateTable instead.

Although you can use UpdateGlobalTable to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.

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).
The global secondary indexes must have the same provisioned and maximum write capacity units.

Parameter Syntax

$result = $client->updateGlobalTable([
    'GlobalTableName' => '<string>', // REQUIRED
    'ReplicaUpdates' => [ // REQUIRED
        [
            'Create' => [
                'RegionName' => '<string>', // REQUIRED
            ],
            'Delete' => [
                'RegionName' => '<string>', // REQUIRED
            ],
        ],
        // ...
    ],
]);

Parameter Details

Members

GlobalTableName

: Required: Yes
: Type: string

The global table name.

ReplicaUpdates

: Required: Yes
: Type: Array of ReplicaUpdate structures

A list of Regions that should be added or removed from the global table.

Result Syntax

[
    'GlobalTableDescription' => [
        'CreationDateTime' => <DateTime>,
        'GlobalTableArn' => '<string>',
        'GlobalTableName' => '<string>',
        'GlobalTableStatus' => 'CREATING|ACTIVE|DELETING|UPDATING',
        'ReplicationGroup' => [
            [
                'GlobalSecondaryIndexes' => [
                    [
                        'IndexName' => '<string>',
                        'OnDemandThroughputOverride' => [
                            'MaxReadRequestUnits' => <integer>,
                        ],
                        'ProvisionedThroughputOverride' => [
                            'ReadCapacityUnits' => <integer>,
                        ],
                        'WarmThroughput' => [
                            'ReadUnitsPerSecond' => <integer>,
                            'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
                            'WriteUnitsPerSecond' => <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',
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
                    'WriteUnitsPerSecond' => <integer>,
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Members

GlobalTableDescription

: Type: GlobalTableDescription structure

Contains the details of the global table.

Errors

InternalServerError:: An error occurred on the server side.
GlobalTableNotFoundException:: The specified global table does not exist.
ReplicaAlreadyExistsException:: The specified replica is already part of the global table.
ReplicaNotFoundException:: The specified replica is no longer part of the global table.
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.

UpdateGlobalTableSettings

$result = $client->updateGlobalTableSettings([/* ... */]);
$promise = $client->updateGlobalTableSettingsAsync([/* ... */]);

Updates settings for a global table.

Parameter Syntax

$result = $client->updateGlobalTableSettings([
    'GlobalTableBillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
    'GlobalTableGlobalSecondaryIndexSettingsUpdate' => [
        [
            'IndexName' => '<string>', // REQUIRED
            'ProvisionedWriteCapacityAutoScalingSettingsUpdate' => [
                'AutoScalingDisabled' => true || false,
                'AutoScalingRoleArn' => '<string>',
                'MaximumUnits' => <integer>,
                'MinimumUnits' => <integer>,
                'ScalingPolicyUpdate' => [
                    'PolicyName' => '<string>',
                    'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
                        'DisableScaleIn' => true || false,
                        'ScaleInCooldown' => <integer>,
                        'ScaleOutCooldown' => <integer>,
                        'TargetValue' => <float>, // REQUIRED
                    ],
                ],
            ],
            'ProvisionedWriteCapacityUnits' => <integer>,
        ],
        // ...
    ],
    'GlobalTableName' => '<string>', // REQUIRED
    'GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate' => [
        'AutoScalingDisabled' => true || false,
        'AutoScalingRoleArn' => '<string>',
        'MaximumUnits' => <integer>,
        'MinimumUnits' => <integer>,
        'ScalingPolicyUpdate' => [
            'PolicyName' => '<string>',
            'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
                'DisableScaleIn' => true || false,
                'ScaleInCooldown' => <integer>,
                'ScaleOutCooldown' => <integer>,
                'TargetValue' => <float>, // REQUIRED
            ],
        ],
    ],
    'GlobalTableProvisionedWriteCapacityUnits' => <integer>,
    'ReplicaSettingsUpdate' => [
        [
            'RegionName' => '<string>', // REQUIRED
            'ReplicaGlobalSecondaryIndexSettingsUpdate' => [
                [
                    'IndexName' => '<string>', // REQUIRED
                    'ProvisionedReadCapacityAutoScalingSettingsUpdate' => [
                        'AutoScalingDisabled' => true || false,
                        'AutoScalingRoleArn' => '<string>',
                        'MaximumUnits' => <integer>,
                        'MinimumUnits' => <integer>,
                        'ScalingPolicyUpdate' => [
                            'PolicyName' => '<string>',
                            'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
                                'DisableScaleIn' => true || false,
                                'ScaleInCooldown' => <integer>,
                                'ScaleOutCooldown' => <integer>,
                                'TargetValue' => <float>, // REQUIRED
                            ],
                        ],
                    ],
                    'ProvisionedReadCapacityUnits' => <integer>,
                ],
                // ...
            ],
            'ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate' => [
                'AutoScalingDisabled' => true || false,
                'AutoScalingRoleArn' => '<string>',
                'MaximumUnits' => <integer>,
                'MinimumUnits' => <integer>,
                'ScalingPolicyUpdate' => [
                    'PolicyName' => '<string>',
                    'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
                        'DisableScaleIn' => true || false,
                        'ScaleInCooldown' => <integer>,
                        'ScaleOutCooldown' => <integer>,
                        'TargetValue' => <float>, // REQUIRED
                    ],
                ],
            ],
            'ReplicaProvisionedReadCapacityUnits' => <integer>,
            'ReplicaTableClass' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
        ],
        // ...
    ],
]);

Parameter Details

Members

GlobalTableBillingMode

: Type: string

The billing mode of the global table. If GlobalTableBillingMode is not specified, the global table defaults to PROVISIONED capacity billing mode.

PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

GlobalTableGlobalSecondaryIndexSettingsUpdate

: Type: Array of GlobalTableGlobalSecondaryIndexSettingsUpdate structures

Represents the settings of a global secondary index for a global table that will be modified.

GlobalTableName

: Required: Yes
: Type: string

The name of the global table

GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate

: Type: AutoScalingSettingsUpdate structure

Auto scaling settings for managing provisioned write capacity for the global table.

GlobalTableProvisionedWriteCapacityUnits

: Type: long (int|float)

The maximum number of writes consumed per second before DynamoDB returns a ThrottlingException.

ReplicaSettingsUpdate

: Type: Array of ReplicaSettingsUpdate structures

Represents the settings for a global table in a Region that will be modified.

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

Members

GlobalTableName

: Type: string

The name of the global table.

ReplicaSettings

: Type: Array of ReplicaSettingsDescription structures

The Region-specific settings for the global table.

Errors

The specified global table does not exist.

ReplicaNotFoundException:

The specified replica is no longer part of the global table.

IndexNotFoundException:

The operation tried to access a nonexistent index.

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

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.

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.

An error occurred on the server side.

UpdateItem

$result = $client->updateItem([/* ... */]);
$promise = $client->updateItemAsync([/* ... */]);

Edits an existing item's attributes, or adds a new item to the table if it does not already exist. You can put, delete, or add attribute values. You can also perform a conditional update on an existing item (insert a new attribute name-value pair if it doesn't exist, or replace an existing name-value pair if it has certain expected attribute values).

You can also return the item's attribute values in the same UpdateItem operation using the ReturnValues parameter.

Parameter Syntax

$result = $client->updateItem([
    'AttributeUpdates' => [
        '<AttributeName>' => [
            'Action' => 'ADD|PUT|DELETE',
            '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>', ...],
            ],
        ],
        // ...
    ],
    '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
    'UpdateExpression' => '<string>',
]);

Parameter Details

Members

AttributeUpdates

: Type: Associative array of custom strings keys (AttributeName) to AttributeValueUpdate structures

This is a legacy parameter. Use UpdateExpression instead. For more information, see AttributeUpdates in the Amazon DynamoDB Developer Guide.

ConditionExpression

: Type: string

A condition that must be satisfied in order for a conditional update to succeed.

An expression can contain any of the following:

Functions: attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size

These function names are case-sensitive.
Comparison operators: = | <> | < | > | <= | >= | BETWEEN | IN
Logical operators: AND | OR | NOT

For more information about condition expressions, see Specifying Conditions in the Amazon DynamoDB Developer Guide.

ConditionalOperator

: Type: string

This is a legacy parameter. Use ConditionExpression instead. For more information, see ConditionalOperator in the Amazon DynamoDB Developer Guide.

Expected

: Type: Associative array of custom strings keys (AttributeName) to ExpectedAttributeValue structures

This is a legacy parameter. Use ConditionExpression instead. For more information, see Expected in the Amazon DynamoDB Developer Guide.

ExpressionAttributeNames

: Type: Associative array of custom strings keys (ExpressionAttributeNameVariable) to strings

One or more substitution tokens for attribute names in an expression. The following are some use cases for using ExpressionAttributeNames:

To access an attribute whose name conflicts with a DynamoDB reserved word.
To create a placeholder for repeating occurrences of an attribute name in an expression.
To prevent special characters in an attribute name from being misinterpreted in an expression.

Use the # character in an expression to dereference an attribute name. For example, consider the following attribute name:

Percentile

The name of this attribute conflicts with a reserved word, so it cannot be used directly in an expression. (For the complete list of reserved words, see Reserved Words in the Amazon DynamoDB Developer Guide.) To work around this, you could specify the following for ExpressionAttributeNames:

{"#P":"Percentile"}

You could then use this substitution in an expression, as in this example:

#P = :val

Tokens that begin with the : character are expression attribute values, which are placeholders for the actual value at runtime.

For more information about expression attribute names, see Specifying Item Attributes in the Amazon DynamoDB Developer Guide.

ExpressionAttributeValues

: Type: Associative array of custom strings keys (ExpressionAttributeValueVariable) to AttributeValue structures

One or more values that can be substituted in an expression.

Available | Backordered | Discontinued

You would first need to specify ExpressionAttributeValues as follows:

{ ":avail":{"S":"Available"}, ":back":{"S":"Backordered"}, ":disc":{"S":"Discontinued"} }

You could then use these values in an expression, such as this:

ProductStatus IN (:avail, :back, :disc)

For more information on expression attribute values, see Condition Expressions in the Amazon DynamoDB Developer Guide.

Key

: Required: Yes
: Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures

The primary key of the item to be updated. Each element consists of an attribute name and a value for that attribute.

ReturnConsumedCapacity

: Type: string

Determines the level of detail about either provisioned or on-demand throughput consumption that is returned in the response:

INDEXES - The response includes the aggregate ConsumedCapacity for the operation, together with ConsumedCapacity for each table and secondary index that was accessed.

Note that some operations, such as GetItem and BatchGetItem, do not access any indexes at all. In these cases, specifying INDEXES will only return ConsumedCapacity information for table(s).
TOTAL - The response includes only the aggregate ConsumedCapacity for the operation.
NONE - No ConsumedCapacity details are included in the response.

ReturnItemCollectionMetrics

: Type: string

ReturnValues

: Type: string

Use ReturnValues if you want to get the item attributes as they appear before or after they are successfully updated. For UpdateItem, the valid values are:

NONE - If ReturnValues is not specified, or if its value is NONE, then nothing is returned. (This setting is the default for ReturnValues.)
ALL_OLD - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.
UPDATED_OLD - Returns only the updated attributes, as they appeared before the UpdateItem operation.
ALL_NEW - Returns all of the attributes of the item, as they appear after the UpdateItem operation.
UPDATED_NEW - Returns only the updated attributes, as they appear after the UpdateItem operation.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

The values returned are strongly consistent.

ReturnValuesOnConditionCheckFailure

: Type: string

An optional parameter that returns the item attributes for an UpdateItem operation that failed a condition check.

There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No read capacity units are consumed.

TableName

: Required: Yes
: Type: string

The name of the table containing the item to update. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

UpdateExpression

: Type: string

An expression that defines one or more attributes to be updated, the action to be performed on them, and new values for them.

The following action values are available for UpdateExpression.

SET - Adds one or more attributes and values to an item. If any of these attributes already exist, they are replaced by the new values. You can also use SET to add or subtract from an attribute that is of type Number. For example: SET myNum = myNum + :val

SET supports the following functions:
- if_not_exists (path, operand) - if the item does not contain an attribute at the specified path, then if_not_exists evaluates to operand; otherwise, it evaluates to path. You can use this function to avoid overwriting an attribute that may already be present in the item.
- list_append (operand, operand) - evaluates to a list with a new element added to it. You can append the new element to the start or the end of the list by reversing the order of the operands.
These function names are case-sensitive.
REMOVE - Removes one or more attributes from an item.
ADD - Adds the specified value to the item, if the attribute does not already exist. If the attribute does exist, then the behavior of ADD depends on the data type of the attribute:
- If the existing attribute is a number, and if Value is also a number, then Value is mathematically added to the existing attribute. If Value is a negative number, then it is subtracted from the existing attribute.
  
  If you use ADD to increment or decrement a number value for an item that doesn't exist before the update, DynamoDB uses 0 as the initial value.
  
  Similarly, if you use ADD for an existing item to increment or decrement an attribute value that doesn't exist before the update, DynamoDB uses 0 as the initial value. For example, suppose that the item you want to update doesn't have an attribute named itemcount, but you decide to ADD the number 3 to this attribute anyway. DynamoDB will create the itemcount attribute, set its initial value to 0, and finally add 3 to it. The result will be a new itemcount attribute in the item, with a value of 3.
- If the existing data type is a set and if Value is also a set, then Value is added to the existing set. For example, if the attribute value is the set [1,2], and the ADD action specified [3], then the final attribute value is [1,2,3]. An error occurs if an ADD action is specified for a set attribute and the attribute type specified does not match the existing set type.
  
  Both sets must have the same primitive data type. For example, if the existing data type is a set of strings, the Value must also be a set of strings.
The ADD action only supports Number and set data types. In addition, ADD can only be used on top-level attributes, not nested attributes.
DELETE - Deletes an element from a set.

If a set of values is specified, then those values are subtracted from the old set. For example, if the attribute value was the set [a,b,c] and the DELETE action specifies [a,c], then the final attribute value is [b]. Specifying an empty set is an error.

The DELETE action only supports set data types. In addition, DELETE can only be used on top-level attributes, not nested attributes.

You can have many actions in a single expression, such as the following: SET a=:value1, b=:value2 DELETE :value3, :value4, :value5

For more information on update expressions, see Modifying Items and Attributes in the Amazon DynamoDB Developer Guide.

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

Members

Attributes

: Type: Associative array of custom strings keys (AttributeName) to AttributeValue structures

A map of attribute values as they appear before or after the UpdateItem operation, as determined by the ReturnValues parameter.

The Attributes map is only present if the update was successful and ReturnValues was specified as something other than NONE in the request. Each element represents one attribute.

ConsumedCapacity

: Type: ConsumedCapacity structure

The capacity units consumed by the UpdateItem operation. The data returned includes the total provisioned throughput consumed, along with statistics for the table and any indexes involved in the operation. ConsumedCapacity is only returned if the ReturnConsumedCapacity parameter was specified. For more information, see Capacity unity consumption for write operations in the Amazon DynamoDB Developer Guide.

ItemCollectionMetrics

: Type: ItemCollectionMetrics structure

Information about item collections, if any, that were affected by the UpdateItem operation. ItemCollectionMetrics is only returned if the ReturnItemCollectionMetrics parameter was specified. If the table does not have any local secondary indexes, this information is not returned in the response.

Each ItemCollectionMetrics element consists of:

ItemCollectionKey - The partition key value of the item collection. This is the same as the partition key value of the item itself.
SizeEstimateRangeGB - An estimate of item collection size, in gigabytes. This value is a two-element array containing a lower bound and an upper bound for the estimate. The estimate includes the size of all the items in the table, plus the size of all attributes projected into all of the local secondary indexes on that table. Use this estimate to measure whether a local secondary index is approaching its size limit.

The estimate is subject to change over time; therefore, do not rely on the precision or accuracy of the estimate.

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 update an item in a table

This example updates an item in the Music table. It adds a new attribute (Year) and modifies the AlbumTitle attribute. All of the attributes in the item, as they appear after the update, are returned in the response.

$result = $client->updateItem([
    'ExpressionAttributeNames' => [
        '#AT' => 'AlbumTitle',
        '#Y' => 'Year',
    ],
    'ExpressionAttributeValues' => [
        ':t' => [
            'S' => 'Louder Than Ever',
        ],
        ':y' => [
            'N' => '2015',
        ],
    ],
    'Key' => [
        'Artist' => [
            'S' => 'Acme Band',
        ],
        'SongTitle' => [
            'S' => 'Happy Day',
        ],
    ],
    'ReturnValues' => 'ALL_NEW',
    'TableName' => 'Music',
    'UpdateExpression' => 'SET #Y = :y, #AT = :t',
]);

Result syntax:

[
    'Attributes' => [
        'AlbumTitle' => [
            'S' => 'Louder Than Ever',
        ],
        'Artist' => [
            'S' => 'Acme Band',
        ],
        'SongTitle' => [
            'S' => 'Happy Day',
        ],
        'Year' => [
            'N' => '2015',
        ],
    ],
]

UpdateKinesisStreamingDestination

$result = $client->updateKinesisStreamingDestination([/* ... */]);
$promise = $client->updateKinesisStreamingDestinationAsync([/* ... */]);

The command to update the Kinesis stream destination.

Parameter Syntax

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

Parameter Details

Members

StreamArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) for the Kinesis stream input.

TableName

: Required: Yes
: Type: string

The table name for the Kinesis streaming destination input. You can also provide the ARN of the table in this parameter.

UpdateKinesisStreamingConfiguration

: Type: UpdateKinesisStreamingConfiguration structure

The command to update the Kinesis stream configuration.

Result Syntax

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

Result Details

Members

DestinationStatus

: Type: string

The status of the attempt to update the Kinesis streaming destination output.

StreamArn

: Type: string

The ARN for the Kinesis stream input.

TableName

: Type: string

The table name for the Kinesis streaming destination output.

UpdateKinesisStreamingConfiguration

: Type: UpdateKinesisStreamingConfiguration structure

The command to update the Kinesis streaming destination configuration.

Errors

An error occurred on the server side.

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

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.

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.

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

UpdateTable

$result = $client->updateTable([/* ... */]);
$promise = $client->updateTableAsync([/* ... */]);

Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

You can only perform one of the following operations at once:

Modify the provisioned throughput settings of the table.
Remove a global secondary index from the table.
Create a new global secondary index on the table. After the index begins backfilling, you can use UpdateTable to perform other operations.

UpdateTable is an asynchronous operation; while it's executing, the table status changes from ACTIVE to UPDATING. While it's UPDATING, you can't issue another UpdateTable request. When the table returns to the ACTIVE state, the UpdateTable operation is complete.

Parameter Syntax

$result = $client->updateTable([
    'AttributeDefinitions' => [
        [
            'AttributeName' => '<string>', // REQUIRED
            'AttributeType' => 'S|N|B', // REQUIRED
        ],
        // ...
    ],
    'BillingMode' => 'PROVISIONED|PAY_PER_REQUEST',
    'DeletionProtectionEnabled' => true || false,
    'GlobalSecondaryIndexUpdates' => [
        [
            'Create' => [
                '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
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'WriteUnitsPerSecond' => <integer>,
                ],
            ],
            'Delete' => [
                'IndexName' => '<string>', // REQUIRED
            ],
            'Update' => [
                'IndexName' => '<string>', // REQUIRED
                'OnDemandThroughput' => [
                    'MaxReadRequestUnits' => <integer>,
                    'MaxWriteRequestUnits' => <integer>,
                ],
                'ProvisionedThroughput' => [
                    'ReadCapacityUnits' => <integer>, // REQUIRED
                    'WriteCapacityUnits' => <integer>, // REQUIRED
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'WriteUnitsPerSecond' => <integer>,
                ],
            ],
        ],
        // ...
    ],
    'OnDemandThroughput' => [
        'MaxReadRequestUnits' => <integer>,
        'MaxWriteRequestUnits' => <integer>,
    ],
    'ProvisionedThroughput' => [
        'ReadCapacityUnits' => <integer>, // REQUIRED
        'WriteCapacityUnits' => <integer>, // REQUIRED
    ],
    'ReplicaUpdates' => [
        [
            'Create' => [
                'GlobalSecondaryIndexes' => [
                    [
                        'IndexName' => '<string>', // REQUIRED
                        'OnDemandThroughputOverride' => [
                            'MaxReadRequestUnits' => <integer>,
                        ],
                        'ProvisionedThroughputOverride' => [
                            'ReadCapacityUnits' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'KMSMasterKeyId' => '<string>',
                'OnDemandThroughputOverride' => [
                    'MaxReadRequestUnits' => <integer>,
                ],
                'ProvisionedThroughputOverride' => [
                    'ReadCapacityUnits' => <integer>,
                ],
                'RegionName' => '<string>', // REQUIRED
                'TableClassOverride' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
            ],
            'Delete' => [
                'RegionName' => '<string>', // REQUIRED
            ],
            'Update' => [
                'GlobalSecondaryIndexes' => [
                    [
                        'IndexName' => '<string>', // REQUIRED
                        'OnDemandThroughputOverride' => [
                            'MaxReadRequestUnits' => <integer>,
                        ],
                        'ProvisionedThroughputOverride' => [
                            'ReadCapacityUnits' => <integer>,
                        ],
                    ],
                    // ...
                ],
                'KMSMasterKeyId' => '<string>',
                'OnDemandThroughputOverride' => [
                    'MaxReadRequestUnits' => <integer>,
                ],
                'ProvisionedThroughputOverride' => [
                    'ReadCapacityUnits' => <integer>,
                ],
                'RegionName' => '<string>', // REQUIRED
                'TableClassOverride' => 'STANDARD|STANDARD_INFREQUENT_ACCESS',
            ],
        ],
        // ...
    ],
    '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
    'WarmThroughput' => [
        'ReadUnitsPerSecond' => <integer>,
        'WriteUnitsPerSecond' => <integer>,
    ],
]);

Parameter Details

Members

AttributeDefinitions

: Type: Array of AttributeDefinition structures

An array of attributes that describe the key schema for the table and indexes. If you are adding a new global secondary index to the table, AttributeDefinitions must include the key element(s) of the new index.

BillingMode

: Type: string

Controls how you are charged for read and write throughput and how you manage capacity. When switching from pay-per-request to provisioned capacity, initial provisioned capacity values must be set. The initial provisioned capacity values are estimated based on the consumed read and write capacity of your table and global secondary indexes over the past 30 minutes.

PROVISIONED - We recommend using PROVISIONED for predictable workloads. PROVISIONED sets the billing mode to Provisioned capacity mode.
PAY_PER_REQUEST - We recommend using PAY_PER_REQUEST for unpredictable workloads. PAY_PER_REQUEST sets the billing mode to On-demand capacity mode.

DeletionProtectionEnabled

: Type: boolean

Indicates whether deletion protection is to be enabled (true) or disabled (false) on the table.

GlobalSecondaryIndexUpdates

: Type: Array of GlobalSecondaryIndexUpdate structures

An array of one or more global secondary indexes for the table. For each index in the array, you can request one action:

Create - add a new global secondary index to the table.
Update - modify the provisioned throughput settings of an existing global secondary index.
Delete - remove a global secondary index from the table.

You can create or delete only one global secondary index per UpdateTable operation.

For more information, see Managing Global Secondary Indexes in the Amazon DynamoDB Developer Guide.

OnDemandThroughput

: Type: OnDemandThroughput structure

Updates the maximum number of read and write units for the specified table in on-demand capacity mode. If you use this parameter, you must specify MaxReadRequestUnits, MaxWriteRequestUnits, or both.

ProvisionedThroughput

: Type: ProvisionedThroughput structure

The new provisioned throughput settings for the specified table or index.

ReplicaUpdates

: Type: Array of ReplicationGroupUpdate structures

A list of replica update actions (create, delete, or update) for the table.

For global tables, this property only applies to global tables using Version 2019.11.21 (Current version).

SSESpecification

: Type: SSESpecification structure

The new server-side encryption settings for the specified table.

StreamSpecification

: Type: StreamSpecification structure

Represents the DynamoDB Streams configuration for the table.

You receive a ValidationException if you try to enable a stream on a table that already has a stream, or if you try to disable a stream on a table that doesn't have a stream.

TableClass

: Type: string

The table class of the table to be updated. Valid values are STANDARD and STANDARD_INFREQUENT_ACCESS.

TableName

: Required: Yes
: Type: string

The name of the table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

WarmThroughput

: Type: WarmThroughput structure

Represents the warm throughput (in read units per second and write units per second) for updating a table.

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>,
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
                    'WriteUnitsPerSecond' => <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>,
                        ],
                        'WarmThroughput' => [
                            'ReadUnitsPerSecond' => <integer>,
                            'Status' => 'CREATING|UPDATING|DELETING|ACTIVE',
                            'WriteUnitsPerSecond' => <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',
                ],
                'WarmThroughput' => [
                    'ReadUnitsPerSecond' => <integer>,
                    'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
                    'WriteUnitsPerSecond' => <integer>,
                ],
            ],
            // ...
        ],
        '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',
        'WarmThroughput' => [
            'ReadUnitsPerSecond' => <integer>,
            'Status' => 'CREATING|UPDATING|DELETING|ACTIVE|INACCESSIBLE_ENCRYPTION_CREDENTIALS|ARCHIVING|ARCHIVED',
            'WriteUnitsPerSecond' => <integer>,
        ],
    ],
]

Result Details

Members

TableDescription

: Type: TableDescription structure

Represents the properties of the table.

Errors

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.

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

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

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.

An error occurred on the server side.

Examples

Example 1: To modify a table's provisioned throughput

This example increases the provisioned read and write capacity on the Music table.

$result = $client->updateTable([
    'ProvisionedThroughput' => [
        'ReadCapacityUnits' => 10,
        'WriteCapacityUnits' => 10,
    ],
    'TableName' => 'MusicCollection',
]);

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' => [
            'LastIncreaseDateTime' => ,
            'NumberOfDecreasesToday' => 1,
            'ReadCapacityUnits' => 1,
            'WriteCapacityUnits' => 1,
        ],
        'TableName' => 'MusicCollection',
        'TableSizeBytes' => 0,
        'TableStatus' => 'UPDATING',
    ],
]

UpdateTableReplicaAutoScaling

$result = $client->updateTableReplicaAutoScaling([/* ... */]);
$promise = $client->updateTableReplicaAutoScalingAsync([/* ... */]);

Updates auto scaling settings on your global tables at once.

For global tables, this operation only applies to global tables using Version 2019.11.21 (Current version).

Parameter Syntax

$result = $client->updateTableReplicaAutoScaling([
    'GlobalSecondaryIndexUpdates' => [
        [
            'IndexName' => '<string>',
            'ProvisionedWriteCapacityAutoScalingUpdate' => [
                'AutoScalingDisabled' => true || false,
                'AutoScalingRoleArn' => '<string>',
                'MaximumUnits' => <integer>,
                'MinimumUnits' => <integer>,
                'ScalingPolicyUpdate' => [
                    'PolicyName' => '<string>',
                    'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
                        'DisableScaleIn' => true || false,
                        'ScaleInCooldown' => <integer>,
                        'ScaleOutCooldown' => <integer>,
                        'TargetValue' => <float>, // REQUIRED
                    ],
                ],
            ],
        ],
        // ...
    ],
    'ProvisionedWriteCapacityAutoScalingUpdate' => [
        'AutoScalingDisabled' => true || false,
        'AutoScalingRoleArn' => '<string>',
        'MaximumUnits' => <integer>,
        'MinimumUnits' => <integer>,
        'ScalingPolicyUpdate' => [
            'PolicyName' => '<string>',
            'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
                'DisableScaleIn' => true || false,
                'ScaleInCooldown' => <integer>,
                'ScaleOutCooldown' => <integer>,
                'TargetValue' => <float>, // REQUIRED
            ],
        ],
    ],
    'ReplicaUpdates' => [
        [
            'RegionName' => '<string>', // REQUIRED
            'ReplicaGlobalSecondaryIndexUpdates' => [
                [
                    'IndexName' => '<string>',
                    'ProvisionedReadCapacityAutoScalingUpdate' => [
                        'AutoScalingDisabled' => true || false,
                        'AutoScalingRoleArn' => '<string>',
                        'MaximumUnits' => <integer>,
                        'MinimumUnits' => <integer>,
                        'ScalingPolicyUpdate' => [
                            'PolicyName' => '<string>',
                            'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
                                'DisableScaleIn' => true || false,
                                'ScaleInCooldown' => <integer>,
                                'ScaleOutCooldown' => <integer>,
                                'TargetValue' => <float>, // REQUIRED
                            ],
                        ],
                    ],
                ],
                // ...
            ],
            'ReplicaProvisionedReadCapacityAutoScalingUpdate' => [
                'AutoScalingDisabled' => true || false,
                'AutoScalingRoleArn' => '<string>',
                'MaximumUnits' => <integer>,
                'MinimumUnits' => <integer>,
                'ScalingPolicyUpdate' => [
                    'PolicyName' => '<string>',
                    'TargetTrackingScalingPolicyConfiguration' => [ // REQUIRED
                        'DisableScaleIn' => true || false,
                        'ScaleInCooldown' => <integer>,
                        'ScaleOutCooldown' => <integer>,
                        'TargetValue' => <float>, // REQUIRED
                    ],
                ],
            ],
        ],
        // ...
    ],
    'TableName' => '<string>', // REQUIRED
]);

Parameter Details

Members

GlobalSecondaryIndexUpdates

: Type: Array of GlobalSecondaryIndexAutoScalingUpdate structures

Represents the auto scaling settings of the global secondary indexes of the replica to be updated.

ProvisionedWriteCapacityAutoScalingUpdate

: Type: AutoScalingSettingsUpdate structure

Represents the auto scaling settings to be modified for a global table or global secondary index.

ReplicaUpdates

: Type: Array of ReplicaAutoScalingUpdate structures

Represents the auto scaling settings of replicas of the table that will be modified.

TableName

: Required: Yes
: Type: string

The name of the global table to be updated. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

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

Members

TableAutoScalingDescription

: Type: TableAutoScalingDescription structure

Returns information about the auto scaling settings of a table with replicas.

Errors

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

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.

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

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.

An error occurred on the server side.

UpdateTimeToLive

$result = $client->updateTimeToLive([/* ... */]);
$promise = $client->updateTimeToLiveAsync([/* ... */]);

The UpdateTimeToLive method enables or disables Time to Live (TTL) for the specified table. A successful UpdateTimeToLive call returns the current TimeToLiveSpecification. It can take up to one hour for the change to fully process. Any additional UpdateTimeToLive calls for the same table during this one hour duration result in a ValidationException.

TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.

The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.

DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations.

DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.

As items are deleted, they are removed from any local secondary index and global secondary index immediately in the same eventually consistent way as a standard delete operation.

For more information, see Time To Live in the Amazon DynamoDB Developer Guide.

Parameter Syntax

$result = $client->updateTimeToLive([
    'TableName' => '<string>', // REQUIRED
    'TimeToLiveSpecification' => [ // REQUIRED
        'AttributeName' => '<string>', // REQUIRED
        'Enabled' => true || false, // REQUIRED
    ],
]);

Parameter Details

Members

TableName

: Required: Yes
: Type: string

The name of the table to be configured. You can also provide the Amazon Resource Name (ARN) of the table in this parameter.

TimeToLiveSpecification

: Required: Yes
: Type: TimeToLiveSpecification structure

Represents the settings used to enable or disable Time to Live for the specified table.

Result Syntax

[
    'TimeToLiveSpecification' => [
        'AttributeName' => '<string>',
        'Enabled' => true || false,
    ],
]

Result Details

Members

TimeToLiveSpecification

: Type: TimeToLiveSpecification structure

Represents the output of an UpdateTimeToLive operation.

Errors

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.

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

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

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.