Documentation

AutoScalingClient extends AwsClient
in package

Auto Scaling client.

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
attachInstances()  :
attachInstancesAsync()  :
attachLoadBalancers()  :
attachLoadBalancersAsync()  :
attachLoadBalancerTargetGroups()  :
attachLoadBalancerTargetGroupsAsync()  :
batchDeleteScheduledAction()  :
batchDeleteScheduledActionAsync()  :
batchPutScheduledUpdateGroupAction()  :
batchPutScheduledUpdateGroupActionAsync()  :
cancelInstanceRefresh()  :
cancelInstanceRefreshAsync()  :
completeLifecycleAction()  :
completeLifecycleActionAsync()  :
createAutoScalingGroup()  :
createAutoScalingGroupAsync()  :
createLaunchConfiguration()  :
createLaunchConfigurationAsync()  :
createOrUpdateTags()  :
createOrUpdateTagsAsync()  :
deleteAutoScalingGroup()  :
deleteAutoScalingGroupAsync()  :
deleteLaunchConfiguration()  :
deleteLaunchConfigurationAsync()  :
deleteLifecycleHook()  :
deleteLifecycleHookAsync()  :
deleteNotificationConfiguration()  :
deleteNotificationConfigurationAsync()  :
deletePolicy()  :
deletePolicyAsync()  :
deleteScheduledAction()  :
deleteScheduledActionAsync()  :
deleteTags()  :
deleteTagsAsync()  :
describeAccountLimits()  :
describeAccountLimitsAsync()  :
describeAdjustmentTypes()  :
describeAdjustmentTypesAsync()  :
describeAutoScalingGroups()  :
describeAutoScalingGroupsAsync()  :
describeAutoScalingInstances()  :
describeAutoScalingInstancesAsync()  :
describeAutoScalingNotificationTypes()  :
describeAutoScalingNotificationTypesAsync()  :
describeInstanceRefreshes()  :
describeInstanceRefreshesAsync()  :
describeLaunchConfigurations()  :
describeLaunchConfigurationsAsync()  :
describeLifecycleHooks()  :
describeLifecycleHooksAsync()  :
describeLifecycleHookTypes()  :
describeLifecycleHookTypesAsync()  :
describeLoadBalancers()  :
describeLoadBalancersAsync()  :
describeLoadBalancerTargetGroups()  :
describeLoadBalancerTargetGroupsAsync()  :
describeMetricCollectionTypes()  :
describeMetricCollectionTypesAsync()  :
describeNotificationConfigurations()  :
describeNotificationConfigurationsAsync()  :
describePolicies()  :
describePoliciesAsync()  :
describeScalingActivities()  :
describeScalingActivitiesAsync()  :
describeScalingProcessTypes()  :
describeScalingProcessTypesAsync()  :
describeScheduledActions()  :
describeScheduledActionsAsync()  :
describeTags()  :
describeTagsAsync()  :
describeTerminationPolicyTypes()  :
describeTerminationPolicyTypesAsync()  :
detachInstances()  :
detachInstancesAsync()  :
detachLoadBalancers()  :
detachLoadBalancersAsync()  :
detachLoadBalancerTargetGroups()  :
detachLoadBalancerTargetGroupsAsync()  :
disableMetricsCollection()  :
disableMetricsCollectionAsync()  :
enableMetricsCollection()  :
enableMetricsCollectionAsync()  :
enterStandby()  :
enterStandbyAsync()  :
execute()  : mixed
executeAsync()  : mixed
executePolicy()  :
executePolicyAsync()  :
exitStandby()  :
exitStandbyAsync()  :
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
putLifecycleHook()  :
putLifecycleHookAsync()  :
putNotificationConfiguration()  :
putNotificationConfigurationAsync()  :
putScalingPolicy()  :
putScalingPolicyAsync()  :
putScheduledUpdateGroupAction()  :
putScheduledUpdateGroupActionAsync()  :
recordLifecycleActionHeartbeat()  :
recordLifecycleActionHeartbeatAsync()  :
resumeProcesses()  :
resumeProcessesAsync()  :
setDesiredCapacity()  :
setDesiredCapacityAsync()  :
setInstanceHealth()  :
setInstanceHealthAsync()  :
setInstanceProtection()  :
setInstanceProtectionAsync()  :
startInstanceRefresh()  :
startInstanceRefreshAsync()  :
suspendProcesses()  :
suspendProcessesAsync()  :
terminateInstanceInAutoScalingGroup()  :
terminateInstanceInAutoScalingGroupAsync()  :
updateAutoScalingGroup()  :
updateAutoScalingGroupAsync()  :
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

$config

private array<string|int, mixed> $config

$credentialProvider

private callable $credentialProvider

$defaultRequestOptions

private array<string|int, mixed> $defaultRequestOptions

