SDK for PHP 3.x

WAFV2Client extends AwsClient
in package

This client is used to interact with the AWS WAFV2 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.

Table of Contents

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
associateWebACL()  : Result
associateWebACLAsync()  : Promise
checkCapacity()  : Result
checkCapacityAsync()  : Promise
createAPIKey()  : Result
createAPIKeyAsync()  : Promise
createIPSet()  : Result
createIPSetAsync()  : Promise
createRegexPatternSet()  : Result
createRegexPatternSetAsync()  : Promise
createRuleGroup()  : Result
createRuleGroupAsync()  : Promise
createWebACL()  : Result
createWebACLAsync()  : Promise
deleteAPIKey()  : Result
deleteAPIKeyAsync()  : Promise
deleteFirewallManagerRuleGroups()  : Result
deleteFirewallManagerRuleGroupsAsync()  : Promise
deleteIPSet()  : Result
deleteIPSetAsync()  : Promise
deleteLoggingConfiguration()  : Result
deleteLoggingConfigurationAsync()  : Promise
deletePermissionPolicy()  : Result
deletePermissionPolicyAsync()  : Promise
deleteRegexPatternSet()  : Result
deleteRegexPatternSetAsync()  : Promise
deleteRuleGroup()  : Result
deleteRuleGroupAsync()  : Promise
deleteWebACL()  : Result
deleteWebACLAsync()  : Promise
describeAllManagedProducts()  : Result
describeAllManagedProductsAsync()  : Promise
describeManagedProductsByVendor()  : Result
describeManagedProductsByVendorAsync()  : Promise
describeManagedRuleGroup()  : Result
describeManagedRuleGroupAsync()  : Promise
disassociateWebACL()  : Result
disassociateWebACLAsync()  : Promise
emitDeprecationWarning()  : mixed
execute()  : mixed
executeAsync()  : mixed
factory()  : static
generateMobileSdkReleaseUrl()  : Result
generateMobileSdkReleaseUrlAsync()  : Promise
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.
getDecryptedAPIKey()  : Result
getDecryptedAPIKeyAsync()  : Promise
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.
getIPSet()  : Result
getIPSetAsync()  : Promise
getIterator()  : mixed
getLoggingConfiguration()  : Result
getLoggingConfigurationAsync()  : Promise
getManagedRuleSet()  : Result
getManagedRuleSetAsync()  : Promise
getMobileSdkRelease()  : Result
getMobileSdkReleaseAsync()  : Promise
getPaginator()  : mixed
getPermissionPolicy()  : Result
getPermissionPolicyAsync()  : Promise
getRateBasedStatementManagedKeys()  : Result
getRateBasedStatementManagedKeysAsync()  : Promise
getRegexPatternSet()  : Result
getRegexPatternSetAsync()  : Promise
getRegion()  : string
Get the region to which the client is configured to send requests.
getRuleGroup()  : Result
getRuleGroupAsync()  : Promise
getSampledRequests()  : Result
getSampledRequestsAsync()  : Promise
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
getWebACL()  : Result
getWebACLAsync()  : Promise
getWebACLForResource()  : Result
getWebACLForResourceAsync()  : Promise
listAPIKeys()  : Result
listAPIKeysAsync()  : Promise
listAvailableManagedRuleGroups()  : Result
listAvailableManagedRuleGroupsAsync()  : Promise
listAvailableManagedRuleGroupVersions()  : Result
listAvailableManagedRuleGroupVersionsAsync()  : Promise
listIPSets()  : Result
listIPSetsAsync()  : Promise
listLoggingConfigurations()  : Result
listLoggingConfigurationsAsync()  : Promise
listManagedRuleSets()  : Result
listManagedRuleSetsAsync()  : Promise
listMobileSdkReleases()  : Result
listMobileSdkReleasesAsync()  : Promise
listRegexPatternSets()  : Result
listRegexPatternSetsAsync()  : Promise
listResourcesForWebACL()  : Result
listResourcesForWebACLAsync()  : Promise
listRuleGroups()  : Result
listRuleGroupsAsync()  : Promise
listTagsForResource()  : Result
listTagsForResourceAsync()  : Promise
listWebACLs()  : Result
listWebACLsAsync()  : Promise
putLoggingConfiguration()  : Result
putLoggingConfigurationAsync()  : Promise
putManagedRuleSetVersions()  : Result
putManagedRuleSetVersionsAsync()  : Promise
putPermissionPolicy()  : Result
putPermissionPolicyAsync()  : Promise
tagResource()  : Result
tagResourceAsync()  : Promise
untagResource()  : Result
untagResourceAsync()  : Promise
updateIPSet()  : Result
updateIPSetAsync()  : Promise
updateManagedRuleSetVersionExpiryDate()  : Result
updateManagedRuleSetVersionExpiryDateAsync()  : Promise
updateRegexPatternSet()  : Result
updateRegexPatternSetAsync()  : Promise
updateRuleGroup()  : Result
updateRuleGroupAsync()  : Promise
updateWebACL()  : Result
updateWebACLAsync()  : Promise
waitUntil()  : mixed

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed>

