SDK for PHP 3.x

AutoScalingClient extends AwsClient
in package

Auto Scaling client.

Table of Contents

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
attachInstances()  : Result
attachInstancesAsync()  : Promise
attachLoadBalancers()  : Result
attachLoadBalancersAsync()  : Promise
attachLoadBalancerTargetGroups()  : Result
attachLoadBalancerTargetGroupsAsync()  : Promise
attachTrafficSources()  : Result
attachTrafficSourcesAsync()  : Promise
batchDeleteScheduledAction()  : Result
batchDeleteScheduledActionAsync()  : Promise
batchPutScheduledUpdateGroupAction()  : Result
batchPutScheduledUpdateGroupActionAsync()  : Promise
cancelInstanceRefresh()  : Result
cancelInstanceRefreshAsync()  : Promise
completeLifecycleAction()  : Result
completeLifecycleActionAsync()  : Promise
createAutoScalingGroup()  : Result
createAutoScalingGroupAsync()  : Promise
createLaunchConfiguration()  : Result
createLaunchConfigurationAsync()  : Promise
createOrUpdateTags()  : Result
createOrUpdateTagsAsync()  : Promise
deleteAutoScalingGroup()  : Result
deleteAutoScalingGroupAsync()  : Promise
deleteLaunchConfiguration()  : Result
deleteLaunchConfigurationAsync()  : Promise
deleteLifecycleHook()  : Result
deleteLifecycleHookAsync()  : Promise
deleteNotificationConfiguration()  : Result
deleteNotificationConfigurationAsync()  : Promise
deletePolicy()  : Result
deletePolicyAsync()  : Promise
deleteScheduledAction()  : Result
deleteScheduledActionAsync()  : Promise
deleteTags()  : Result
deleteTagsAsync()  : Promise
deleteWarmPool()  : Result
deleteWarmPoolAsync()  : Promise
describeAccountLimits()  : Result
describeAccountLimitsAsync()  : Promise
describeAdjustmentTypes()  : Result
describeAdjustmentTypesAsync()  : Promise
describeAutoScalingGroups()  : Result
describeAutoScalingGroupsAsync()  : Promise
describeAutoScalingInstances()  : Result
describeAutoScalingInstancesAsync()  : Promise
describeAutoScalingNotificationTypes()  : Result
describeAutoScalingNotificationTypesAsync()  : Promise
describeInstanceRefreshes()  : Result
describeInstanceRefreshesAsync()  : Promise
describeLaunchConfigurations()  : Result
describeLaunchConfigurationsAsync()  : Promise
describeLifecycleHooks()  : Result
describeLifecycleHooksAsync()  : Promise
describeLifecycleHookTypes()  : Result
describeLifecycleHookTypesAsync()  : Promise
describeLoadBalancers()  : Result
describeLoadBalancersAsync()  : Promise
describeLoadBalancerTargetGroups()  : Result
describeLoadBalancerTargetGroupsAsync()  : Promise
describeMetricCollectionTypes()  : Result
describeMetricCollectionTypesAsync()  : Promise
describeNotificationConfigurations()  : Result
describeNotificationConfigurationsAsync()  : Promise
describePolicies()  : Result
describePoliciesAsync()  : Promise
describeScalingActivities()  : Result
describeScalingActivitiesAsync()  : Promise
describeScalingProcessTypes()  : Result
describeScalingProcessTypesAsync()  : Promise
describeScheduledActions()  : Result
describeScheduledActionsAsync()  : Promise
describeTags()  : Result
describeTagsAsync()  : Promise
describeTerminationPolicyTypes()  : Result
describeTerminationPolicyTypesAsync()  : Promise
describeTrafficSources()  : Result
describeTrafficSourcesAsync()  : Promise
describeWarmPool()  : Result
describeWarmPoolAsync()  : Promise
detachInstances()  : Result
detachInstancesAsync()  : Promise
detachLoadBalancers()  : Result
detachLoadBalancersAsync()  : Promise
detachLoadBalancerTargetGroups()  : Result
detachLoadBalancerTargetGroupsAsync()  : Promise
detachTrafficSources()  : Result
detachTrafficSourcesAsync()  : Promise
disableMetricsCollection()  : Result
disableMetricsCollectionAsync()  : Promise
emitDeprecationWarning()  : mixed
enableMetricsCollection()  : Result
enableMetricsCollectionAsync()  : Promise
enterStandby()  : Result
enterStandbyAsync()  : Promise
execute()  : mixed
executeAsync()  : mixed
executePolicy()  : Result
executePolicyAsync()  : Promise
exitStandby()  : Result
exitStandbyAsync()  : Promise
factory()  : static
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getClientBuiltIns()  : array<string|int, mixed>
Provides the set of built-in keys and values used for endpoint resolution
getClientContextParams()  : array<string|int, mixed>
Provides the set of service context parameter key-value pairs used for endpoint resolution.
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.
getEndpointProvider()  : mixed
getEndpointProviderArgs()  : array<string|int, mixed>
Retrieves arguments to be used in endpoint resolution.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIterator()  : mixed
getPaginator()  : mixed
getPredictiveScalingForecast()  : Result
getPredictiveScalingForecastAsync()  : Promise
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()  : Result
putLifecycleHookAsync()  : Promise
putNotificationConfiguration()  : Result
putNotificationConfigurationAsync()  : Promise
putScalingPolicy()  : Result
putScalingPolicyAsync()  : Promise
putScheduledUpdateGroupAction()  : Result
putScheduledUpdateGroupActionAsync()  : Promise
putWarmPool()  : Result
putWarmPoolAsync()  : Promise
recordLifecycleActionHeartbeat()  : Result
recordLifecycleActionHeartbeatAsync()  : Promise
resumeProcesses()  : Result
resumeProcessesAsync()  : Promise
rollbackInstanceRefresh()  : Result
rollbackInstanceRefreshAsync()  : Promise
setDesiredCapacity()  : Result
setDesiredCapacityAsync()  : Promise
setInstanceHealth()  : Result
setInstanceHealthAsync()  : Promise
setInstanceProtection()  : Result
setInstanceProtectionAsync()  : Promise
startInstanceRefresh()  : Result
startInstanceRefreshAsync()  : Promise
suspendProcesses()  : Result
suspendProcessesAsync()  : Promise
terminateInstanceInAutoScalingGroup()  : Result
terminateInstanceInAutoScalingGroupAsync()  : Promise
updateAutoScalingGroup()  : Result
updateAutoScalingGroupAsync()  : Promise
waitUntil()  : mixed

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, 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.
  • 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).
  • ua_append: (string, array) To pass custom user agent parameters.
  • app_id: (string) an optional application specific identifier that can be set. When set it will be appended to the User-Agent header of every request in the form of App/{AppId}. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. See https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html for more information on environment variables and shared config settings.
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

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

