Documentation

CloudFrontClient extends AwsClient
in package

This client is used to interact with the **Amazon CloudFront** 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
createCachePolicy()  :
createCachePolicyAsync()  :
createCloudFrontOriginAccessIdentity()  :
createCloudFrontOriginAccessIdentityAsync()  :
createDistribution()  :
createDistributionAsync()  :
createDistributionWithTags()  :
createDistributionWithTagsAsync()  :
createFieldLevelEncryptionConfig()  :
createFieldLevelEncryptionConfigAsync()  :
createFieldLevelEncryptionProfile()  :
createFieldLevelEncryptionProfileAsync()  :
createInvalidation()  :
createInvalidationAsync()  :
createKeyGroup()  :
createKeyGroupAsync()  :
createMonitoringSubscription()  :
createMonitoringSubscriptionAsync()  :
createOriginRequestPolicy()  :
createOriginRequestPolicyAsync()  :
createPublicKey()  :
createPublicKeyAsync()  :
createRealtimeLogConfig()  :
createRealtimeLogConfigAsync()  :
createStreamingDistribution()  :
createStreamingDistributionAsync()  :
createStreamingDistributionWithTags()  :
createStreamingDistributionWithTagsAsync()  :
deleteCachePolicy()  :
deleteCachePolicyAsync()  :
deleteCloudFrontOriginAccessIdentity()  :
deleteCloudFrontOriginAccessIdentityAsync()  :
deleteDistribution()  :
deleteDistributionAsync()  :
deleteFieldLevelEncryptionConfig()  :
deleteFieldLevelEncryptionConfigAsync()  :
deleteFieldLevelEncryptionProfile()  :
deleteFieldLevelEncryptionProfileAsync()  :
deleteKeyGroup()  :
deleteKeyGroupAsync()  :
deleteMonitoringSubscription()  :
deleteMonitoringSubscriptionAsync()  :
deleteOriginRequestPolicy()  :
deleteOriginRequestPolicyAsync()  :
deletePublicKey()  :
deletePublicKeyAsync()  :
deleteRealtimeLogConfig()  :
deleteRealtimeLogConfigAsync()  :
deleteServiceLinkedRole()  :
deleteServiceLinkedRoleAsync()  :
deleteStreamingDistribution()  :
deleteStreamingDistributionAsync()  :
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getCachePolicy()  :
getCachePolicyAsync()  :
getCachePolicyConfig()  :
getCachePolicyConfigAsync()  :
getCloudFrontOriginAccessIdentity()  :
getCloudFrontOriginAccessIdentityAsync()  :
getCloudFrontOriginAccessIdentityConfig()  :
getCloudFrontOriginAccessIdentityConfigAsync()  :
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.
getDistribution()  :
getDistributionAsync()  :
getDistributionConfig()  :
getDistributionConfigAsync()  :
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getFieldLevelEncryption()  :
getFieldLevelEncryptionAsync()  :
getFieldLevelEncryptionConfig()  :
getFieldLevelEncryptionConfigAsync()  :
getFieldLevelEncryptionProfile()  :
getFieldLevelEncryptionProfileAsync()  :
getFieldLevelEncryptionProfileConfig()  :
getFieldLevelEncryptionProfileConfigAsync()  :
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getInvalidation()  :
getInvalidationAsync()  :
getIterator()  : mixed
getKeyGroup()  :
getKeyGroupAsync()  :
getKeyGroupConfig()  :
getKeyGroupConfigAsync()  :
getMonitoringSubscription()  :
getMonitoringSubscriptionAsync()  :
getOriginRequestPolicy()  :
getOriginRequestPolicyAsync()  :
getOriginRequestPolicyConfig()  :
getOriginRequestPolicyConfigAsync()  :
getPaginator()  : mixed
getPublicKey()  :
getPublicKeyAsync()  :
getPublicKeyConfig()  :
getPublicKeyConfigAsync()  :
getRealtimeLogConfig()  :
getRealtimeLogConfigAsync()  :
getRegion()  : string
Get the region to which the client is configured to send requests.
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getSignedCookie()  : array<string|int, mixed>
Create a signed Amazon CloudFront cookie.
getSignedUrl()  : string
Create a signed Amazon CloudFront URL.
getStreamingDistribution()  :
getStreamingDistributionAsync()  :
getStreamingDistributionConfig()  :
getStreamingDistributionConfigAsync()  :
getWaiter()  : mixed
listCachePolicies()  :
listCachePoliciesAsync()  :
listCloudFrontOriginAccessIdentities()  :
listCloudFrontOriginAccessIdentitiesAsync()  :
listDistributions()  :
listDistributionsAsync()  :
listDistributionsByCachePolicyId()  :
listDistributionsByCachePolicyIdAsync()  :
listDistributionsByKeyGroup()  :
listDistributionsByKeyGroupAsync()  :
listDistributionsByOriginRequestPolicyId()  :
listDistributionsByOriginRequestPolicyIdAsync()  :
listDistributionsByRealtimeLogConfig()  :
listDistributionsByRealtimeLogConfigAsync()  :
listDistributionsByWebACLId()  :
listDistributionsByWebACLIdAsync()  :
listFieldLevelEncryptionConfigs()  :
listFieldLevelEncryptionConfigsAsync()  :
listFieldLevelEncryptionProfiles()  :
listFieldLevelEncryptionProfilesAsync()  :
listInvalidations()  :
listInvalidationsAsync()  :
listKeyGroups()  :
listKeyGroupsAsync()  :
listOriginRequestPolicies()  :
listOriginRequestPoliciesAsync()  :
listPublicKeys()  :
listPublicKeysAsync()  :
listRealtimeLogConfigs()  :
listRealtimeLogConfigsAsync()  :
listStreamingDistributions()  :
listStreamingDistributionsAsync()  :
listTagsForResource()  :
listTagsForResourceAsync()  :
tagResource()  :
tagResourceAsync()  :
untagResource()  :
untagResourceAsync()  :
updateCachePolicy()  :
updateCachePolicyAsync()  :
updateCloudFrontOriginAccessIdentity()  :
updateCloudFrontOriginAccessIdentityAsync()  :
updateDistribution()  :
updateDistributionAsync()  :
updateFieldLevelEncryptionConfig()  :
updateFieldLevelEncryptionConfigAsync()  :
updateFieldLevelEncryptionProfile()  :
updateFieldLevelEncryptionProfileAsync()  :
updateKeyGroup()  :
updateKeyGroupAsync()  :
updateOriginRequestPolicy()  :
updateOriginRequestPolicyAsync()  :
updatePublicKey()  :
updatePublicKeyAsync()  :
updateRealtimeLogConfig()  :
updateRealtimeLogConfigAsync()  :
updateStreamingDistribution()  :
updateStreamingDistributionAsync()  :
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