__construct()

The client constructor accepts the following options:

public __construct(array<string|int, mixed> $args) : mixed
  • api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
  • credentials: (Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies the credentials used to sign requests. Provide an Aws\Credentials\CredentialsInterface object, an associative array of "key", "secret", and an optional "token" key, false to use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment.
  • token: (Aws\Token\TokenInterface|array|bool|callable) Specifies the token used to authorize requests. Provide an Aws\Token\TokenInterface object, an associative array of "token" and an optional "expires" key, false to use no token, or a callable token provider used to create a token or return null. See Aws\Token\TokenProvider for a list of built-in token providers. If no token is provided, the SDK will attempt to load one from the environment.
  • csm: (Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies the credentials used to sign requests. Provide an Aws\ClientSideMonitoring\ConfigurationInterface object, a callable configuration provider used to create client-side monitoring configuration, false to disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project
  • debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
  • stats: (bool|array) Set to true to gather transfer statistics on requests sent. Alternatively, you can provide an associative array with the following keys: retries: (bool) Set to false to disable reporting on retries attempted; http: (bool) Set to true to enable collecting statistics from lower level HTTP adapters (e.g., values returned in GuzzleHttp\TransferStats). HTTP handlers must support an http_stats_receiver option for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds.
  • disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
  • endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
  • endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
  • endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
  • handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
  • http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
  • http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
  • idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
  • profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
  • region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
  • retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
  • scheme: (string, default=string(5) "https") URI scheme to use when connecting connect. The SDK will utilize "https" endpoints (i.e., utilize SSL/TLS connections) by default. You can attempt to connect to a service over an unencrypted "http" endpoint by setting scheme to "http".
  • signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
  • signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
  • use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
  • validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
  • version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
  • ua_append: (string, array) To pass custom user agent parameters.
  • app_id: (string) an optional application specific identifier that can be set. When set it will be appended to the User-Agent header of every request in the form of App/{AppId}. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. See https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html for more information on environment variables and shared config settings.
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

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

__sleep()

public __sleep() : mixed

associateWebACL()

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

associateWebACLAsync()

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

checkCapacity()

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

checkCapacityAsync()

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

createAPIKey()

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

createAPIKeyAsync()

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

createIPSet()

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

createIPSetAsync()

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

createRegexPatternSet()

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

createRegexPatternSetAsync()

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

createRuleGroup()

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

createRuleGroupAsync()

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

createWebACL()

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

createWebACLAsync()

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

deleteAPIKey()

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

deleteAPIKeyAsync()

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

deleteFirewallManagerRuleGroups()

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

deleteFirewallManagerRuleGroupsAsync()

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

deleteIPSet()

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

deleteIPSetAsync()

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

deleteLoggingConfiguration()

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

deleteLoggingConfigurationAsync()

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

deletePermissionPolicy()

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

deletePermissionPolicyAsync()

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

deleteRegexPatternSet()

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

deleteRegexPatternSetAsync()

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

deleteRuleGroup()

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

deleteRuleGroupAsync()

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

deleteWebACL()

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

deleteWebACLAsync()

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

describeAllManagedProducts()

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

describeAllManagedProductsAsync()

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

describeManagedProductsByVendor()

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

describeManagedProductsByVendorAsync()

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

describeManagedRuleGroup()

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

describeManagedRuleGroupAsync()

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

disassociateWebACL()

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

disassociateWebACLAsync()

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

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

factory()

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

generateMobileSdkReleaseUrl()

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

generateMobileSdkReleaseUrlAsync()

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

getArguments()

Get an array of client constructor arguments used by the client.

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

getClientBuiltIns()

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

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

getClientContextParams()

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

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

getCommand()

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

getConfig()

Get a client configuration value.

public getConfig([mixed $option = null ]) : mixed|null
Parameters
$option : mixed = null

The option to retrieve. Pass null to retrieve all options.

Return values
mixed|null

getCredentials()

Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.

public getCredentials() : PromiseInterface

If you need the credentials synchronously, then call the wait() method on the returned promise.

Return values
PromiseInterface

getDecryptedAPIKey()

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

getDecryptedAPIKeyAsync()

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

getEndpoint()

Gets the default endpoint, or base URL, used by the client.

public getEndpoint() : UriInterface
Return values
UriInterface

getEndpointProvider()

public getEndpointProvider() : mixed

getEndpointProviderArgs()

Retrieves arguments to be used in endpoint resolution.

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

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.

Return values
HandlerList

getIPSet()

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

getIPSetAsync()

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

getIterator()

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
Result

getLoggingConfigurationAsync()

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

getManagedRuleSet()

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

getManagedRuleSetAsync()

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

getMobileSdkRelease()

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

getMobileSdkReleaseAsync()

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

getPaginator()

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
Result

getPermissionPolicyAsync()

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

getRateBasedStatementManagedKeys()

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

getRateBasedStatementManagedKeysAsync()

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

getRegexPatternSet()

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

getRegexPatternSetAsync()

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

getRegion()

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

public getRegion() : string
Return values
string

getRuleGroup()

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

getRuleGroupAsync()

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

getSampledRequests()

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

getSampledRequestsAsync()

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

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getWaiter()

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

getWebACL()

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

getWebACLAsync()

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

getWebACLForResource()

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

getWebACLForResourceAsync()

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

listAPIKeys()

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

listAPIKeysAsync()

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

listAvailableManagedRuleGroups()

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

listAvailableManagedRuleGroupsAsync()

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

listAvailableManagedRuleGroupVersions()

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

listAvailableManagedRuleGroupVersionsAsync()

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

listIPSets()

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

listIPSetsAsync()

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

listLoggingConfigurations()

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

listLoggingConfigurationsAsync()

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

listManagedRuleSets()

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

listManagedRuleSetsAsync()

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

listMobileSdkReleases()

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

listMobileSdkReleasesAsync()

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

listRegexPatternSets()

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

listRegexPatternSetsAsync()

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

listResourcesForWebACL()

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

listResourcesForWebACLAsync()

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

listRuleGroups()

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

listRuleGroupsAsync()

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

listTagsForResource()

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

listTagsForResourceAsync()

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

listWebACLs()

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

listWebACLsAsync()

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

putLoggingConfiguration()

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

putLoggingConfigurationAsync()

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

putManagedRuleSetVersions()

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

putManagedRuleSetVersionsAsync()

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

putPermissionPolicy()

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

putPermissionPolicyAsync()

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

tagResource()

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

tagResourceAsync()

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

untagResource()

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

untagResourceAsync()

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

updateIPSet()

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

updateIPSetAsync()

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

updateManagedRuleSetVersionExpiryDate()

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

updateManagedRuleSetVersionExpiryDateAsync()

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

updateRegexPatternSet()

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

updateRegexPatternSetAsync()

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

updateRuleGroup()

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

updateRuleGroupAsync()

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

updateWebACL()

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

updateWebACLAsync()

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

waitUntil()

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