Documentation

WafClient extends AwsClient
in package

This client is used to interact with the **AWS WAF** service.

Table of Contents

$aliases  : array<string|int, mixed>
$api  : Service
$config  : array<string|int, mixed>
$credentialProvider  : callable
$defaultRequestOptions  : array<string|int, mixed>
$endpoint  : string
$handlerList  : HandlerList
$region  : string
$signatureProvider  : callable
__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
createByteMatchSet()  :
createByteMatchSetAsync()  :
createGeoMatchSet()  :
createGeoMatchSetAsync()  :
createIPSet()  :
createIPSetAsync()  :
createRateBasedRule()  :
createRateBasedRuleAsync()  :
createRegexMatchSet()  :
createRegexMatchSetAsync()  :
createRegexPatternSet()  :
createRegexPatternSetAsync()  :
createRule()  :
createRuleAsync()  :
createRuleGroup()  :
createRuleGroupAsync()  :
createSizeConstraintSet()  :
createSizeConstraintSetAsync()  :
createSqlInjectionMatchSet()  :
createSqlInjectionMatchSetAsync()  :
createWebACL()  :
createWebACLAsync()  :
createWebACLMigrationStack()  :
createWebACLMigrationStackAsync()  :
createXssMatchSet()  :
createXssMatchSetAsync()  :
deleteByteMatchSet()  :
deleteByteMatchSetAsync()  :
deleteGeoMatchSet()  :
deleteGeoMatchSetAsync()  :
deleteIPSet()  :
deleteIPSetAsync()  :
deleteLoggingConfiguration()  :
deleteLoggingConfigurationAsync()  :
deletePermissionPolicy()  :
deletePermissionPolicyAsync()  :
deleteRateBasedRule()  :
deleteRateBasedRuleAsync()  :
deleteRegexMatchSet()  :
deleteRegexMatchSetAsync()  :
deleteRegexPatternSet()  :
deleteRegexPatternSetAsync()  :
deleteRule()  :
deleteRuleAsync()  :
deleteRuleGroup()  :
deleteRuleGroupAsync()  :
deleteSizeConstraintSet()  :
deleteSizeConstraintSetAsync()  :
deleteSqlInjectionMatchSet()  :
deleteSqlInjectionMatchSetAsync()  :
deleteWebACL()  :
deleteWebACLAsync()  :
deleteXssMatchSet()  :
deleteXssMatchSetAsync()  :
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getByteMatchSet()  :
getByteMatchSetAsync()  :
getChangeToken()  :
getChangeTokenAsync()  :
getChangeTokenStatus()  :
getChangeTokenStatusAsync()  :
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.
getGeoMatchSet()  :
getGeoMatchSetAsync()  :
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIPSet()  :
getIPSetAsync()  :
getIterator()  : mixed
getLoggingConfiguration()  :
getLoggingConfigurationAsync()  :
getPaginator()  : mixed
getPermissionPolicy()  :
getPermissionPolicyAsync()  :
getRateBasedRule()  :
getRateBasedRuleAsync()  :
getRateBasedRuleManagedKeys()  :
getRateBasedRuleManagedKeysAsync()  :
getRegexMatchSet()  :
getRegexMatchSetAsync()  :
getRegexPatternSet()  :
getRegexPatternSetAsync()  :
getRegion()  : string
Get the region to which the client is configured to send requests.
getRule()  :
getRuleAsync()  :
getRuleGroup()  :
getRuleGroupAsync()  :
getSampledRequests()  :
getSampledRequestsAsync()  :
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getSizeConstraintSet()  :
getSizeConstraintSetAsync()  :
getSqlInjectionMatchSet()  :
getSqlInjectionMatchSetAsync()  :
getWaiter()  : mixed
getWebACL()  :
getWebACLAsync()  :
getXssMatchSet()  :
getXssMatchSetAsync()  :
listActivatedRulesInRuleGroup()  :
listActivatedRulesInRuleGroupAsync()  :
listByteMatchSets()  :
listByteMatchSetsAsync()  :
listGeoMatchSets()  :
listGeoMatchSetsAsync()  :
listIPSets()  :
listIPSetsAsync()  :
listLoggingConfigurations()  :
listLoggingConfigurationsAsync()  :
listRateBasedRules()  :
listRateBasedRulesAsync()  :
listRegexMatchSets()  :
listRegexMatchSetsAsync()  :
listRegexPatternSets()  :
listRegexPatternSetsAsync()  :
listRuleGroups()  :
listRuleGroupsAsync()  :
listRules()  :
listRulesAsync()  :
listSizeConstraintSets()  :
listSizeConstraintSetsAsync()  :
listSqlInjectionMatchSets()  :
listSqlInjectionMatchSetsAsync()  :
listSubscribedRuleGroups()  :
listSubscribedRuleGroupsAsync()  :
listTagsForResource()  :
listTagsForResourceAsync()  :
listWebACLs()  :
listWebACLsAsync()  :
listXssMatchSets()  :
listXssMatchSetsAsync()  :
putLoggingConfiguration()  :
putLoggingConfigurationAsync()  :
putPermissionPolicy()  :
putPermissionPolicyAsync()  :
tagResource()  :
tagResourceAsync()  :
untagResource()  :
untagResourceAsync()  :
updateByteMatchSet()  :
updateByteMatchSetAsync()  :
updateGeoMatchSet()  :
updateGeoMatchSetAsync()  :
updateIPSet()  :
updateIPSetAsync()  :
updateRateBasedRule()  :
updateRateBasedRuleAsync()  :
updateRegexMatchSet()  :
updateRegexMatchSetAsync()  :
updateRegexPatternSet()  :
updateRegexPatternSetAsync()  :
updateRule()  :
updateRuleAsync()  :
updateRuleGroup()  :
updateRuleGroupAsync()  :
updateSizeConstraintSet()  :
updateSizeConstraintSetAsync()  :
updateSqlInjectionMatchSet()  :
updateSqlInjectionMatchSetAsync()  :
updateWebACL()  :
updateWebACLAsync()  :
updateXssMatchSet()  :
updateXssMatchSetAsync()  :
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 —

