Documentation

MultiRegionClient
in package
implements AwsClientInterface Uses AwsClientTrait

Interfaces, Classes and Traits

AwsClientInterface
Represents an AWS client.

Table of Contents

$aliases  : array<string|int, mixed>
$args  : array<string|int, mixed>
$clientPool  : array<string|int, AwsClientInterface>
$config  : array<string|int, mixed>
$factory  : callable
$handlerList  : HandlerList
$partition  : PartitionInterface
__call()  : mixed
__construct()  : mixed
The multi-region client constructor accepts the following options:
execute()  : mixed
executeAsync()  : mixed
getApi()  : Service
Get the service description associated with the client.
getArguments()  : mixed
getCommand()  : CommandInterface
Create a command for an operation name.
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.
getIterator()  : mixed
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests by default.
getWaiter()  : mixed
waitUntil()  : mixed
getClientFromPool()  : AwsClientInterface
getRegionFromArgs()  : mixed
parseClass()  : string
Parse the class name and return the "service" name of the client.

Properties

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 multi-region client constructor accepts the following options:

public __construct([array<string|int, mixed> $args = [] ]) : mixed
  • client_factory: (callable) An optional callable that takes an array of client configuration arguments and returns a regionalized client.
  • partition: (Aws\Endpoint\Partition|string) AWS partition to connect to. Valid partitions include "aws," "aws-cn," and "aws-us-gov." Used to restrict the scope of the mapRegions method.
  • region: (string) Region to connect to when no override is provided. Used to create the default client factory and determine the appropriate AWS partition when present.
Parameters
$args : array<string|int, mixed> = []

Client configuration arguments.

Return values
mixed —

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:

  • @http: Associative array of transfer specific options to apply to the request that is serialized for this command. Available keys include "proxy", "verify", "timeout", "connect_timeout", "debug", "delay", and "headers".
  • @region: The region to which the command should be sent.
Parameters
$name : string

Name of the operation to use in the command

$args : array<string|int, mixed> = []

Arguments to pass to the command

Tags
throws
InvalidArgumentException

if no command can be found by name

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 —

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 —

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 by default.

public getRegion() : string
Return values
string —

getWaiter()

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

waitUntil()

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

getClientFromPool()

protected getClientFromPool([string $region = '' ]) : AwsClientInterface
Parameters
$region : string = ''

Omit this argument or pass in an empty string to allow the configured client factory to apply the region.

Return values
AwsClientInterface —

getRegionFromArgs()

private getRegionFromArgs(array<string|int, mixed> $args) : mixed
Parameters
$args : array<string|int, mixed>
Return values
mixed —

parseClass()

Parse the class name and return the "service" name of the client.

private parseClass() : string
Return values
string —

Search results