Represents an AWS client.
Table of Contents MethodsCreates and executes a command for an operation by name.
public __call(string $name, array<string|int, mixed> $arguments) : ResultInterface
Suffixing an operation name with "Async" will return a promise that can be used to execute commands asynchronously.
ParametersName of the command to execute.
Arguments to pass to the getCommand method.
Execute a single command.
public execute(CommandInterface $command) : ResultInterface Parameters
Command to execute
Execute a command asynchronously.
public executeAsync(CommandInterface $command) : PromiseInterface Parameters
Command to execute
Get the service description associated with the client.
public getApi() : Service Return valuesService getCommand()
Create a command for an operation name.
public getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Special keys may be set on the command to control how it behaves, including:
Name of the operation to use in the command
Arguments to pass to the command
if no command can be found by name
Get a client configuration value.
public getConfig([string|null $option = null ]) : mixed|null Parameters
The option to retrieve. Pass null to retrieve all options.
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 valuesPromiseInterface getEndpoint()Gets the default endpoint, or base URL, used by the client.
public getEndpoint() : UriInterface Return valuesUriInterface 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 valuesHandlerList getIterator()Get a resource iterator for the specified operation.
public getIterator(string $name[, array<string|int, mixed> $args = [] ]) : Iterator Parameters
Name of the iterator to retrieve.
Command arguments to use with each command.
if the iterator config is invalid.
Get a result paginator for the specified operation.
public getPaginator(string $name[, array<string|int, mixed> $args = [] ]) : ResultPaginator Parameters
Name of the operation used for iterator
Command args to be used with each command
if the iterator config is invalid.
Get the region to which the client is configured to send requests.
public getRegion() : string Return valuesstring getWaiter()
Get a waiter that waits until a resource is in a particular state.
public getWaiter(string|callable $name[, array<string|int, mixed> $args = [] ]) : Waiter
Retrieving a waiter can be useful when you wish to wait asynchronously:
$waiter = $client->getWaiter('foo', ['bar' => 'baz']); $waiter->promise()->then(function () { echo 'Done!'; });
ParametersName of the waiter that defines the wait configuration and conditions.
Args to be used with each command executed by the waiter. Waiter configuration options can be provided in an associative array in the @waiter key.
if the waiter is invalid.
Wait until a resource is in a particular state.
public waitUntil(string|callable $name[, array<string|int, mixed> $args = [] ]) : void Parameters
Name of the waiter that defines the wait configuration and conditions.
Args to be used with each command executed by the waiter. Waiter configuration options can be provided in an associative array in the @waiter key.
if the waiter is invalid.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4