createByteMatchSet()

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

createByteMatchSetAsync()

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

createGeoMatchSet()

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

createGeoMatchSetAsync()

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

createIPSet()

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

createIPSetAsync()

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

createRateBasedRule()

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

createRateBasedRuleAsync()

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

createRegexMatchSet()

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

createRegexMatchSetAsync()

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

createRegexPatternSet()

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

createRegexPatternSetAsync()

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

createRule()

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

createRuleAsync()

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

createRuleGroup()

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

createRuleGroupAsync()

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

createSizeConstraintSet()

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

createSizeConstraintSetAsync()

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

createSqlInjectionMatchSet()

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

createSqlInjectionMatchSetAsync()

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

createWebACL()

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

createWebACLAsync()

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

createWebACLMigrationStack()

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

createWebACLMigrationStackAsync()

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

createXssMatchSet()

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

createXssMatchSetAsync()

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

deleteByteMatchSet()

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

deleteByteMatchSetAsync()

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

deleteGeoMatchSet()

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

deleteGeoMatchSetAsync()

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

deleteIPSet()

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

deleteIPSetAsync()

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

deleteLoggingConfiguration()

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

deleteLoggingConfigurationAsync()

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

deletePermissionPolicy()

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

deletePermissionPolicyAsync()

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

deleteRateBasedRule()

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

deleteRateBasedRuleAsync()

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

deleteRegexMatchSet()

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

deleteRegexMatchSetAsync()

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

deleteRegexPatternSet()

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

deleteRegexPatternSetAsync()

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

deleteRule()

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

deleteRuleAsync()

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

deleteRuleGroup()

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

deleteRuleGroupAsync()

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

deleteSizeConstraintSet()

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

deleteSizeConstraintSetAsync()

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

deleteSqlInjectionMatchSet()

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

deleteSqlInjectionMatchSetAsync()

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

