ElasticBeanstalkClient
extends AwsClient
in package
This client is used to interact with the **AWS Elastic Beanstalk** service.
Table of Contents
- $aliases : array<string|int, mixed>
- $api : Service
- $config : array<string|int, mixed>
- $credentialProvider : callable
- $defaultRequestOptions : array<string|int, mixed>
- $endpoint : string
- $handlerList : HandlerList
- $region : string
- $signatureProvider : callable
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- abortEnvironmentUpdate() :
- abortEnvironmentUpdateAsync() :
- applyEnvironmentManagedAction() :
- applyEnvironmentManagedActionAsync() :
- associateEnvironmentOperationsRole() :
- associateEnvironmentOperationsRoleAsync() :
- checkDNSAvailability() :
- checkDNSAvailabilityAsync() :
- composeEnvironments() :
- composeEnvironmentsAsync() :
- createApplication() :
- createApplicationAsync() :
- createApplicationVersion() :
- createApplicationVersionAsync() :
- createConfigurationTemplate() :
- createConfigurationTemplateAsync() :
- createEnvironment() :
- createEnvironmentAsync() :
- createPlatformVersion() :
- createPlatformVersionAsync() :
- createStorageLocation() :
- createStorageLocationAsync() :
- deleteApplication() :
- deleteApplicationAsync() :
- deleteApplicationVersion() :
- deleteApplicationVersionAsync() :
- deleteConfigurationTemplate() :
- deleteConfigurationTemplateAsync() :
- deleteEnvironmentConfiguration() :
- deleteEnvironmentConfigurationAsync() :
- deletePlatformVersion() :
- deletePlatformVersionAsync() :
- describeAccountAttributes() :
- describeAccountAttributesAsync() :
- describeApplications() :
- describeApplicationsAsync() :
- describeApplicationVersions() :
- describeApplicationVersionsAsync() :
- describeConfigurationOptions() :
- describeConfigurationOptionsAsync() :
- describeConfigurationSettings() :
- describeConfigurationSettingsAsync() :
- describeEnvironmentHealth() :
- describeEnvironmentHealthAsync() :
- describeEnvironmentManagedActionHistory() :
- describeEnvironmentManagedActionHistoryAsync() :
- describeEnvironmentManagedActions() :
- describeEnvironmentManagedActionsAsync() :
- describeEnvironmentResources() :
- describeEnvironmentResourcesAsync() :
- describeEnvironments() :
- describeEnvironmentsAsync() :
- describeEvents() :
- describeEventsAsync() :
- describeInstancesHealth() :
- describeInstancesHealthAsync() :
- describePlatformVersion() :
- describePlatformVersionAsync() :
- disassociateEnvironmentOperationsRole() :
- disassociateEnvironmentOperationsRoleAsync() :
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- getApi() : Service
- getArguments() : array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
- getCommand() : CommandInterface
- 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.
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getWaiter() : mixed
- listAvailableSolutionStacks() :
- listAvailableSolutionStacksAsync() :
- listPlatformBranches() :
- listPlatformBranchesAsync() :
- listPlatformVersions() :
- listPlatformVersionsAsync() :
- listTagsForResource() :
- listTagsForResourceAsync() :
- rebuildEnvironment() :
- rebuildEnvironmentAsync() :
- requestEnvironmentInfo() :
- requestEnvironmentInfoAsync() :
- restartAppServer() :
- restartAppServerAsync() :
- retrieveEnvironmentInfo() :
- retrieveEnvironmentInfoAsync() :
- swapEnvironmentCNAMEs() :
- swapEnvironmentCNAMEsAsync() :
- terminateEnvironment() :
- terminateEnvironmentAsync() :
- updateApplication() :
- updateApplicationAsync() :
- updateApplicationResourceLifecycle() :
- updateApplicationResourceLifecycleAsync() :
- updateApplicationVersion() :
- updateApplicationVersionAsync() :
- updateConfigurationTemplate() :
- updateConfigurationTemplateAsync() :
- updateEnvironment() :
- updateEnvironmentAsync() :
- updateTagsForResource() :
- updateTagsForResourceAsync() :
- validateConfigurationSettings() :
- validateConfigurationSettingsAsync() :
- waitUntil() : mixed
- addEndpointDiscoveryMiddleware() : mixed
- addEndpointParameterMiddleware() : mixed
- addInvocationId() : mixed
- addSignatureMiddleware() : mixed
- addStreamRequestPayload() : mixed
- loadAliases() : mixed
- parseClass() : array<string|int, mixed>
- Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".
Properties
$aliases
private
array<string|int, mixed>
$aliases
$api
private
Service
$api
$config
private
array<string|int, mixed>
$config
$credentialProvider
private
callable
$credentialProvider
$defaultRequestOptions
private
array<string|int, mixed>
$defaultRequestOptions
$endpoint
private
string
$endpoint
$handlerList
private
HandlerList
$handlerList
$region
private
string
$region
$signatureProvider
private
callable
$signatureProvider
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 client constructor accepts the following options:
public
__construct(array<string|int, mixed> $args) : mixed
- 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,
falseto 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. - 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,
falseto 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_receiveroption 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
schemeto "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
- $args : array<string|int, mixed>
-
Client configuration arguments.
Tags
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —abortEnvironmentUpdate()
public
abortEnvironmentUpdate(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—abortEnvironmentUpdateAsync()
public
abortEnvironmentUpdateAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—applyEnvironmentManagedAction()
public
applyEnvironmentManagedAction(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—applyEnvironmentManagedActionAsync()
public
applyEnvironmentManagedActionAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateEnvironmentOperationsRole()
public
associateEnvironmentOperationsRole(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateEnvironmentOperationsRoleAsync()
public
associateEnvironmentOperationsRoleAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—checkDNSAvailability()
public
checkDNSAvailability(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—checkDNSAvailabilityAsync()
public
checkDNSAvailabilityAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—composeEnvironments()
public
composeEnvironments(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—composeEnvironmentsAsync()
public
composeEnvironmentsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createApplication()
public
createApplication(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createApplicationAsync()
public
createApplicationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createApplicationVersion()
public
createApplicationVersion(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createApplicationVersionAsync()
public
createApplicationVersionAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createConfigurationTemplate()
public
createConfigurationTemplate(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createConfigurationTemplateAsync()
public
createConfigurationTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createEnvironment()
public
createEnvironment(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createEnvironmentAsync()
public
createEnvironmentAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createPlatformVersion()
public
createPlatformVersion(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createPlatformVersionAsync()
public
createPlatformVersionAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createStorageLocation()
public
createStorageLocation(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createStorageLocationAsync()
public
createStorageLocationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteApplication()
public
deleteApplication(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteApplicationAsync()
public
deleteApplicationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteApplicationVersion()
public
deleteApplicationVersion(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteApplicationVersionAsync()
public
deleteApplicationVersionAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteConfigurationTemplate()
public
deleteConfigurationTemplate(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteConfigurationTemplateAsync()
public
deleteConfigurationTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteEnvironmentConfiguration()
public
deleteEnvironmentConfiguration(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteEnvironmentConfigurationAsync()
public
deleteEnvironmentConfigurationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deletePlatformVersion()
public
deletePlatformVersion(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deletePlatformVersionAsync()
public
deletePlatformVersionAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeAccountAttributes()
public
describeAccountAttributes(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeAccountAttributesAsync()
public
describeAccountAttributesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeApplications()
public
describeApplications(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeApplicationsAsync()
public
describeApplicationsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeApplicationVersions()
public
describeApplicationVersions(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeApplicationVersionsAsync()
public
describeApplicationVersionsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeConfigurationOptions()
public
describeConfigurationOptions(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeConfigurationOptionsAsync()
public
describeConfigurationOptionsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeConfigurationSettings()
public
describeConfigurationSettings(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeConfigurationSettingsAsync()
public
describeConfigurationSettingsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeEnvironmentHealth()
public
describeEnvironmentHealth(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeEnvironmentHealthAsync()
public
describeEnvironmentHealthAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeEnvironmentManagedActionHistory()
public
describeEnvironmentManagedActionHistory(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeEnvironmentManagedActionHistoryAsync()
public
describeEnvironmentManagedActionHistoryAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeEnvironmentManagedActions()
public
describeEnvironmentManagedActions(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeEnvironmentManagedActionsAsync()
public
describeEnvironmentManagedActionsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeEnvironmentResources()
public
describeEnvironmentResources(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeEnvironmentResourcesAsync()
public
describeEnvironmentResourcesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeEnvironments()
public
describeEnvironments(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeEnvironmentsAsync()
public
describeEnvironmentsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeEvents()
public
describeEvents(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeEventsAsync()
public
describeEventsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeInstancesHealth()
public
describeInstancesHealth(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describeInstancesHealthAsync()
public
describeInstancesHealthAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describePlatformVersion()
public
describePlatformVersion(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—describePlatformVersionAsync()
public
describePlatformVersionAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateEnvironmentOperationsRole()
public
disassociateEnvironmentOperationsRole(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateEnvironmentOperationsRoleAsync()
public
disassociateEnvironmentOperationsRoleAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
static —getApi()
public
abstract getApi() : Service
Return values
Service —getArguments()
Get an array of client constructor arguments used by the client.
public
static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCommand()
public
abstract getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Parameters
- $name : string
- $args : array<string|int, mixed> = []
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 —getEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterface —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.
public
getRegion() : string
Return values
string —getSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callable —getWaiter()
public
getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —listAvailableSolutionStacks()
public
listAvailableSolutionStacks(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listAvailableSolutionStacksAsync()
public
listAvailableSolutionStacksAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listPlatformBranches()
public
listPlatformBranches(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listPlatformBranchesAsync()
public
listPlatformBranchesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listPlatformVersions()
public
listPlatformVersions(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listPlatformVersionsAsync()
public
listPlatformVersionsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—rebuildEnvironment()
public
rebuildEnvironment(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—rebuildEnvironmentAsync()
public
rebuildEnvironmentAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—requestEnvironmentInfo()
public
requestEnvironmentInfo(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—requestEnvironmentInfoAsync()
public
requestEnvironmentInfoAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—restartAppServer()
public
restartAppServer(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—restartAppServerAsync()
public
restartAppServerAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—retrieveEnvironmentInfo()
public
retrieveEnvironmentInfo(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—retrieveEnvironmentInfoAsync()
public
retrieveEnvironmentInfoAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—swapEnvironmentCNAMEs()
public
swapEnvironmentCNAMEs(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—swapEnvironmentCNAMEsAsync()
public
swapEnvironmentCNAMEsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—terminateEnvironment()
public
terminateEnvironment(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—terminateEnvironmentAsync()
public
terminateEnvironmentAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateApplication()
public
updateApplication(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateApplicationAsync()
public
updateApplicationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateApplicationResourceLifecycle()
public
updateApplicationResourceLifecycle(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateApplicationResourceLifecycleAsync()
public
updateApplicationResourceLifecycleAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateApplicationVersion()
public
updateApplicationVersion(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateApplicationVersionAsync()
public
updateApplicationVersionAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateConfigurationTemplate()
public
updateConfigurationTemplate(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateConfigurationTemplateAsync()
public
updateConfigurationTemplateAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateEnvironment()
public
updateEnvironment(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateEnvironmentAsync()
public
updateEnvironmentAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateTagsForResource()
public
updateTagsForResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateTagsForResourceAsync()
public
updateTagsForResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—validateConfigurationSettings()
public
validateConfigurationSettings(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—validateConfigurationSettingsAsync()
public
validateConfigurationSettingsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—waitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —addEndpointDiscoveryMiddleware()
private
addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
- $config : mixed
- $args : mixed
Return values
mixed —addEndpointParameterMiddleware()
private
addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
- $args : mixed
Return values
mixed —addInvocationId()
private
addInvocationId() : mixed
Return values
mixed —addSignatureMiddleware()
private
addSignatureMiddleware() : mixed
Return values
mixed —addStreamRequestPayload()
private
addStreamRequestPayload() : mixed
Return values
mixed —loadAliases()
private
loadAliases([mixed $file = null ]) : mixed
Parameters
- $file : mixed = null
Return values
mixed —parseClass()
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".
private
parseClass() : array<string|int, mixed>