SDK for PHP 3.x

DynamoDbClient extends AwsClient
in package

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

Supported API Versions

This class uses a service description model that is associated at runtime based on the version option given when constructing the client. The version option will determine which API operations, waiters, and paginators are available for a client. Creating a command or a specific API operation can be done using magic methods (e.g., $client->commandName(/** parameters */), or using the $client->getCommand method of the client.

Table of Contents

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
batchExecuteStatement()  : Result
batchExecuteStatementAsync()  : Promise
batchGetItem()  : Result
batchGetItemAsync()  : Promise
batchWriteItem()  : Result
batchWriteItemAsync()  : Promise
createBackup()  : Result
createBackupAsync()  : Promise
createGlobalTable()  : Result
createGlobalTableAsync()  : Promise
createTable()  : Result
createTableAsync()  : Promise
deleteBackup()  : Result
deleteBackupAsync()  : Promise
deleteItem()  : Result
deleteItemAsync()  : Promise
deleteResourcePolicy()  : Result
deleteResourcePolicyAsync()  : Promise
deleteTable()  : Result
deleteTableAsync()  : Promise
describeBackup()  : Result
describeBackupAsync()  : Promise
describeContinuousBackups()  : Result
describeContinuousBackupsAsync()  : Promise
describeContributorInsights()  : Result
describeContributorInsightsAsync()  : Promise
describeEndpoints()  : Result
describeEndpointsAsync()  : Promise
describeExport()  : Result
describeExportAsync()  : Promise
describeGlobalTable()  : Result
describeGlobalTableAsync()  : Promise
describeGlobalTableSettings()  : Result
describeGlobalTableSettingsAsync()  : Promise
describeImport()  : Result
describeImportAsync()  : Promise
describeKinesisStreamingDestination()  : Result
describeKinesisStreamingDestinationAsync()  : Promise
describeLimits()  : Result
describeLimitsAsync()  : Promise
describeTable()  : Result
describeTableAsync()  : Promise
describeTableReplicaAutoScaling()  : Result
describeTableReplicaAutoScalingAsync()  : Promise
describeTimeToLive()  : Result
describeTimeToLiveAsync()  : Promise
disableKinesisStreamingDestination()  : Result
disableKinesisStreamingDestinationAsync()  : Promise
emitDeprecationWarning()  : mixed
enableKinesisStreamingDestination()  : Result
enableKinesisStreamingDestinationAsync()  : Promise
execute()  : mixed
executeAsync()  : mixed
executeStatement()  : Result
executeStatementAsync()  : Promise
executeTransaction()  : Result
executeTransactionAsync()  : Promise
exportTableToPointInTime()  : Result
exportTableToPointInTimeAsync()  : Promise
factory()  : static
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getClientBuiltIns()  : array<string|int, mixed>
Provides the set of built-in keys and values used for endpoint resolution
getClientContextParams()  : array<string|int, mixed>
Provides the set of service context parameter key-value pairs used for endpoint resolution.
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.
getEndpointProvider()  : mixed
getEndpointProviderArgs()  : array<string|int, mixed>
Retrieves arguments to be used in endpoint resolution.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getItem()  : Result
getItemAsync()  : Promise
getIterator()  : mixed
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests.
getResourcePolicy()  : Result
getResourcePolicyAsync()  : Promise
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
importTable()  : Result
importTableAsync()  : Promise
listBackups()  : Result
listBackupsAsync()  : Promise
listContributorInsights()  : Result
listContributorInsightsAsync()  : Promise
listExports()  : Result
listExportsAsync()  : Promise
listGlobalTables()  : Result
listGlobalTablesAsync()  : Promise
listImports()  : Result
listImportsAsync()  : Promise
listTables()  : Result
listTablesAsync()  : Promise
listTagsOfResource()  : Result
listTagsOfResourceAsync()  : Promise
putItem()  : Result
putItemAsync()  : Promise
putResourcePolicy()  : Result
putResourcePolicyAsync()  : Promise
query()  : Result
queryAsync()  : Promise
registerSessionHandler()  : SessionHandler
Convenience method for instantiating and registering the DynamoDB Session handler with this DynamoDB client object.
restoreTableFromBackup()  : Result
restoreTableFromBackupAsync()  : Promise
restoreTableToPointInTime()  : Result
restoreTableToPointInTimeAsync()  : Promise
scan()  : Result
scanAsync()  : Promise
tagResource()  : Result
tagResourceAsync()  : Promise
transactGetItems()  : Result
transactGetItemsAsync()  : Promise
transactWriteItems()  : Result
transactWriteItemsAsync()  : Promise
untagResource()  : Result
untagResourceAsync()  : Promise
updateContinuousBackups()  : Result
updateContinuousBackupsAsync()  : Promise
updateContributorInsights()  : Result
updateContributorInsightsAsync()  : Promise
updateGlobalTable()  : Result
updateGlobalTableAsync()  : Promise
updateGlobalTableSettings()  : Result
updateGlobalTableSettingsAsync()  : Promise
updateItem()  : Result
updateItemAsync()  : Promise
updateKinesisStreamingDestination()  : Result
updateKinesisStreamingDestinationAsync()  : Promise
updateTable()  : Result
updateTableAsync()  : Promise
updateTableReplicaAutoScaling()  : Result
updateTableReplicaAutoScalingAsync()  : Promise
updateTimeToLive()  : Result
updateTimeToLiveAsync()  : Promise
waitUntil()  : mixed

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, 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.
  • token: (Aws\Token\TokenInterface|array|bool|callable) Specifies the token used to authorize requests. Provide an Aws\Token\TokenInterface object, an associative array of "token" and an optional "expires" key, false to use no token, or a callable token provider used to create a token or return null. See Aws\Token\TokenProvider for a list of built-in token providers. If no token is provided, the SDK will attempt to load one 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).
  • ua_append: (string, array) To pass custom user agent parameters.
  • app_id: (string) an optional application specific identifier that can be set. When set it will be appended to the User-Agent header of every request in the form of App/{AppId}. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. See https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html for more information on environment variables and shared config settings.
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

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

