Documentation

DynamoDbClient extends AwsClient
in package

This client is used to interact with the **Amazon DynamoDB** service.

Table of Contents

$aliases  : array<string|int, mixed>
$api  : Service
$config  : array<string|int, mixed>
$credentialProvider  : callable
$defaultRequestOptions  : array<string|int, mixed>
$endpoint  : string
$handlerList  : HandlerList
$region  : string
$signatureProvider  : callable
__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
batchExecuteStatement()  :
batchExecuteStatementAsync()  :
batchGetItem()  :
batchGetItemAsync()  :
batchWriteItem()  :
batchWriteItemAsync()  :
createBackup()  :
createBackupAsync()  :
createGlobalTable()  :
createGlobalTableAsync()  :
createTable()  :
createTableAsync()  :
deleteBackup()  :
deleteBackupAsync()  :
deleteItem()  :
deleteItemAsync()  :
deleteTable()  :
deleteTableAsync()  :
describeBackup()  :
describeBackupAsync()  :
describeContinuousBackups()  :
describeContinuousBackupsAsync()  :
describeContributorInsights()  :
describeContributorInsightsAsync()  :
describeEndpoints()  :
describeEndpointsAsync()  :
describeExport()  :
describeExportAsync()  :
describeGlobalTable()  :
describeGlobalTableAsync()  :
describeGlobalTableSettings()  :
describeGlobalTableSettingsAsync()  :
describeKinesisStreamingDestination()  :
describeKinesisStreamingDestinationAsync()  :
describeLimits()  :
describeLimitsAsync()  :
describeTable()  :
describeTableAsync()  :
describeTableReplicaAutoScaling()  :
describeTableReplicaAutoScalingAsync()  :
describeTimeToLive()  :
describeTimeToLiveAsync()  :
disableKinesisStreamingDestination()  :
disableKinesisStreamingDestinationAsync()  :
enableKinesisStreamingDestination()  :
enableKinesisStreamingDestinationAsync()  :
execute()  : mixed
executeAsync()  : mixed
executeStatement()  :
executeStatementAsync()  :
executeTransaction()  :
executeTransactionAsync()  :
exportTableToPointInTime()  :
exportTableToPointInTimeAsync()  :
factory()  : static
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getCommand()  : CommandInterface
getConfig()  : mixed|null
Get a client configuration value.
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getItem()  :
getItemAsync()  :
getIterator()  : mixed
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests.
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
listBackups()  :
listBackupsAsync()  :
listContributorInsights()  :
listContributorInsightsAsync()  :
listExports()  :
listExportsAsync()  :
listGlobalTables()  :
listGlobalTablesAsync()  :
listTables()  :
listTablesAsync()  :
listTagsOfResource()  :
listTagsOfResourceAsync()  :
putItem()  :
putItemAsync()  :
query()  :
queryAsync()  :
registerSessionHandler()  : SessionHandler
Convenience method for instantiating and registering the DynamoDB Session handler with this DynamoDB client object.
restoreTableFromBackup()  :
restoreTableFromBackupAsync()  :
restoreTableToPointInTime()  :
restoreTableToPointInTimeAsync()  :
scan()  :
scanAsync()  :
tagResource()  :
tagResourceAsync()  :
transactGetItems()  :
transactGetItemsAsync()  :
transactWriteItems()  :
transactWriteItemsAsync()  :
untagResource()  :
untagResourceAsync()  :
updateContinuousBackups()  :
updateContinuousBackupsAsync()  :
updateContributorInsights()  :
updateContributorInsightsAsync()  :
updateGlobalTable()  :
updateGlobalTableAsync()  :
updateGlobalTableSettings()  :
updateGlobalTableSettingsAsync()  :
updateItem()  :
updateItemAsync()  :
updateTable()  :
updateTableAsync()  :
updateTableReplicaAutoScaling()  :
updateTableReplicaAutoScalingAsync()  :
updateTimeToLive()  :
updateTimeToLiveAsync()  :
waitUntil()  : mixed
addEndpointDiscoveryMiddleware()  : mixed
addEndpointParameterMiddleware()  : mixed
addInvocationId()  : mixed
addSignatureMiddleware()  : mixed
addStreamRequestPayload()  : mixed
loadAliases()  : mixed
parseClass()  : array<string|int, mixed>
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

Properties

$aliases

private array<string|int, mixed> $aliases

$config

private array<string|int, mixed> $config

$credentialProvider

private callable $credentialProvider

