Class MultiRegionClient
- Aws\MultiRegionClient implements Aws\AwsClientInterface uses Aws\AwsClientTrait
- Namespace: Aws
- Located at MultiRegionClient.php
Represents an AWS client.
Direct known subclasses
Methods Summary
- static getArguments ( )
-
__construct ( array $args = [] )
The multi-region client constructor accepts the following options:
-
getRegion ( )
Get the region to which the client is configured to send requests by default.
-
getCommand ( string $name, array $args = [] )
Create a command for an operation name.
-
getConfig ( string|null $option = null )
Get a client configuration value.
-
getCredentials ( )
Returns a promise that is fulfilled with an
Aws\Credentials\CredentialsInterfaceobject. -
getHandlerList ( )
Get the handler list used to transfer commands.
-
getApi ( )
Get the service description associated with the client.
-
getEndpoint ( )
Gets the default endpoint, or base URL, used by the client.
- useCustomHandler ( callable $handler )
Methods inherited from Aws\AwsClientInterface
Methods used from Aws\AwsClientTrait
Methods Details
static getArguments ( )
__construct ( array $args = [] )
The multi-region client constructor accepts the following options:
- 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
| array | $args = [] | Client configuration arguments. |
string getRegion ( )
Get the region to which the client is configured to send requests by default.
Returns
| string |
Implementation of
Aws\CommandInterface
getCommand (
string
$name,
array
$args = []
)
Create a command for an operation name.
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
| string | $name | Name of the operation to use in the command |
| array | $args = [] | Arguments to pass to the command |
Returns
Aws\CommandInterface |
Exceptions
| InvalidArgumentException if no command can be found by name |
Implementation of
mixed|null getConfig ( string|null $option = null )
Get a client configuration value.
Parameters
| string|null | $option = null | The option to retrieve. Pass null to retrieve all options. |
Returns
| mixed|null |
Implementation of
PromiseInterface getCredentials ( )
Returns a promise that is fulfilled with an
Aws\Credentials\CredentialsInterface object.
If you need the credentials synchronously, then call the wait() method on the returned promise.
Returns
| PromiseInterface |
Implementation of
Aws\HandlerList
getHandlerList (
)
Get the handler list used to transfer commands.
This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.
Returns
Aws\HandlerList |
Implementation of
Aws\Api\Service
getApi (
)
UriInterface getEndpoint ( )
Gets the default endpoint, or base URL, used by the client.
Returns
| UriInterface |