__sleep()

public __sleep() : mixed

batchExecuteStatement()

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

(supported in versions 2012-08-10)

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

batchExecuteStatementAsync()

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

(supported in versions 2012-08-10)

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

batchGetItem()

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

batchGetItemAsync()

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

batchWriteItem()

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

batchWriteItemAsync()

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

createBackup()

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

(supported in versions 2012-08-10)

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

createBackupAsync()

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

(supported in versions 2012-08-10)

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

createGlobalTable()

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

(supported in versions 2012-08-10)

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

createGlobalTableAsync()

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

(supported in versions 2012-08-10)

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

createTable()

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

createTableAsync()

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

deleteBackup()

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

(supported in versions 2012-08-10)

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

deleteBackupAsync()

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

(supported in versions 2012-08-10)

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

deleteItem()

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

deleteItemAsync()

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

deleteResourcePolicy()

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

(supported in versions 2012-08-10)

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

deleteResourcePolicyAsync()

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

(supported in versions 2012-08-10)

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

deleteTable()

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

deleteTableAsync()

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

describeBackup()

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

(supported in versions 2012-08-10)

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

describeBackupAsync()

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

(supported in versions 2012-08-10)

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

describeContinuousBackups()

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

(supported in versions 2012-08-10)

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

describeContinuousBackupsAsync()

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

(supported in versions 2012-08-10)

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

describeContributorInsights()

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

(supported in versions 2012-08-10)

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

describeContributorInsightsAsync()

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

(supported in versions 2012-08-10)

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

describeEndpoints()

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

(supported in versions 2012-08-10)

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

describeEndpointsAsync()

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

(supported in versions 2012-08-10)

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

describeExport()

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

(supported in versions 2012-08-10)

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

describeExportAsync()

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

(supported in versions 2012-08-10)

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

describeGlobalTable()

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

(supported in versions 2012-08-10)

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

describeGlobalTableAsync()

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

(supported in versions 2012-08-10)

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

describeGlobalTableSettings()

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

(supported in versions 2012-08-10)

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

describeGlobalTableSettingsAsync()

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

(supported in versions 2012-08-10)

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

describeImport()

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

(supported in versions 2012-08-10)

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

describeImportAsync()

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

(supported in versions 2012-08-10)

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

describeKinesisStreamingDestination()

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

(supported in versions 2012-08-10)

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

describeKinesisStreamingDestinationAsync()

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

(supported in versions 2012-08-10)

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

describeLimits()

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

(supported in versions 2012-08-10)

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

describeLimitsAsync()

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

(supported in versions 2012-08-10)

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

describeTable()

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

describeTableAsync()

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

describeTableReplicaAutoScaling()

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

(supported in versions 2012-08-10)

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

describeTableReplicaAutoScalingAsync()

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

(supported in versions 2012-08-10)

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

describeTimeToLive()

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

(supported in versions 2012-08-10)

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

describeTimeToLiveAsync()

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

(supported in versions 2012-08-10)

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

disableKinesisStreamingDestination()

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

(supported in versions 2012-08-10)

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

disableKinesisStreamingDestinationAsync()

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

(supported in versions 2012-08-10)

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

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

enableKinesisStreamingDestination()

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

(supported in versions 2012-08-10)

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

enableKinesisStreamingDestinationAsync()

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

(supported in versions 2012-08-10)

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

executeStatement()

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

(supported in versions 2012-08-10)

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

