Documentation

ClientOptions extends Enum
in package

Contains enumerable default factory options that can be passed to a client's factory method

Table of Contents

Constants

BACKOFF  = 'client.backoff'
BACKOFF_LOGGER  = 'client.backoff.logger'
BACKOFF_LOGGER_TEMPLATE  = 'client.backoff.logger.template'
BASE_URL  = 'base_url'
Instead of using a `region` and `scheme`, you can specify a custom base URL for the client.
CREDENTIALS  = 'credentials'
Provide an array of "key", "secret", and "token" or an instance of `Aws\Common\Credentials\CredentialsInterface`.
CREDENTIALS_CACHE  = 'credentials.cache'
CREDENTIALS_CACHE_KEY  = 'credentials.cache.key'
CREDENTIALS_CLIENT  = 'credentials.client'
KEY  = 'key'
AWS Access Key ID
MODEL_PROCESSING  = 'command.model_processing'
PROFILE  = 'profile'
REGION  = 'region'
SCHEME  = 'scheme'
SECRET  = 'secret'
AWS secret access key
SERVICE  = 'service'
SERVICE_DESCRIPTION  = 'service.description'
SIGNATURE  = 'signature'
SIGNATURE_REGION  = 'signature.region'
SIGNATURE_SERVICE  = 'signature.service'
SSL_CERT  = 'ssl.certificate_authority'
Set to true to use the bundled CA cert or pass the full path to an SSL certificate bundle. This option should be modified when you encounter curl error code 60. Set to "system" to use the cacert bundle on your system.
TOKEN  = 'token'
Custom AWS security token to use with request authentication.
TOKEN_TTD  = 'token.ttd'
VALIDATION  = 'validation'
VERSION  = 'version'

Properties

$cache  : array<string|int, mixed>

Methods

keys()  : array<string|int, mixed>
Returns the names (or keys) of all of constants in the enum
values()  : array<string|int, mixed>
Return the names and values of all the constants in the enum

Constants

BACKOFF

public string BACKOFF = 'client.backoff'

Option key holding an exponential backoff plugin

BACKOFF_LOGGER

public string BACKOFF_LOGGER = 'client.backoff.logger'

Guzzle\Log\LogAdapterInterface object used to log backoff retries. Use 'debug' to emit PHP warnings when a retry is issued.

BACKOFF_LOGGER_TEMPLATE

public string BACKOFF_LOGGER_TEMPLATE = 'client.backoff.logger.template'

Optional template to use for exponential backoff log messages. See Guzzle\Plugin\Backoff\BackoffLogger for formatting information.

BASE_URL

Instead of using a `region` and `scheme`, you can specify a custom base URL for the client.

Use the "endpoint" option instead.

public mixed BASE_URL = 'base_url'

CREDENTIALS

Provide an array of "key", "secret", and "token" or an instance of `Aws\Common\Credentials\CredentialsInterface`.

public mixed CREDENTIALS = 'credentials'

CREDENTIALS_CACHE

public string CREDENTIALS_CACHE = 'credentials.cache'

Used to cache credentials when using providers that require HTTP requests. Set the trueto use the default APC cache or provide a Guzzle\Cache\CacheAdapterInterface object.

CREDENTIALS_CACHE_KEY

public string CREDENTIALS_CACHE_KEY = 'credentials.cache.key'

Optional custom cache key to use with the credentials

CREDENTIALS_CLIENT

public string CREDENTIALS_CLIENT = 'credentials.client'

Pass this option to specify a custom Guzzle\Http\ClientInterface to use if your credentials require a HTTP request (e.g. RefreshableInstanceProfileCredentials)

KEY

AWS Access Key ID

Use "credentials" instead.

public mixed KEY = 'key'

MODEL_PROCESSING

public string MODEL_PROCESSING = 'command.model_processing'

Whether or not modeled responses have transformations applied to them

PROFILE

public string PROFILE = 'profile'

Name of a credential profile to read from your ~/.aws/credentials file

REGION

public string REGION = 'region'

Region name (e.g. 'us-east-1', 'us-west-1', 'us-west-2', 'eu-west-1', etc...)

SCHEME

public string SCHEME = 'scheme'

URI Scheme of the base URL (e.g. 'https', 'http').

SECRET

AWS secret access key

Use "credentials" instead.

public mixed SECRET = 'secret'

SERVICE

public string SERVICE = 'service'

Specify the name of the service

SERVICE_DESCRIPTION

public string SERVICE_DESCRIPTION = 'service.description'

Service description to use with the client

SIGNATURE

public string SIGNATURE = 'signature'

You can optionally provide a custom signature implementation used to sign requests

SIGNATURE_REGION

public string SIGNATURE_REGION = 'signature.region'

Set to explicitly override the region name used in signatures

SIGNATURE_SERVICE

public string SIGNATURE_SERVICE = 'signature.service'

Set to explicitly override the service name used in signatures

SSL_CERT

Set to true to use the bundled CA cert or pass the full path to an SSL certificate bundle. This option should be modified when you encounter curl error code 60. Set to "system" to use the cacert bundle on your system.

public mixed SSL_CERT = 'ssl.certificate_authority'

TOKEN

Custom AWS security token to use with request authentication.

Use "credentials" instead.

public mixed TOKEN = 'token'

TOKEN_TTD

public string TOKEN_TTD = 'token.ttd'

UNIX timestamp for when the custom credentials expire

VALIDATION

public bool VALIDATION = 'validation'

Set to false to disable validation

VERSION

public string VERSION = 'version'

API version used by the client

Properties

$cache

protected static array<string|int, mixed> $cache = array()

A cache of all enum values to increase performance

Methods

keys()

Returns the names (or keys) of all of constants in the enum

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

values()

Return the names and values of all the constants in the enum

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results