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
__sleep()
public
__sleep() : mixed
attachInstances()
public
attachInstances(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultattachInstancesAsync()
public
attachInstancesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseattachLoadBalancers()
public
attachLoadBalancers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultattachLoadBalancersAsync()
public
attachLoadBalancersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseattachLoadBalancerTargetGroups()
public
attachLoadBalancerTargetGroups(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultattachLoadBalancerTargetGroupsAsync()
public
attachLoadBalancerTargetGroupsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseattachTrafficSources()
public
attachTrafficSources(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultattachTrafficSourcesAsync()
public
attachTrafficSourcesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisebatchDeleteScheduledAction()
public
batchDeleteScheduledAction(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchDeleteScheduledActionAsync()
public
batchDeleteScheduledActionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisebatchPutScheduledUpdateGroupAction()
public
batchPutScheduledUpdateGroupAction(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultbatchPutScheduledUpdateGroupActionAsync()
public
batchPutScheduledUpdateGroupActionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecancelInstanceRefresh()
public
cancelInstanceRefresh(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcancelInstanceRefreshAsync()
public
cancelInstanceRefreshAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecompleteLifecycleAction()
public
completeLifecycleAction(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcompleteLifecycleActionAsync()
public
completeLifecycleActionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateAutoScalingGroup()
public
createAutoScalingGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateAutoScalingGroupAsync()
public
createAutoScalingGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateLaunchConfiguration()
public
createLaunchConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateLaunchConfigurationAsync()
public
createLaunchConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateOrUpdateTags()
public
createOrUpdateTags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateOrUpdateTagsAsync()
public
createOrUpdateTagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteAutoScalingGroup()
public
deleteAutoScalingGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteAutoScalingGroupAsync()
public
deleteAutoScalingGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteLaunchConfiguration()
public
deleteLaunchConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteLaunchConfigurationAsync()
public
deleteLaunchConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteLifecycleHook()
public
deleteLifecycleHook(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteLifecycleHookAsync()
public
deleteLifecycleHookAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteNotificationConfiguration()
public
deleteNotificationConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteNotificationConfigurationAsync()
public
deleteNotificationConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeletePolicy()
public
deletePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeletePolicyAsync()
public
deletePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteScheduledAction()
public
deleteScheduledAction(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteScheduledActionAsync()
public
deleteScheduledActionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteTags()
public
deleteTags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteTagsAsync()
public
deleteTagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteWarmPool()
public
deleteWarmPool(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteWarmPoolAsync()
public
deleteWarmPoolAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeAccountLimits()
public
describeAccountLimits(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeAccountLimitsAsync()
public
describeAccountLimitsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeAdjustmentTypes()
public
describeAdjustmentTypes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeAdjustmentTypesAsync()
public
describeAdjustmentTypesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeAutoScalingGroups()
public
describeAutoScalingGroups(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeAutoScalingGroupsAsync()
public
describeAutoScalingGroupsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeAutoScalingInstances()
public
describeAutoScalingInstances(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeAutoScalingInstancesAsync()
public
describeAutoScalingInstancesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeAutoScalingNotificationTypes()
public
describeAutoScalingNotificationTypes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeAutoScalingNotificationTypesAsync()
public
describeAutoScalingNotificationTypesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeInstanceRefreshes()
public
describeInstanceRefreshes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeInstanceRefreshesAsync()
public
describeInstanceRefreshesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeLaunchConfigurations()
public
describeLaunchConfigurations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeLaunchConfigurationsAsync()
public
describeLaunchConfigurationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeLifecycleHooks()
public
describeLifecycleHooks(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeLifecycleHooksAsync()
public
describeLifecycleHooksAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeLifecycleHookTypes()
public
describeLifecycleHookTypes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeLifecycleHookTypesAsync()
public
describeLifecycleHookTypesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeLoadBalancers()
public
describeLoadBalancers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeLoadBalancersAsync()
public
describeLoadBalancersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeLoadBalancerTargetGroups()
public
describeLoadBalancerTargetGroups(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeLoadBalancerTargetGroupsAsync()
public
describeLoadBalancerTargetGroupsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeMetricCollectionTypes()
public
describeMetricCollectionTypes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeMetricCollectionTypesAsync()
public
describeMetricCollectionTypesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeNotificationConfigurations()
public
describeNotificationConfigurations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeNotificationConfigurationsAsync()
public
describeNotificationConfigurationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribePolicies()
public
describePolicies(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribePoliciesAsync()
public
describePoliciesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeScalingActivities()
public
describeScalingActivities(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeScalingActivitiesAsync()
public
describeScalingActivitiesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeScalingProcessTypes()
public
describeScalingProcessTypes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeScalingProcessTypesAsync()
public
describeScalingProcessTypesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeScheduledActions()
public
describeScheduledActions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeScheduledActionsAsync()
public
describeScheduledActionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeTags()
public
describeTags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeTagsAsync()
public
describeTagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeTerminationPolicyTypes()
public
describeTerminationPolicyTypes(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeTerminationPolicyTypesAsync()
public
describeTerminationPolicyTypesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeTrafficSources()
public
describeTrafficSources(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeTrafficSourcesAsync()
public
describeTrafficSourcesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeWarmPool()
public
describeWarmPool(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeWarmPoolAsync()
public
describeWarmPoolAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedetachInstances()
public
detachInstances(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdetachInstancesAsync()
public
detachInstancesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedetachLoadBalancers()
public
detachLoadBalancers(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdetachLoadBalancersAsync()
public
detachLoadBalancersAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedetachLoadBalancerTargetGroups()
public
detachLoadBalancerTargetGroups(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdetachLoadBalancerTargetGroupsAsync()
public
detachLoadBalancerTargetGroupsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedetachTrafficSources()
public
detachTrafficSources(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdetachTrafficSourcesAsync()
public
detachTrafficSourcesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedisableMetricsCollection()
public
disableMetricsCollection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdisableMetricsCollectionAsync()
public
disableMetricsCollectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseemitDeprecationWarning()
public
static emitDeprecationWarning() : mixed
enableMetricsCollection()
public
enableMetricsCollection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultenableMetricsCollectionAsync()
public
enableMetricsCollectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseenterStandby()
public
enterStandby(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultenterStandbyAsync()
public
enterStandbyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
Promiseexecute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
executePolicy()
public
executePolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultexecutePolicyAsync()
public
executePolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseexitStandby()
public
exitStandby(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultexitStandbyAsync()
public
exitStandbyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
Promisefactory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
staticgetApi()
public
abstract getApi() : Service
Return values
ServicegetArguments()
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
CommandInterfacegetConfig()
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|nullgetCredentials()
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
PromiseInterfacegetEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterfacegetEndpointProvider()
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
HandlerListgetIterator()
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
ResultgetPredictiveScalingForecastAsync()
public
getPredictiveScalingForecastAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
stringgetSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callablegetWaiter()
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
ResultputLifecycleHookAsync()
public
putLifecycleHookAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputNotificationConfiguration()
public
putNotificationConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputNotificationConfigurationAsync()
public
putNotificationConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputScalingPolicy()
public
putScalingPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputScalingPolicyAsync()
public
putScalingPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputScheduledUpdateGroupAction()
public
putScheduledUpdateGroupAction(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputScheduledUpdateGroupActionAsync()
public
putScheduledUpdateGroupActionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputWarmPool()
public
putWarmPool(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputWarmPoolAsync()
public
putWarmPoolAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiserecordLifecycleActionHeartbeat()
public
recordLifecycleActionHeartbeat(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultrecordLifecycleActionHeartbeatAsync()
public
recordLifecycleActionHeartbeatAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseresumeProcesses()
public
resumeProcesses(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultresumeProcessesAsync()
public
resumeProcessesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiserollbackInstanceRefresh()
public
rollbackInstanceRefresh(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultrollbackInstanceRefreshAsync()
public
rollbackInstanceRefreshAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetDesiredCapacity()
public
setDesiredCapacity(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetDesiredCapacityAsync()
public
setDesiredCapacityAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetInstanceHealth()
public
setInstanceHealth(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetInstanceHealthAsync()
public
setInstanceHealthAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesetInstanceProtection()
public
setInstanceProtection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsetInstanceProtectionAsync()
public
setInstanceProtectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestartInstanceRefresh()
public
startInstanceRefresh(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstartInstanceRefreshAsync()
public
startInstanceRefreshAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisesuspendProcesses()
public
suspendProcesses(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultsuspendProcessesAsync()
public
suspendProcessesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseterminateInstanceInAutoScalingGroup()
public
terminateInstanceInAutoScalingGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultterminateInstanceInAutoScalingGroupAsync()
public
terminateInstanceInAutoScalingGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateAutoScalingGroup()
public
updateAutoScalingGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateAutoScalingGroupAsync()
public
updateAutoScalingGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisewaitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []