Class Aws\AwsClient | AWS SDK for PHP 3.x

Aws\AwsClient implements Aws\AwsClientInterface uses Aws\AwsClientTrait

Namespace: Aws

Located at AwsClient.php

Default AWS client implementation

Direct known subclasses

Methods Summary

static getArguments ( )
Get an array of client constructor arguments used by the client.
__construct ( array $args )
The client constructor accepts the following options:
getHandlerList ( )
Get the handler list used to transfer commands.
getConfig ( string|null $option = null )
Get a client configuration value.
getCredentials ( )
Returns a promise that is fulfilled with an Aws\Credentials\CredentialsInterface object.
getEndpoint ( )
Gets the default endpoint, or base URL, used by the client.
getRegion ( )
Get the region to which the client is configured to send requests.
getApi ( )
Get the service description associated with the client.
getCommand ( string $name, array $args = [] )
Create a command for an operation name.
getEndpointProvider ( )
getClientContextParams ( )
Provides the set of service context parameter key-value pairs used for endpoint resolution.
getClientBuiltIns ( )
Provides the set of built-in keys and values used for endpoint resolution
__sleep ( )
final getSignatureProvider ( )
Get the signature_provider function of the client.
getEndpointProviderArgs ( )
Retrieves arguments to be used in endpoint resolution.
static applyDocFilters ( array $api, array $docs )
Returns a service model and doc model with any necessary changes applied.
static factory ( array $config = [] )

Methods inherited from Aws\AwsClientInterface

__call(), execute(), executeAsync(), getIterator(), getPaginator(), getWaiter(), waitUntil()

Methods used from Aws\AwsClientTrait

__call(), execute(), executeAsync(), getIterator(), getPaginator(), getWaiter(), waitUntil()

Methods Details

static array getArguments ( )

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

Returns

array

__construct ( array $args )

The client constructor accepts the following options:

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).

Parameters

array

$args

Client configuration arguments.

Exceptions

InvalidArgumentException

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

`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\AwsClientInterface::getHandlerList()

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

Aws\AwsClientInterface::getConfig()

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\AwsClientInterface::getCredentials()

UriInterface getEndpoint ( )

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

Returns

UriInterface

Implementation of

Aws\AwsClientInterface::getEndpoint()

string getRegion ( )

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

Returns

string

Implementation of

Aws\AwsClientInterface::getRegion()

`Aws\Api\Service` getApi ( )

Get the service description associated with the client.

Returns

Aws\Api\Service

Implementation of

Aws\AwsClientInterface::getApi()

`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".

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

Aws\AwsClientInterface::getCommand()

getEndpointProvider ( )

array getClientContextParams ( )

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

Returns

array

array getClientBuiltIns ( )

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

Returns

array

__sleep ( )

callable getSignatureProvider ( )

Get the signature_provider function of the client.

Returns

callable

array getEndpointProviderArgs ( )

Retrieves arguments to be used in endpoint resolution.

Returns

array

static array applyDocFilters ( array $api, array $docs )

Returns a service model and doc model with any necessary changes applied.

Parameters

array	$api	Array of service data being documented.
array	$docs	Array of doc model data.

Returns

array
Tuple containing a [Service, DocModel]

Codecoverageignore

static static factory ( array $config = [] )

Deprecated

Returns

static

Namespaces

Classes

Interfaces

Traits

Functions

Class AwsClient

Direct known subclasses

Methods Summary

Methods inherited from Aws\AwsClientInterface

Methods used from Aws\AwsClientTrait

Methods Details

static array getArguments ( )

Returns

__construct ( array $args )

Parameters

Exceptions

Aws\HandlerList getHandlerList ( )

Returns

Implementation of

mixed|null getConfig ( string|null $option = null )

Parameters

Returns

Implementation of

PromiseInterface getCredentials ( )

Returns

Implementation of

UriInterface getEndpoint ( )

Returns

Implementation of

string getRegion ( )

Returns

Implementation of

Aws\Api\Service getApi ( )

Returns

Implementation of

Aws\CommandInterface getCommand ( string $name, array $args = [] )

Parameters

Returns

Exceptions

Implementation of

getEndpointProvider ( )

array getClientContextParams ( )

Returns

array getClientBuiltIns ( )

Returns

__sleep ( )

callable getSignatureProvider ( )

Returns

array getEndpointProviderArgs ( )

Returns

static array applyDocFilters ( array $api, array $docs )

Parameters

Returns

Codecoverageignore

static static factory ( array $config = [] )

Deprecated

Returns

`Aws\HandlerList` getHandlerList ( )

`Aws\Api\Service` getApi ( )

`Aws\CommandInterface` getCommand ( string $name, array $args = [] )