$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, 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.
  • 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
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

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

Return values
mixed —

__sleep()

public __sleep() : mixed
Return values
mixed —

attachInstances()

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

attachInstancesAsync()

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

attachLoadBalancers()

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

attachLoadBalancersAsync()

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

attachLoadBalancerTargetGroups()

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

attachLoadBalancerTargetGroupsAsync()

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

batchDeleteScheduledAction()

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

batchDeleteScheduledActionAsync()

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

batchPutScheduledUpdateGroupAction()

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

batchPutScheduledUpdateGroupActionAsync()

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

cancelInstanceRefresh()

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

cancelInstanceRefreshAsync()

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

completeLifecycleAction()

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

completeLifecycleActionAsync()

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

createAutoScalingGroup()

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

createAutoScalingGroupAsync()

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

createLaunchConfiguration()

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

createLaunchConfigurationAsync()

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

createOrUpdateTags()

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

createOrUpdateTagsAsync()

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

deleteAutoScalingGroup()

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

deleteAutoScalingGroupAsync()

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

deleteLaunchConfiguration()

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

deleteLaunchConfigurationAsync()

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

deleteLifecycleHook()

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

deleteLifecycleHookAsync()

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

deleteNotificationConfiguration()

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

deleteNotificationConfigurationAsync()

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

deletePolicy()

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

deletePolicyAsync()

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

deleteScheduledAction()

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

deleteScheduledActionAsync()

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

deleteTags()

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

deleteTagsAsync()

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

describeAccountLimits()

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

describeAccountLimitsAsync()

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

describeAdjustmentTypes()

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

describeAdjustmentTypesAsync()

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

describeAutoScalingGroups()

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

describeAutoScalingGroupsAsync()

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

describeAutoScalingInstances()

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

describeAutoScalingInstancesAsync()

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

describeAutoScalingNotificationTypes()

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

describeAutoScalingNotificationTypesAsync()

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

describeInstanceRefreshes()

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

describeInstanceRefreshesAsync()

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

describeLaunchConfigurations()

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

describeLaunchConfigurationsAsync()

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

describeLifecycleHooks()

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

describeLifecycleHooksAsync()

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

describeLifecycleHookTypes()

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

describeLifecycleHookTypesAsync()

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

describeLoadBalancers()

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

describeLoadBalancersAsync()

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

describeLoadBalancerTargetGroups()

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

describeLoadBalancerTargetGroupsAsync()

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

describeMetricCollectionTypes()

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

describeMetricCollectionTypesAsync()

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

describeNotificationConfigurations()

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

describeNotificationConfigurationsAsync()

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

describePolicies()

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

describePoliciesAsync()

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

describeScalingActivities()

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

describeScalingActivitiesAsync()

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

describeScalingProcessTypes()

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

describeScalingProcessTypesAsync()

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

describeScheduledActions()

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

describeScheduledActionsAsync()

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

describeTags()

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

describeTagsAsync()

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

describeTerminationPolicyTypes()

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

describeTerminationPolicyTypesAsync()

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

detachInstances()

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

detachInstancesAsync()

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

detachLoadBalancers()

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

detachLoadBalancersAsync()

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

detachLoadBalancerTargetGroups()

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

detachLoadBalancerTargetGroupsAsync()

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

disableMetricsCollection()

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

disableMetricsCollectionAsync()

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

enableMetricsCollection()

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

enableMetricsCollectionAsync()

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

enterStandby()

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

enterStandbyAsync()

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

executePolicy()

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

executePolicyAsync()

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

exitStandby()

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

exitStandbyAsync()

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

factory()

public static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
$config : array<string|int, mixed> = []
Tags
deprecated
Return values
static —

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> —

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.

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 —

putLifecycleHook()

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

putLifecycleHookAsync()

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

putNotificationConfiguration()

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

putNotificationConfigurationAsync()

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

putScalingPolicy()

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

putScalingPolicyAsync()

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

putScheduledUpdateGroupAction()

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

putScheduledUpdateGroupActionAsync()

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

recordLifecycleActionHeartbeat()

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

recordLifecycleActionHeartbeatAsync()

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

resumeProcesses()

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

resumeProcessesAsync()

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

setDesiredCapacity()

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

setDesiredCapacityAsync()

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

setInstanceHealth()

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

setInstanceHealthAsync()

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

setInstanceProtection()

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

setInstanceProtectionAsync()

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

startInstanceRefresh()

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

startInstanceRefreshAsync()

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

suspendProcesses()

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

suspendProcessesAsync()

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

terminateInstanceInAutoScalingGroup()

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

terminateInstanceInAutoScalingGroupAsync()

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

updateAutoScalingGroup()

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

updateAutoScalingGroupAsync()

public updateAutoScalingGroupAsync(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>
Return values
array<string|int, mixed> —

Search results