executeStatementAsync()

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

(supported in versions 2012-08-10)

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

executeTransaction()

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

(supported in versions 2012-08-10)

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

executeTransactionAsync()

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

(supported in versions 2012-08-10)

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

exportTableToPointInTime()

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

(supported in versions 2012-08-10)

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

exportTableToPointInTimeAsync()

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

(supported in versions 2012-08-10)

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

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>

getClientBuiltIns()

Provides the set of built-in keys and values used for endpoint resolution

public getClientBuiltIns() : array<string|int, mixed>
Return values
array<string|int, mixed>

getClientContextParams()

Provides the set of service context parameter key-value pairs used for endpoint resolution.

public getClientContextParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCommand()

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

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

getEndpoint()

Gets the default endpoint, or base URL, used by the client.

public getEndpoint() : UriInterface
Return values
UriInterface

getEndpointProvider()

public getEndpointProvider() : mixed

getEndpointProviderArgs()

Retrieves arguments to be used in endpoint resolution.

public getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>

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 = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getItemAsync()

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

getIterator()

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

getPaginator()

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

getRegion()

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

public getRegion() : string
Return values
string

getResourcePolicy()

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

(supported in versions 2012-08-10)

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

getResourcePolicyAsync()

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

(supported in versions 2012-08-10)

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

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> = []

importTable()

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

(supported in versions 2012-08-10)

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

importTableAsync()

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

(supported in versions 2012-08-10)

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

listBackups()

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

(supported in versions 2012-08-10)

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

listBackupsAsync()

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

(supported in versions 2012-08-10)

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

listContributorInsights()

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

(supported in versions 2012-08-10)

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

listContributorInsightsAsync()

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

(supported in versions 2012-08-10)

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

listExports()

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

(supported in versions 2012-08-10)

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

listExportsAsync()

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

(supported in versions 2012-08-10)

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

listGlobalTables()

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

(supported in versions 2012-08-10)

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

listGlobalTablesAsync()

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

(supported in versions 2012-08-10)

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

listImports()

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

(supported in versions 2012-08-10)

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

listImportsAsync()

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

(supported in versions 2012-08-10)

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

listTables()

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

listTablesAsync()

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

listTagsOfResource()

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

(supported in versions 2012-08-10)

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

listTagsOfResourceAsync()

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

(supported in versions 2012-08-10)

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

putItem()

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

putItemAsync()

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

putResourcePolicy()

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

(supported in versions 2012-08-10)

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

putResourcePolicyAsync()

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

(supported in versions 2012-08-10)

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

query()

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

queryAsync()

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

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 = []) : Result

(supported in versions 2012-08-10)

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

restoreTableFromBackupAsync()

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

(supported in versions 2012-08-10)

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

restoreTableToPointInTime()

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

(supported in versions 2012-08-10)

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

restoreTableToPointInTimeAsync()

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

(supported in versions 2012-08-10)

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

scan()

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

scanAsync()

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

tagResource()

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

(supported in versions 2012-08-10)

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

tagResourceAsync()

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

(supported in versions 2012-08-10)

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

transactGetItems()

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

(supported in versions 2012-08-10)

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

transactGetItemsAsync()

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

(supported in versions 2012-08-10)

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

transactWriteItems()

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

(supported in versions 2012-08-10)

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

transactWriteItemsAsync()

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

(supported in versions 2012-08-10)

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

untagResource()

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

(supported in versions 2012-08-10)

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

untagResourceAsync()

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

(supported in versions 2012-08-10)

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

updateContinuousBackups()

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

(supported in versions 2012-08-10)

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

updateContinuousBackupsAsync()

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

(supported in versions 2012-08-10)

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

updateContributorInsights()

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

(supported in versions 2012-08-10)

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

updateContributorInsightsAsync()

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

(supported in versions 2012-08-10)

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

updateGlobalTable()

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

(supported in versions 2012-08-10)

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

updateGlobalTableAsync()

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

(supported in versions 2012-08-10)

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

updateGlobalTableSettings()

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

(supported in versions 2012-08-10)

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

updateGlobalTableSettingsAsync()

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

(supported in versions 2012-08-10)

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

updateItem()

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

updateItemAsync()

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

updateKinesisStreamingDestination()

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

(supported in versions 2012-08-10)

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

updateKinesisStreamingDestinationAsync()

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

(supported in versions 2012-08-10)

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

updateTable()

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

updateTableAsync()

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

updateTableReplicaAutoScaling()

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

(supported in versions 2012-08-10)

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

updateTableReplicaAutoScalingAsync()

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

(supported in versions 2012-08-10)

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

updateTimeToLive()

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

(supported in versions 2012-08-10)

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

updateTimeToLiveAsync()

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

(supported in versions 2012-08-10)

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

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
On this page