createCachePolicy()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createCachePolicyAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createCloudFrontOriginAccessIdentity()

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

createCloudFrontOriginAccessIdentityAsync()

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

createDistribution()

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

createDistributionAsync()

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

createDistributionWithTags()

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

(supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createDistributionWithTagsAsync()

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

(supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createFieldLevelEncryptionConfig()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createFieldLevelEncryptionConfigAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createFieldLevelEncryptionProfile()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createFieldLevelEncryptionProfileAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createInvalidation()

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

createInvalidationAsync()

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

createKeyGroup()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createKeyGroupAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createMonitoringSubscription()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createMonitoringSubscriptionAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createOriginRequestPolicy()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createOriginRequestPolicyAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createPublicKey()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createPublicKeyAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createRealtimeLogConfig()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createRealtimeLogConfigAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createStreamingDistribution()

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

createStreamingDistributionAsync()

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

createStreamingDistributionWithTags()

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

(supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createStreamingDistributionWithTagsAsync()

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

(supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteCachePolicy()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteCachePolicyAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteCloudFrontOriginAccessIdentity()

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

deleteCloudFrontOriginAccessIdentityAsync()

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

deleteDistribution()

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

deleteDistributionAsync()

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

deleteFieldLevelEncryptionConfig()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteFieldLevelEncryptionConfigAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteFieldLevelEncryptionProfile()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteFieldLevelEncryptionProfileAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteKeyGroup()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteKeyGroupAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteMonitoringSubscription()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteMonitoringSubscriptionAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteOriginRequestPolicy()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteOriginRequestPolicyAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deletePublicKey()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deletePublicKeyAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteRealtimeLogConfig()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteRealtimeLogConfigAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteServiceLinkedRole()

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

(supported in versions 2017-03-25)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteServiceLinkedRoleAsync()

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

(supported in versions 2017-03-25)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteStreamingDistribution()

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

deleteStreamingDistributionAsync()

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

getCachePolicy()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getCachePolicyAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getCachePolicyConfig()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getCachePolicyConfigAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getCloudFrontOriginAccessIdentity()

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

getCloudFrontOriginAccessIdentityAsync()

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

getCloudFrontOriginAccessIdentityConfig()

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

getCloudFrontOriginAccessIdentityConfigAsync()

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

getDistribution()

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

getDistributionAsync()

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

getDistributionConfig()

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

getDistributionConfigAsync()

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

getFieldLevelEncryption()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getFieldLevelEncryptionAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getFieldLevelEncryptionConfig()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getFieldLevelEncryptionConfigAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getFieldLevelEncryptionProfile()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getFieldLevelEncryptionProfileAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getFieldLevelEncryptionProfileConfig()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getFieldLevelEncryptionProfileConfigAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

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

getInvalidation()

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

getInvalidationAsync()

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

getKeyGroup()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getKeyGroupAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getKeyGroupConfig()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getKeyGroupConfigAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getMonitoringSubscription()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getMonitoringSubscriptionAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getOriginRequestPolicy()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getOriginRequestPolicyAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getOriginRequestPolicyConfig()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getOriginRequestPolicyConfigAsync()

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

(supported in versions 2020-05-31)

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

getPublicKey()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getPublicKeyAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getPublicKeyConfig()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getPublicKeyConfigAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getRealtimeLogConfig()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

getRealtimeLogConfigAsync()

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

(supported in versions 2020-05-31)

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

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getSignedCookie()

Create a signed Amazon CloudFront cookie.

public getSignedCookie(array<string|int, mixed> $options) : array<string|int, mixed>

This method accepts an array of configuration options:

  • url: (string) URL of the resource being signed (can include query string and wildcards). For example: http://d111111abcdef8.cloudfront.net/images/horizon.jpg?size=large&license=yes
  • policy: (string) JSON policy. Use this option when creating a signed URL for a custom policy.
  • expires: (int) UTC Unix timestamp used when signing with a canned policy. Not required when passing a custom 'policy' option.
  • key_pair_id: (string) The ID of the key pair used to sign CloudFront URLs for private distributions.
  • private_key: (string) The filepath ot the private key used to sign CloudFront URLs for private distributions.
Parameters
$options : array<string|int, mixed>

Array of configuration options used when signing

Tags
throws
InvalidArgumentException

if url, key_pair_id, or private_key were not specified.

link
http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/WorkingWithStreamingDistributions.html
Return values
array<string|int, mixed>

Key => value pairs of signed cookies to set

getSignedUrl()

Create a signed Amazon CloudFront URL.

public getSignedUrl(array<string|int, mixed> $options) : string

This method accepts an array of configuration options:

  • url: (string) URL of the resource being signed (can include query string and wildcards). For example: rtmp://s5c39gqb8ow64r.cloudfront.net/videos/mp3_name.mp3 http://d111111abcdef8.cloudfront.net/images/horizon.jpg?size=large&license=yes
  • policy: (string) JSON policy. Use this option when creating a signed URL for a custom policy.
  • expires: (int) UTC Unix timestamp used when signing with a canned policy. Not required when passing a custom 'policy' option.
  • key_pair_id: (string) The ID of the key pair used to sign CloudFront URLs for private distributions.
  • private_key: (string) The filepath ot the private key used to sign CloudFront URLs for private distributions.
Parameters
$options : array<string|int, mixed>

Array of configuration options used when signing

Tags
throws
InvalidArgumentException

if url, key_pair_id, or private_key were not specified.

link
http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/WorkingWithStreamingDistributions.html
Return values
string

Signed URL with authentication parameters

getStreamingDistribution()

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

getStreamingDistributionAsync()

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

getStreamingDistributionConfig()

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

getStreamingDistributionConfigAsync()

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

listCachePolicies()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listCachePoliciesAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listCloudFrontOriginAccessIdentities()

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

listCloudFrontOriginAccessIdentitiesAsync()

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

listDistributions()

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

listDistributionsAsync()

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

listDistributionsByCachePolicyId()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listDistributionsByCachePolicyIdAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listDistributionsByKeyGroup()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listDistributionsByKeyGroupAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listDistributionsByOriginRequestPolicyId()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listDistributionsByOriginRequestPolicyIdAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listDistributionsByRealtimeLogConfig()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listDistributionsByRealtimeLogConfigAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listDistributionsByWebACLId()

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

listDistributionsByWebACLIdAsync()

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

listFieldLevelEncryptionConfigs()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listFieldLevelEncryptionConfigsAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listFieldLevelEncryptionProfiles()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listFieldLevelEncryptionProfilesAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listInvalidations()

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

listInvalidationsAsync()

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

listKeyGroups()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listKeyGroupsAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listOriginRequestPolicies()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listOriginRequestPoliciesAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listPublicKeys()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listPublicKeysAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listRealtimeLogConfigs()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listRealtimeLogConfigsAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listStreamingDistributions()

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

listStreamingDistributionsAsync()

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

listTagsForResource()

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

(supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listTagsForResourceAsync()

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

(supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

tagResource()

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

(supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

tagResourceAsync()

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

(supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

untagResource()

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

(supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

untagResourceAsync()

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

(supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

updateCachePolicy()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

updateCachePolicyAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

updateCloudFrontOriginAccessIdentity()

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

updateCloudFrontOriginAccessIdentityAsync()

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

updateDistribution()

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

updateDistributionAsync()

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

updateFieldLevelEncryptionConfig()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

updateFieldLevelEncryptionConfigAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

updateFieldLevelEncryptionProfile()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

updateFieldLevelEncryptionProfileAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

updateKeyGroup()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

updateKeyGroupAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

updateOriginRequestPolicy()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

updateOriginRequestPolicyAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

updatePublicKey()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

updatePublicKeyAsync()

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

(supported in versions 2017-10-30, 2018-06-18, 2018-11-05, 2019-03-26, 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

updateRealtimeLogConfig()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

updateRealtimeLogConfigAsync()

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

(supported in versions 2020-05-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

updateStreamingDistribution()

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

updateStreamingDistributionAsync()

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