WafClient
extends AwsClient
in package
This client is used to interact with the AWS WAF service.
Supported API Versions
This class uses a service description model that is associated at
runtime based on the version
option given when constructing the
client. The version
option will determine which API operations,
waiters, and paginators are available for a client. Creating a command or a
specific API operation can be done using magic methods (e.g.,
$client->commandName(/** parameters */)
, or using the
$client->getCommand
method of the client.
- CreateByteMatchSet
- CreateGeoMatchSet
- CreateIPSet
- CreateRateBasedRule
- CreateRegexMatchSet
- CreateRegexPatternSet
- CreateRule
- CreateRuleGroup
- CreateSizeConstraintSet
- CreateSqlInjectionMatchSet
- CreateWebACL
- CreateWebACLMigrationStack
- CreateXssMatchSet
- DeleteByteMatchSet
- DeleteGeoMatchSet
- DeleteIPSet
- DeleteLoggingConfiguration
- DeletePermissionPolicy
- DeleteRateBasedRule
- DeleteRegexMatchSet
- DeleteRegexPatternSet
- DeleteRule
- DeleteRuleGroup
- DeleteSizeConstraintSet
- DeleteSqlInjectionMatchSet
- DeleteWebACL
- DeleteXssMatchSet
- GetByteMatchSet
- GetChangeToken
- GetChangeTokenStatus
- GetGeoMatchSet
- GetIPSet
- GetLoggingConfiguration
- GetPermissionPolicy
- GetRateBasedRule
- GetRateBasedRuleManagedKeys
- GetRegexMatchSet
- GetRegexPatternSet
- GetRule
- GetRuleGroup
- GetSampledRequests
- GetSizeConstraintSet
- GetSqlInjectionMatchSet
- GetWebACL
- GetXssMatchSet
- ListActivatedRulesInRuleGroup
- ListByteMatchSets
- ListGeoMatchSets
- ListIPSets
- ListLoggingConfigurations
- ListRateBasedRules
- ListRegexMatchSets
- ListRegexPatternSets
- ListRuleGroups
- ListRules
- ListSizeConstraintSets
- ListSqlInjectionMatchSets
- ListSubscribedRuleGroups
- ListTagsForResource
- ListWebACLs
- ListXssMatchSets
- PutLoggingConfiguration
- PutPermissionPolicy
- TagResource
- UntagResource
- UpdateByteMatchSet
- UpdateGeoMatchSet
- UpdateIPSet
- UpdateRateBasedRule
- UpdateRegexMatchSet
- UpdateRegexPatternSet
- UpdateRule
- UpdateRuleGroup
- UpdateSizeConstraintSet
- UpdateSqlInjectionMatchSet
- UpdateWebACL
- UpdateXssMatchSet
Table of Contents
Methods
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- createByteMatchSet() : Result
- createByteMatchSetAsync() : Promise
- createGeoMatchSet() : Result
- createGeoMatchSetAsync() : Promise
- createIPSet() : Result
- createIPSetAsync() : Promise
- createRateBasedRule() : Result
- createRateBasedRuleAsync() : Promise
- createRegexMatchSet() : Result
- createRegexMatchSetAsync() : Promise
- createRegexPatternSet() : Result
- createRegexPatternSetAsync() : Promise
- createRule() : Result
- createRuleAsync() : Promise
- createRuleGroup() : Result
- createRuleGroupAsync() : Promise
- createSizeConstraintSet() : Result
- createSizeConstraintSetAsync() : Promise
- createSqlInjectionMatchSet() : Result
- createSqlInjectionMatchSetAsync() : Promise
- createWebACL() : Result
- createWebACLAsync() : Promise
- createWebACLMigrationStack() : Result
- createWebACLMigrationStackAsync() : Promise
- createXssMatchSet() : Result
- createXssMatchSetAsync() : Promise
- deleteByteMatchSet() : Result
- deleteByteMatchSetAsync() : Promise
- deleteGeoMatchSet() : Result
- deleteGeoMatchSetAsync() : Promise
- deleteIPSet() : Result
- deleteIPSetAsync() : Promise
- deleteLoggingConfiguration() : Result
- deleteLoggingConfigurationAsync() : Promise
- deletePermissionPolicy() : Result
- deletePermissionPolicyAsync() : Promise
- deleteRateBasedRule() : Result
- deleteRateBasedRuleAsync() : Promise
- deleteRegexMatchSet() : Result
- deleteRegexMatchSetAsync() : Promise
- deleteRegexPatternSet() : Result
- deleteRegexPatternSetAsync() : Promise
- deleteRule() : Result
- deleteRuleAsync() : Promise
- deleteRuleGroup() : Result
- deleteRuleGroupAsync() : Promise
- deleteSizeConstraintSet() : Result
- deleteSizeConstraintSetAsync() : Promise
- deleteSqlInjectionMatchSet() : Result
- deleteSqlInjectionMatchSetAsync() : Promise
- deleteWebACL() : Result
- deleteWebACLAsync() : Promise
- deleteXssMatchSet() : Result
- deleteXssMatchSetAsync() : Promise
- emitDeprecationWarning() : mixed
- 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() : Result
- getByteMatchSetAsync() : Promise
- getChangeToken() : Result
- getChangeTokenAsync() : Promise
- getChangeTokenStatus() : Result
- getChangeTokenStatusAsync() : Promise
- 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.
- getGeoMatchSet() : Result
- getGeoMatchSetAsync() : Promise
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getIPSet() : Result
- getIPSetAsync() : Promise
- getIterator() : mixed
- getLoggingConfiguration() : Result
- getLoggingConfigurationAsync() : Promise
- getPaginator() : mixed
- getPermissionPolicy() : Result
- getPermissionPolicyAsync() : Promise
- getRateBasedRule() : Result
- getRateBasedRuleAsync() : Promise
- getRateBasedRuleManagedKeys() : Result
- getRateBasedRuleManagedKeysAsync() : Promise
- getRegexMatchSet() : Result
- getRegexMatchSetAsync() : Promise
- getRegexPatternSet() : Result
- getRegexPatternSetAsync() : Promise
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getRule() : Result
- getRuleAsync() : Promise
- getRuleGroup() : Result
- getRuleGroupAsync() : Promise
- getSampledRequests() : Result
- getSampledRequestsAsync() : Promise
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getSizeConstraintSet() : Result
- getSizeConstraintSetAsync() : Promise
- getSqlInjectionMatchSet() : Result
- getSqlInjectionMatchSetAsync() : Promise
- getWaiter() : mixed
- getWebACL() : Result
- getWebACLAsync() : Promise
- getXssMatchSet() : Result
- getXssMatchSetAsync() : Promise
- listActivatedRulesInRuleGroup() : Result
- listActivatedRulesInRuleGroupAsync() : Promise
- listByteMatchSets() : Result
- listByteMatchSetsAsync() : Promise
- listGeoMatchSets() : Result
- listGeoMatchSetsAsync() : Promise
- listIPSets() : Result
- listIPSetsAsync() : Promise
- listLoggingConfigurations() : Result
- listLoggingConfigurationsAsync() : Promise
- listRateBasedRules() : Result
- listRateBasedRulesAsync() : Promise
- listRegexMatchSets() : Result
- listRegexMatchSetsAsync() : Promise
- listRegexPatternSets() : Result
- listRegexPatternSetsAsync() : Promise
- listRuleGroups() : Result
- listRuleGroupsAsync() : Promise
- listRules() : Result
- listRulesAsync() : Promise
- listSizeConstraintSets() : Result
- listSizeConstraintSetsAsync() : Promise
- listSqlInjectionMatchSets() : Result
- listSqlInjectionMatchSetsAsync() : Promise
- listSubscribedRuleGroups() : Result
- listSubscribedRuleGroupsAsync() : Promise
- listTagsForResource() : Result
- listTagsForResourceAsync() : Promise
- listWebACLs() : Result
- listWebACLsAsync() : Promise
- listXssMatchSets() : Result
- listXssMatchSetsAsync() : Promise
- putLoggingConfiguration() : Result
- putLoggingConfigurationAsync() : Promise
- putPermissionPolicy() : Result
- putPermissionPolicyAsync() : Promise
- tagResource() : Result
- tagResourceAsync() : Promise
- untagResource() : Result
- untagResourceAsync() : Promise
- updateByteMatchSet() : Result
- updateByteMatchSetAsync() : Promise
- updateGeoMatchSet() : Result
- updateGeoMatchSetAsync() : Promise
- updateIPSet() : Result
- updateIPSetAsync() : Promise
- updateRateBasedRule() : Result
- updateRateBasedRuleAsync() : Promise
- updateRegexMatchSet() : Result
- updateRegexMatchSetAsync() : Promise
- updateRegexPatternSet() : Result
- updateRegexPatternSetAsync() : Promise
- updateRule() : Result
- updateRuleAsync() : Promise
- updateRuleGroup() : Result
- updateRuleGroupAsync() : Promise
- updateSizeConstraintSet() : Result
- updateSizeConstraintSetAsync() : Promise
- updateSqlInjectionMatchSet() : Result
- updateSqlInjectionMatchSetAsync() : Promise
- updateWebACL() : Result
- updateWebACLAsync() : Promise
- updateXssMatchSet() : Result
- updateXssMatchSetAsync() : 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
createByteMatchSet()
public
createByteMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateByteMatchSetAsync()
public
createByteMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateGeoMatchSet()
public
createGeoMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateGeoMatchSetAsync()
public
createGeoMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateIPSet()
public
createIPSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateIPSetAsync()
public
createIPSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateRateBasedRule()
public
createRateBasedRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateRateBasedRuleAsync()
public
createRateBasedRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateRegexMatchSet()
public
createRegexMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateRegexMatchSetAsync()
public
createRegexMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateRegexPatternSet()
public
createRegexPatternSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateRegexPatternSetAsync()
public
createRegexPatternSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateRule()
public
createRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateRuleAsync()
public
createRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateRuleGroup()
public
createRuleGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateRuleGroupAsync()
public
createRuleGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateSizeConstraintSet()
public
createSizeConstraintSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateSizeConstraintSetAsync()
public
createSizeConstraintSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateSqlInjectionMatchSet()
public
createSqlInjectionMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateSqlInjectionMatchSetAsync()
public
createSqlInjectionMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateWebACL()
public
createWebACL(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateWebACLAsync()
public
createWebACLAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateWebACLMigrationStack()
public
createWebACLMigrationStack(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateWebACLMigrationStackAsync()
public
createWebACLMigrationStackAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateXssMatchSet()
public
createXssMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateXssMatchSetAsync()
public
createXssMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteByteMatchSet()
public
deleteByteMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteByteMatchSetAsync()
public
deleteByteMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteGeoMatchSet()
public
deleteGeoMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteGeoMatchSetAsync()
public
deleteGeoMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteIPSet()
public
deleteIPSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteIPSetAsync()
public
deleteIPSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteLoggingConfiguration()
public
deleteLoggingConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteLoggingConfigurationAsync()
public
deleteLoggingConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeletePermissionPolicy()
public
deletePermissionPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeletePermissionPolicyAsync()
public
deletePermissionPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteRateBasedRule()
public
deleteRateBasedRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteRateBasedRuleAsync()
public
deleteRateBasedRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteRegexMatchSet()
public
deleteRegexMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteRegexMatchSetAsync()
public
deleteRegexMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteRegexPatternSet()
public
deleteRegexPatternSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteRegexPatternSetAsync()
public
deleteRegexPatternSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteRule()
public
deleteRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteRuleAsync()
public
deleteRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteRuleGroup()
public
deleteRuleGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteRuleGroupAsync()
public
deleteRuleGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteSizeConstraintSet()
public
deleteSizeConstraintSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteSizeConstraintSetAsync()
public
deleteSizeConstraintSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteSqlInjectionMatchSet()
public
deleteSqlInjectionMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteSqlInjectionMatchSetAsync()
public
deleteSqlInjectionMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteWebACL()
public
deleteWebACL(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteWebACLAsync()
public
deleteWebACLAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteXssMatchSet()
public
deleteXssMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteXssMatchSetAsync()
public
deleteXssMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseemitDeprecationWarning()
public
static emitDeprecationWarning() : mixed
execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
factory()
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>getByteMatchSet()
public
getByteMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetByteMatchSetAsync()
public
getByteMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetChangeToken()
public
getChangeToken(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetChangeTokenAsync()
public
getChangeTokenAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetChangeTokenStatus()
public
getChangeTokenStatus(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetChangeTokenStatusAsync()
public
getChangeTokenStatusAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetClientBuiltIns()
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>getGeoMatchSet()
public
getGeoMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetGeoMatchSetAsync()
public
getGeoMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetHandlerList()
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
HandlerListgetIPSet()
public
getIPSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetIPSetAsync()
public
getIPSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetIterator()
public
getIterator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getLoggingConfiguration()
public
getLoggingConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetLoggingConfigurationAsync()
public
getLoggingConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getPermissionPolicy()
public
getPermissionPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetPermissionPolicyAsync()
public
getPermissionPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRateBasedRule()
public
getRateBasedRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetRateBasedRuleAsync()
public
getRateBasedRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRateBasedRuleManagedKeys()
public
getRateBasedRuleManagedKeys(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetRateBasedRuleManagedKeysAsync()
public
getRateBasedRuleManagedKeysAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRegexMatchSet()
public
getRegexMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetRegexMatchSetAsync()
public
getRegexMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRegexPatternSet()
public
getRegexPatternSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetRegexPatternSetAsync()
public
getRegexPatternSetAsync(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
stringgetRule()
public
getRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetRuleAsync()
public
getRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetRuleGroup()
public
getRuleGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetRuleGroupAsync()
public
getRuleGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSampledRequests()
public
getSampledRequests(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSampledRequestsAsync()
public
getSampledRequestsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callablegetSizeConstraintSet()
public
getSizeConstraintSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSizeConstraintSetAsync()
public
getSizeConstraintSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSqlInjectionMatchSet()
public
getSqlInjectionMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetSqlInjectionMatchSetAsync()
public
getSqlInjectionMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetWaiter()
public
getWaiter(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
getWebACL()
public
getWebACL(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetWebACLAsync()
public
getWebACLAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetXssMatchSet()
public
getXssMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetXssMatchSetAsync()
public
getXssMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistActivatedRulesInRuleGroup()
public
listActivatedRulesInRuleGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistActivatedRulesInRuleGroupAsync()
public
listActivatedRulesInRuleGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistByteMatchSets()
public
listByteMatchSets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistByteMatchSetsAsync()
public
listByteMatchSetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistGeoMatchSets()
public
listGeoMatchSets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistGeoMatchSetsAsync()
public
listGeoMatchSetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistIPSets()
public
listIPSets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistIPSetsAsync()
public
listIPSetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistLoggingConfigurations()
public
listLoggingConfigurations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistLoggingConfigurationsAsync()
public
listLoggingConfigurationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistRateBasedRules()
public
listRateBasedRules(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistRateBasedRulesAsync()
public
listRateBasedRulesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistRegexMatchSets()
public
listRegexMatchSets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistRegexMatchSetsAsync()
public
listRegexMatchSetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistRegexPatternSets()
public
listRegexPatternSets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistRegexPatternSetsAsync()
public
listRegexPatternSetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistRuleGroups()
public
listRuleGroups(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistRuleGroupsAsync()
public
listRuleGroupsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistRules()
public
listRules(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistRulesAsync()
public
listRulesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistSizeConstraintSets()
public
listSizeConstraintSets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistSizeConstraintSetsAsync()
public
listSizeConstraintSetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistSqlInjectionMatchSets()
public
listSqlInjectionMatchSets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistSqlInjectionMatchSetsAsync()
public
listSqlInjectionMatchSetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistSubscribedRuleGroups()
public
listSubscribedRuleGroups(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistSubscribedRuleGroupsAsync()
public
listSubscribedRuleGroupsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistWebACLs()
public
listWebACLs(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistWebACLsAsync()
public
listWebACLsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistXssMatchSets()
public
listXssMatchSets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistXssMatchSetsAsync()
public
listXssMatchSetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputLoggingConfiguration()
public
putLoggingConfiguration(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputLoggingConfigurationAsync()
public
putLoggingConfigurationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseputPermissionPolicy()
public
putPermissionPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultputPermissionPolicyAsync()
public
putPermissionPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagResource()
public
tagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttagResourceAsync()
public
tagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagResource()
public
untagResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultuntagResourceAsync()
public
untagResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateByteMatchSet()
public
updateByteMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateByteMatchSetAsync()
public
updateByteMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateGeoMatchSet()
public
updateGeoMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateGeoMatchSetAsync()
public
updateGeoMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateIPSet()
public
updateIPSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateIPSetAsync()
public
updateIPSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateRateBasedRule()
public
updateRateBasedRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateRateBasedRuleAsync()
public
updateRateBasedRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateRegexMatchSet()
public
updateRegexMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateRegexMatchSetAsync()
public
updateRegexMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateRegexPatternSet()
public
updateRegexPatternSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateRegexPatternSetAsync()
public
updateRegexPatternSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateRule()
public
updateRule(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateRuleAsync()
public
updateRuleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateRuleGroup()
public
updateRuleGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateRuleGroupAsync()
public
updateRuleGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateSizeConstraintSet()
public
updateSizeConstraintSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateSizeConstraintSetAsync()
public
updateSizeConstraintSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateSqlInjectionMatchSet()
public
updateSqlInjectionMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateSqlInjectionMatchSetAsync()
public
updateSqlInjectionMatchSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateWebACL()
public
updateWebACL(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateWebACLAsync()
public
updateWebACLAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateXssMatchSet()
public
updateXssMatchSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateXssMatchSetAsync()
public
updateXssMatchSetAsync(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> = []