$defaultRequestOptions

private array<string|int, mixed> $defaultRequestOptions

$signatureProvider

private callable $signatureProvider

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed>
Return values
mixed —

__construct()

The client constructor accepts the following options:

public __construct(array<string|int, mixed> $args) : mixed
  • api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
  • credentials: (Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies the credentials used to sign requests. Provide an Aws\Credentials\CredentialsInterface object, an associative array of "key", "secret", and an optional "token" key, false to use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment.
  • csm: (Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies the credentials used to sign requests. Provide an Aws\ClientSideMonitoring\ConfigurationInterface object, a callable configuration provider used to create client-side monitoring configuration, false to disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project
  • debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
  • stats: (bool|array) Set to true to gather transfer statistics on requests sent. Alternatively, you can provide an associative array with the following keys: retries: (bool) Set to false to disable reporting on retries attempted; http: (bool) Set to true to enable collecting statistics from lower level HTTP adapters (e.g., values returned in GuzzleHttp\TransferStats). HTTP handlers must support an http_stats_receiver option for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds.
  • disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
  • endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
  • endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
  • endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
  • handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
  • http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
  • http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
  • idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
  • profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
  • region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
  • retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
  • scheme: (string, default=string(5) "https") URI scheme to use when connecting connect. The SDK will utilize "https" endpoints (i.e., utilize SSL/TLS connections) by default. You can attempt to connect to a service over an unencrypted "http" endpoint by setting scheme to "http".
  • signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
  • signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
  • use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
  • validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
  • version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

if any required options are missing or the service is not supported.

Return values
mixed —

__sleep()

public __sleep() : mixed
Return values
mixed —

batchExecuteStatement()

public batchExecuteStatement(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

batchExecuteStatementAsync()

public batchExecuteStatementAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

batchGetItem()

public batchGetItem(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

batchGetItemAsync()

public batchGetItemAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

batchWriteItem()

public batchWriteItem(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

batchWriteItemAsync()

public batchWriteItemAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createBackup()

public createBackup(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

createBackupAsync()

public createBackupAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

createGlobalTable()

public createGlobalTable(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

createGlobalTableAsync()

public createGlobalTableAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

createTable()

public createTable(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

createTableAsync()

public createTableAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteBackup()

public deleteBackup(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteBackupAsync()

public deleteBackupAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteItem()

public deleteItem(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteItemAsync()

public deleteItemAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteTable()

public deleteTable(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

deleteTableAsync()

public deleteTableAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeBackup()

public describeBackup(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeBackupAsync()

public describeBackupAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeContinuousBackups()

public describeContinuousBackups(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeContinuousBackupsAsync()

public describeContinuousBackupsAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeContributorInsights()

public describeContributorInsights(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeContributorInsightsAsync()

public describeContributorInsightsAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeEndpoints()

public describeEndpoints(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeEndpointsAsync()

public describeEndpointsAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeExport()

public describeExport(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeExportAsync()

public describeExportAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGlobalTable()

public describeGlobalTable(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGlobalTableAsync()

public describeGlobalTableAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGlobalTableSettings()

public describeGlobalTableSettings(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeGlobalTableSettingsAsync()

public describeGlobalTableSettingsAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeKinesisStreamingDestination()

public describeKinesisStreamingDestination(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeKinesisStreamingDestinationAsync()

public describeKinesisStreamingDestinationAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeLimits()

public describeLimits(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeLimitsAsync()

public describeLimitsAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeTable()

public describeTable(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeTableAsync()

public describeTableAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeTableReplicaAutoScaling()

public describeTableReplicaAutoScaling(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeTableReplicaAutoScalingAsync()

public describeTableReplicaAutoScalingAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeTimeToLive()

public describeTimeToLive(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

describeTimeToLiveAsync()

public describeTimeToLiveAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

disableKinesisStreamingDestination()

public disableKinesisStreamingDestination(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

disableKinesisStreamingDestinationAsync()

public disableKinesisStreamingDestinationAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

enableKinesisStreamingDestination()

public enableKinesisStreamingDestination(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

enableKinesisStreamingDestinationAsync()

public enableKinesisStreamingDestinationAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

executeStatement()

public executeStatement(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

executeStatementAsync()

public executeStatementAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

executeTransaction()

public executeTransaction(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

executeTransactionAsync()

public executeTransactionAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

exportTableToPointInTime()

public exportTableToPointInTime(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

exportTableToPointInTimeAsync()

public exportTableToPointInTimeAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

factory()

public static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
$config : array<string|int, mixed> = []
Tags
deprecated
Return values
static —

getArguments()

Get an array of client constructor arguments used by the client.

public static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getConfig()

Get a client configuration value.

public getConfig([mixed $option = null ]) : mixed|null
Parameters
$option : mixed = null

The option to retrieve. Pass null to retrieve all options.

Return values
mixed|null —

getCredentials()

Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.

public getCredentials() : PromiseInterface

If you need the credentials synchronously, then call the wait() method on the returned promise.

Return values
PromiseInterface —

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.

Return values
HandlerList —

getItem()

public getItem(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getItemAsync()

public getItemAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

getIterator()

public getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

getPaginator()

public getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

getRegion()

Get the region to which the client is configured to send requests.

public getRegion() : string
Return values
string —

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable —

getWaiter()

public getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

listBackups()

public listBackups(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

listBackupsAsync()

public listBackupsAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

listContributorInsights()

public listContributorInsights(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

listContributorInsightsAsync()

public listContributorInsightsAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

listExports()

public listExports(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

listExportsAsync()

public listExportsAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

listGlobalTables()

public listGlobalTables(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

listGlobalTablesAsync()

public listGlobalTablesAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

listTables()

public listTables(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listTablesAsync()

public listTablesAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

listTagsOfResource()

public listTagsOfResource(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

listTagsOfResourceAsync()

public listTagsOfResourceAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

putItem()

public putItem(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

putItemAsync()

public putItemAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

query()

public query(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

queryAsync()

public queryAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

registerSessionHandler()

Convenience method for instantiating and registering the DynamoDB Session handler with this DynamoDB client object.

public registerSessionHandler([array<string|int, mixed> $config = [] ]) : SessionHandler
Parameters
$config : array<string|int, mixed> = []

Array of options for the session handler factory

Return values
SessionHandler —

restoreTableFromBackup()

public restoreTableFromBackup(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

restoreTableFromBackupAsync()

public restoreTableFromBackupAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

restoreTableToPointInTime()

public restoreTableToPointInTime(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

restoreTableToPointInTimeAsync()

public restoreTableToPointInTimeAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

scan()

public scan(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

scanAsync()

public scanAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

tagResource()

public tagResource(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

tagResourceAsync()

public tagResourceAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

transactGetItems()

public transactGetItems(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

transactGetItemsAsync()

public transactGetItemsAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

transactWriteItems()

public transactWriteItems(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

transactWriteItemsAsync()

public transactWriteItemsAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

untagResource()

public untagResource(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

untagResourceAsync()

public untagResourceAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateContinuousBackups()

public updateContinuousBackups(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateContinuousBackupsAsync()

public updateContinuousBackupsAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateContributorInsights()

public updateContributorInsights(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateContributorInsightsAsync()

public updateContributorInsightsAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateGlobalTable()

public updateGlobalTable(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateGlobalTableAsync()

public updateGlobalTableAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateGlobalTableSettings()

public updateGlobalTableSettings(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateGlobalTableSettingsAsync()

public updateGlobalTableSettingsAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateItem()

public updateItem(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateItemAsync()

public updateItemAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateTable()

public updateTable(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateTableAsync()

public updateTableAsync(array<string|int, mixed> $args = []) :
Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateTableReplicaAutoScaling()

public updateTableReplicaAutoScaling(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateTableReplicaAutoScalingAsync()

public updateTableReplicaAutoScalingAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateTimeToLive()

public updateTimeToLive(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

updateTimeToLiveAsync()

public updateTimeToLiveAsync(array<string|int, mixed> $args = []) :

(supported in versions 2012-08-10)

Parameters
$args = [] : array<string|int, mixed>
Return values
—

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
Return values
mixed —

addEndpointDiscoveryMiddleware()

private addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
$config : mixed
$args : mixed
Return values
mixed —

addEndpointParameterMiddleware()

private addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
$args : mixed
Return values
mixed —

addInvocationId()

private addInvocationId() : mixed
Return values
mixed —

addSignatureMiddleware()

private addSignatureMiddleware() : mixed
Return values
mixed —

addStreamRequestPayload()

private addStreamRequestPayload() : mixed
Return values
mixed —

loadAliases()

private loadAliases([mixed $file = null ]) : mixed
Parameters
$file : mixed = null
Return values
mixed —

parseClass()

Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

private parseClass() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results