deleteWebACL()

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

deleteWebACLAsync()

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

deleteXssMatchSet()

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

deleteXssMatchSetAsync()

public deleteXssMatchSetAsync(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> —

getByteMatchSet()

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

getByteMatchSetAsync()

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

getChangeToken()

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

getChangeTokenAsync()

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

getChangeTokenStatus()

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

getChangeTokenStatusAsync()

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

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 —

getGeoMatchSet()

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

getGeoMatchSetAsync()

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

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 —

getIPSet()

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

getIPSetAsync()

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

getIterator()

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

getLoggingConfiguration()

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

getLoggingConfigurationAsync()

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

getPaginator()

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

getPermissionPolicy()

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

getPermissionPolicyAsync()

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

getRateBasedRule()

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

getRateBasedRuleAsync()

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

getRateBasedRuleManagedKeys()

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

getRateBasedRuleManagedKeysAsync()

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

getRegexMatchSet()

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

getRegexMatchSetAsync()

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

getRegexPatternSet()

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

getRegexPatternSetAsync()

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

getRegion()

Get the region to which the client is configured to send requests.

public getRegion() : string
Return values
string —

getRule()

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

getRuleAsync()

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

getRuleGroup()

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

getRuleGroupAsync()

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

getSampledRequests()

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

getSampledRequestsAsync()

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

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable —

getSizeConstraintSet()

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

getSizeConstraintSetAsync()

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

getSqlInjectionMatchSet()

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

getSqlInjectionMatchSetAsync()

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

getWaiter()

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

getWebACL()

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

getWebACLAsync()

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

getXssMatchSet()

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

getXssMatchSetAsync()

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

listActivatedRulesInRuleGroup()

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

listActivatedRulesInRuleGroupAsync()

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

listByteMatchSets()

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

listByteMatchSetsAsync()

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

listGeoMatchSets()

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

listGeoMatchSetsAsync()

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

listIPSets()

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

listIPSetsAsync()

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

listLoggingConfigurations()

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

listLoggingConfigurationsAsync()

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

listRateBasedRules()

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

listRateBasedRulesAsync()

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

listRegexMatchSets()

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

listRegexMatchSetsAsync()

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

listRegexPatternSets()

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

listRegexPatternSetsAsync()

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

listRuleGroups()

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

listRuleGroupsAsync()

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

listRules()

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

listRulesAsync()

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

listSizeConstraintSets()

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

listSizeConstraintSetsAsync()

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

listSqlInjectionMatchSets()

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

listSqlInjectionMatchSetsAsync()

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

listSubscribedRuleGroups()

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

listSubscribedRuleGroupsAsync()

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

listTagsForResource()

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

listTagsForResourceAsync()

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

listWebACLs()

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

listWebACLsAsync()

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

listXssMatchSets()

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

listXssMatchSetsAsync()

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

putLoggingConfiguration()

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

putLoggingConfigurationAsync()

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

putPermissionPolicy()

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

putPermissionPolicyAsync()

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

tagResource()

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

tagResourceAsync()

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

untagResource()

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

untagResourceAsync()

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

updateByteMatchSet()

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

updateByteMatchSetAsync()

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

updateGeoMatchSet()

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

updateGeoMatchSetAsync()

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

updateIPSet()

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

updateIPSetAsync()

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

updateRateBasedRule()

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

updateRateBasedRuleAsync()

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

updateRegexMatchSet()

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

updateRegexMatchSetAsync()

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

updateRegexPatternSet()

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

updateRegexPatternSetAsync()

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

updateRule()

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

updateRuleAsync()

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

updateRuleGroup()

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

updateRuleGroupAsync()

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

updateSizeConstraintSet()

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

updateSizeConstraintSetAsync()

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

updateSqlInjectionMatchSet()

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

updateSqlInjectionMatchSetAsync()

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

updateWebACL()

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

updateWebACLAsync()

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

updateXssMatchSet()

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

updateXssMatchSetAsync()

public updateXssMatchSetAsync(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