__sleep()

public __sleep() : mixed

attachInstances()

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

attachInstancesAsync()

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

attachLoadBalancers()

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

attachLoadBalancersAsync()

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

attachLoadBalancerTargetGroups()

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

attachLoadBalancerTargetGroupsAsync()

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

attachTrafficSources()

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

attachTrafficSourcesAsync()

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

batchDeleteScheduledAction()

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

batchDeleteScheduledActionAsync()

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

batchPutScheduledUpdateGroupAction()

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

batchPutScheduledUpdateGroupActionAsync()

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

cancelInstanceRefresh()

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

cancelInstanceRefreshAsync()

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

completeLifecycleAction()

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

completeLifecycleActionAsync()

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

createAutoScalingGroup()

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

createAutoScalingGroupAsync()

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

createLaunchConfiguration()

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

createLaunchConfigurationAsync()

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

createOrUpdateTags()

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

createOrUpdateTagsAsync()

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

deleteAutoScalingGroup()

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

deleteAutoScalingGroupAsync()

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

deleteLaunchConfiguration()

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

deleteLaunchConfigurationAsync()

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

deleteLifecycleHook()

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

deleteLifecycleHookAsync()

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

deleteNotificationConfiguration()

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

deleteNotificationConfigurationAsync()

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

deletePolicy()

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

deletePolicyAsync()

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

deleteScheduledAction()

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

deleteScheduledActionAsync()

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

deleteTags()

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

deleteTagsAsync()

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

deleteWarmPool()

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

deleteWarmPoolAsync()

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

describeAccountLimits()

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

describeAccountLimitsAsync()

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

describeAdjustmentTypes()

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

describeAdjustmentTypesAsync()

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

describeAutoScalingGroups()

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

describeAutoScalingGroupsAsync()

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

describeAutoScalingInstances()

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

describeAutoScalingInstancesAsync()

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

describeAutoScalingNotificationTypes()

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

describeAutoScalingNotificationTypesAsync()

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

describeInstanceRefreshes()

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

describeInstanceRefreshesAsync()

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

describeLaunchConfigurations()

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

describeLaunchConfigurationsAsync()

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

describeLifecycleHooks()

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

describeLifecycleHooksAsync()

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

describeLifecycleHookTypes()

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

describeLifecycleHookTypesAsync()

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

describeLoadBalancers()

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

describeLoadBalancersAsync()

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

describeLoadBalancerTargetGroups()

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

describeLoadBalancerTargetGroupsAsync()

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

describeMetricCollectionTypes()

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

describeMetricCollectionTypesAsync()

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

describeNotificationConfigurations()

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

describeNotificationConfigurationsAsync()

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

describePolicies()

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

describePoliciesAsync()

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

describeScalingActivities()

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

describeScalingActivitiesAsync()

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

describeScalingProcessTypes()

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

describeScalingProcessTypesAsync()

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

describeScheduledActions()

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

describeScheduledActionsAsync()

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

describeTags()

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

describeTagsAsync()

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

describeTerminationPolicyTypes()

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

describeTerminationPolicyTypesAsync()

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

describeTrafficSources()

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

describeTrafficSourcesAsync()

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

describeWarmPool()

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

describeWarmPoolAsync()

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

detachInstances()

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

detachInstancesAsync()

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

detachLoadBalancers()

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

detachLoadBalancersAsync()

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

detachLoadBalancerTargetGroups()

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

detachLoadBalancerTargetGroupsAsync()

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

detachTrafficSources()

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

detachTrafficSourcesAsync()

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

disableMetricsCollection()

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

disableMetricsCollectionAsync()

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

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

enableMetricsCollection()

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

enableMetricsCollectionAsync()

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

enterStandby()

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

enterStandbyAsync()

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

executePolicy()

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

executePolicyAsync()

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

exitStandby()

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

exitStandbyAsync()

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

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>

getClientBuiltIns()

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

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

getClientContextParams()

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

public getClientContextParams() : 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

getEndpointProvider()

public getEndpointProvider() : mixed

getEndpointProviderArgs()

Retrieves arguments to be used in endpoint resolution.

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

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> = []

getPaginator()

public getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []

getPredictiveScalingForecast()

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

getPredictiveScalingForecastAsync()

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

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> = []

putLifecycleHook()

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

putLifecycleHookAsync()

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

putNotificationConfiguration()

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

putNotificationConfigurationAsync()

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

putScalingPolicy()

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

putScalingPolicyAsync()

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

putScheduledUpdateGroupAction()

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

putScheduledUpdateGroupActionAsync()

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

putWarmPool()

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

putWarmPoolAsync()

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

recordLifecycleActionHeartbeat()

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

recordLifecycleActionHeartbeatAsync()

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

resumeProcesses()

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

resumeProcessesAsync()

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

rollbackInstanceRefresh()

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

rollbackInstanceRefreshAsync()

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

setDesiredCapacity()

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

setDesiredCapacityAsync()

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

setInstanceHealth()

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

setInstanceHealthAsync()

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

setInstanceProtection()

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

setInstanceProtectionAsync()

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

startInstanceRefresh()

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

startInstanceRefreshAsync()

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

suspendProcesses()

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

suspendProcessesAsync()

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

terminateInstanceInAutoScalingGroup()

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

terminateInstanceInAutoScalingGroupAsync()

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

updateAutoScalingGroup()

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

updateAutoScalingGroupAsync()

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

waitUntil()

public waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed> = []
On this page