CloudFrontClient
extends AwsClient
in package
This client is used to interact with the Amazon CloudFront 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.
- AssociateAlias
- CopyDistribution
- CreateCachePolicy
- CreateCloudFrontOriginAccessIdentity
- CreateContinuousDeploymentPolicy
- CreateDistribution
- CreateDistributionWithTags
- CreateFieldLevelEncryptionConfig
- CreateFieldLevelEncryptionProfile
- CreateFunction
- CreateInvalidation
- CreateKeyGroup
- CreateKeyValueStore
- CreateMonitoringSubscription
- CreateOriginAccessControl
- CreateOriginRequestPolicy
- CreatePublicKey
- CreateRealtimeLogConfig
- CreateResponseHeadersPolicy
- CreateStreamingDistribution
- CreateStreamingDistributionWithTags
- DeleteCachePolicy
- DeleteCloudFrontOriginAccessIdentity
- DeleteContinuousDeploymentPolicy
- DeleteDistribution
- DeleteFieldLevelEncryptionConfig
- DeleteFieldLevelEncryptionProfile
- DeleteFunction
- DeleteKeyGroup
- DeleteKeyValueStore
- DeleteMonitoringSubscription
- DeleteOriginAccessControl
- DeleteOriginRequestPolicy
- DeletePublicKey
- DeleteRealtimeLogConfig
- DeleteResponseHeadersPolicy
- DeleteStreamingDistribution
- DescribeFunction
- DescribeKeyValueStore
- GetCachePolicy
- GetCachePolicyConfig
- GetCloudFrontOriginAccessIdentity
- GetCloudFrontOriginAccessIdentityConfig
- GetContinuousDeploymentPolicy
- GetContinuousDeploymentPolicyConfig
- GetDistribution
- GetDistributionConfig
- GetFieldLevelEncryption
- GetFieldLevelEncryptionConfig
- GetFieldLevelEncryptionProfile
- GetFieldLevelEncryptionProfileConfig
- GetFunction
- GetInvalidation
- GetKeyGroup
- GetKeyGroupConfig
- GetMonitoringSubscription
- GetOriginAccessControl
- GetOriginAccessControlConfig
- GetOriginRequestPolicy
- GetOriginRequestPolicyConfig
- GetPublicKey
- GetPublicKeyConfig
- GetRealtimeLogConfig
- GetResponseHeadersPolicy
- GetResponseHeadersPolicyConfig
- GetStreamingDistribution
- GetStreamingDistributionConfig
- ListCachePolicies
- ListCloudFrontOriginAccessIdentities
- ListConflictingAliases
- ListContinuousDeploymentPolicies
- ListDistributions
- ListDistributionsByCachePolicyId
- ListDistributionsByKeyGroup
- ListDistributionsByOriginRequestPolicyId
- ListDistributionsByRealtimeLogConfig
- ListDistributionsByResponseHeadersPolicyId
- ListDistributionsByWebACLId
- ListFieldLevelEncryptionConfigs
- ListFieldLevelEncryptionProfiles
- ListFunctions
- ListInvalidations
- ListKeyGroups
- ListKeyValueStores
- ListOriginAccessControls
- ListOriginRequestPolicies
- ListPublicKeys
- ListRealtimeLogConfigs
- ListResponseHeadersPolicies
- ListStreamingDistributions
- ListTagsForResource
- PublishFunction
- TagResource
- TestFunction
- UntagResource
- UpdateCachePolicy
- UpdateCloudFrontOriginAccessIdentity
- UpdateContinuousDeploymentPolicy
- UpdateDistribution
- UpdateDistributionWithStagingConfig
- UpdateFieldLevelEncryptionConfig
- UpdateFieldLevelEncryptionProfile
- UpdateFunction
- UpdateKeyGroup
- UpdateKeyValueStore
- UpdateOriginAccessControl
- UpdateOriginRequestPolicy
- UpdatePublicKey
- UpdateRealtimeLogConfig
- UpdateResponseHeadersPolicy
- UpdateStreamingDistribution
- CreateCloudFrontOriginAccessIdentity
- CreateDistribution
- CreateDistributionWithTags
- CreateFieldLevelEncryptionConfig
- CreateFieldLevelEncryptionProfile
- CreateInvalidation
- CreatePublicKey
- CreateStreamingDistribution
- CreateStreamingDistributionWithTags
- DeleteCloudFrontOriginAccessIdentity
- DeleteDistribution
- DeleteFieldLevelEncryptionConfig
- DeleteFieldLevelEncryptionProfile
- DeletePublicKey
- DeleteStreamingDistribution
- GetCloudFrontOriginAccessIdentity
- GetCloudFrontOriginAccessIdentityConfig
- GetDistribution
- GetDistributionConfig
- GetFieldLevelEncryption
- GetFieldLevelEncryptionConfig
- GetFieldLevelEncryptionProfile
- GetFieldLevelEncryptionProfileConfig
- GetInvalidation
- GetPublicKey
- GetPublicKeyConfig
- GetStreamingDistribution
- GetStreamingDistributionConfig
- ListCloudFrontOriginAccessIdentities
- ListDistributions
- ListDistributionsByWebACLId
- ListFieldLevelEncryptionConfigs
- ListFieldLevelEncryptionProfiles
- ListInvalidations
- ListPublicKeys
- ListStreamingDistributions
- ListTagsForResource
- TagResource
- UntagResource
- UpdateCloudFrontOriginAccessIdentity
- UpdateDistribution
- UpdateFieldLevelEncryptionConfig
- UpdateFieldLevelEncryptionProfile
- UpdatePublicKey
- UpdateStreamingDistribution
- CreateCloudFrontOriginAccessIdentity
- CreateDistribution
- CreateDistributionWithTags
- CreateFieldLevelEncryptionConfig
- CreateFieldLevelEncryptionProfile
- CreateInvalidation
- CreatePublicKey
- CreateStreamingDistribution
- CreateStreamingDistributionWithTags
- DeleteCloudFrontOriginAccessIdentity
- DeleteDistribution
- DeleteFieldLevelEncryptionConfig
- DeleteFieldLevelEncryptionProfile
- DeletePublicKey
- DeleteStreamingDistribution
- GetCloudFrontOriginAccessIdentity
- GetCloudFrontOriginAccessIdentityConfig
- GetDistribution
- GetDistributionConfig
- GetFieldLevelEncryption
- GetFieldLevelEncryptionConfig
- GetFieldLevelEncryptionProfile
- GetFieldLevelEncryptionProfileConfig
- GetInvalidation
- GetPublicKey
- GetPublicKeyConfig
- GetStreamingDistribution
- GetStreamingDistributionConfig
- ListCloudFrontOriginAccessIdentities
- ListDistributions
- ListDistributionsByWebACLId
- ListFieldLevelEncryptionConfigs
- ListFieldLevelEncryptionProfiles
- ListInvalidations
- ListPublicKeys
- ListStreamingDistributions
- ListTagsForResource
- TagResource
- UntagResource
- UpdateCloudFrontOriginAccessIdentity
- UpdateDistribution
- UpdateFieldLevelEncryptionConfig
- UpdateFieldLevelEncryptionProfile
- UpdatePublicKey
- UpdateStreamingDistribution
- CreateCloudFrontOriginAccessIdentity
- CreateDistribution
- CreateDistributionWithTags
- CreateFieldLevelEncryptionConfig
- CreateFieldLevelEncryptionProfile
- CreateInvalidation
- CreatePublicKey
- CreateStreamingDistribution
- CreateStreamingDistributionWithTags
- DeleteCloudFrontOriginAccessIdentity
- DeleteDistribution
- DeleteFieldLevelEncryptionConfig
- DeleteFieldLevelEncryptionProfile
- DeletePublicKey
- DeleteStreamingDistribution
- GetCloudFrontOriginAccessIdentity
- GetCloudFrontOriginAccessIdentityConfig
- GetDistribution
- GetDistributionConfig
- GetFieldLevelEncryption
- GetFieldLevelEncryptionConfig
- GetFieldLevelEncryptionProfile
- GetFieldLevelEncryptionProfileConfig
- GetInvalidation
- GetPublicKey
- GetPublicKeyConfig
- GetStreamingDistribution
- GetStreamingDistributionConfig
- ListCloudFrontOriginAccessIdentities
- ListDistributions
- ListDistributionsByWebACLId
- ListFieldLevelEncryptionConfigs
- ListFieldLevelEncryptionProfiles
- ListInvalidations
- ListPublicKeys
- ListStreamingDistributions
- ListTagsForResource
- TagResource
- UntagResource
- UpdateCloudFrontOriginAccessIdentity
- UpdateDistribution
- UpdateFieldLevelEncryptionConfig
- UpdateFieldLevelEncryptionProfile
- UpdatePublicKey
- UpdateStreamingDistribution
- CreateCloudFrontOriginAccessIdentity
- CreateDistribution
- CreateDistributionWithTags
- CreateFieldLevelEncryptionConfig
- CreateFieldLevelEncryptionProfile
- CreateInvalidation
- CreatePublicKey
- CreateStreamingDistribution
- CreateStreamingDistributionWithTags
- DeleteCloudFrontOriginAccessIdentity
- DeleteDistribution
- DeleteFieldLevelEncryptionConfig
- DeleteFieldLevelEncryptionProfile
- DeletePublicKey
- DeleteStreamingDistribution
- GetCloudFrontOriginAccessIdentity
- GetCloudFrontOriginAccessIdentityConfig
- GetDistribution
- GetDistributionConfig
- GetFieldLevelEncryption
- GetFieldLevelEncryptionConfig
- GetFieldLevelEncryptionProfile
- GetFieldLevelEncryptionProfileConfig
- GetInvalidation
- GetPublicKey
- GetPublicKeyConfig
- GetStreamingDistribution
- GetStreamingDistributionConfig
- ListCloudFrontOriginAccessIdentities
- ListDistributions
- ListDistributionsByWebACLId
- ListFieldLevelEncryptionConfigs
- ListFieldLevelEncryptionProfiles
- ListInvalidations
- ListPublicKeys
- ListStreamingDistributions
- ListTagsForResource
- TagResource
- UntagResource
- UpdateCloudFrontOriginAccessIdentity
- UpdateDistribution
- UpdateFieldLevelEncryptionConfig
- UpdateFieldLevelEncryptionProfile
- UpdatePublicKey
- UpdateStreamingDistribution
- CreateCloudFrontOriginAccessIdentity
- CreateDistribution
- CreateDistributionWithTags
- CreateInvalidation
- CreateStreamingDistribution
- CreateStreamingDistributionWithTags
- DeleteCloudFrontOriginAccessIdentity
- DeleteDistribution
- DeleteServiceLinkedRole
- DeleteStreamingDistribution
- GetCloudFrontOriginAccessIdentity
- GetCloudFrontOriginAccessIdentityConfig
- GetDistribution
- GetDistributionConfig
- GetInvalidation
- GetStreamingDistribution
- GetStreamingDistributionConfig
- ListCloudFrontOriginAccessIdentities
- ListDistributions
- ListDistributionsByWebACLId
- ListInvalidations
- ListStreamingDistributions
- ListTagsForResource
- TagResource
- UntagResource
- UpdateCloudFrontOriginAccessIdentity
- UpdateDistribution
- UpdateStreamingDistribution
- CreateCloudFrontOriginAccessIdentity
- CreateDistribution
- CreateDistributionWithTags
- CreateInvalidation
- CreateStreamingDistribution
- CreateStreamingDistributionWithTags
- DeleteCloudFrontOriginAccessIdentity
- DeleteDistribution
- DeleteStreamingDistribution
- GetCloudFrontOriginAccessIdentity
- GetCloudFrontOriginAccessIdentityConfig
- GetDistribution
- GetDistributionConfig
- GetInvalidation
- GetStreamingDistribution
- GetStreamingDistributionConfig
- ListCloudFrontOriginAccessIdentities
- ListDistributions
- ListDistributionsByWebACLId
- ListInvalidations
- ListStreamingDistributions
- ListTagsForResource
- TagResource
- UntagResource
- UpdateCloudFrontOriginAccessIdentity
- UpdateDistribution
- UpdateStreamingDistribution
- CreateCloudFrontOriginAccessIdentity
- CreateDistribution
- CreateDistributionWithTags
- CreateInvalidation
- CreateStreamingDistribution
- CreateStreamingDistributionWithTags
- DeleteCloudFrontOriginAccessIdentity
- DeleteDistribution
- DeleteStreamingDistribution
- GetCloudFrontOriginAccessIdentity
- GetCloudFrontOriginAccessIdentityConfig
- GetDistribution
- GetDistributionConfig
- GetInvalidation
- GetStreamingDistribution
- GetStreamingDistributionConfig
- ListCloudFrontOriginAccessIdentities
- ListDistributions
- ListDistributionsByWebACLId
- ListInvalidations
- ListStreamingDistributions
- ListTagsForResource
- TagResource
- UntagResource
- UpdateCloudFrontOriginAccessIdentity
- UpdateDistribution
- UpdateStreamingDistribution
- CreateCloudFrontOriginAccessIdentity
- CreateDistribution
- CreateDistributionWithTags
- CreateInvalidation
- CreateStreamingDistribution
- CreateStreamingDistributionWithTags
- DeleteCloudFrontOriginAccessIdentity
- DeleteDistribution
- DeleteStreamingDistribution
- GetCloudFrontOriginAccessIdentity
- GetCloudFrontOriginAccessIdentityConfig
- GetDistribution
- GetDistributionConfig
- GetInvalidation
- GetStreamingDistribution
- GetStreamingDistributionConfig
- ListCloudFrontOriginAccessIdentities
- ListDistributions
- ListDistributionsByWebACLId
- ListInvalidations
- ListStreamingDistributions
- ListTagsForResource
- TagResource
- UntagResource
- UpdateCloudFrontOriginAccessIdentity
- UpdateDistribution
- UpdateStreamingDistribution
- CreateCloudFrontOriginAccessIdentity
- CreateDistribution
- CreateDistributionWithTags
- CreateInvalidation
- CreateStreamingDistribution
- CreateStreamingDistributionWithTags
- DeleteCloudFrontOriginAccessIdentity
- DeleteDistribution
- DeleteStreamingDistribution
- GetCloudFrontOriginAccessIdentity
- GetCloudFrontOriginAccessIdentityConfig
- GetDistribution
- GetDistributionConfig
- GetInvalidation
- GetStreamingDistribution
- GetStreamingDistributionConfig
- ListCloudFrontOriginAccessIdentities
- ListDistributions
- ListDistributionsByWebACLId
- ListInvalidations
- ListStreamingDistributions
- ListTagsForResource
- TagResource
- UntagResource
- UpdateCloudFrontOriginAccessIdentity
- UpdateDistribution
- UpdateStreamingDistribution
- CreateCloudFrontOriginAccessIdentity
- CreateDistribution
- CreateDistributionWithTags
- CreateInvalidation
- CreateStreamingDistribution
- CreateStreamingDistributionWithTags
- DeleteCloudFrontOriginAccessIdentity
- DeleteDistribution
- DeleteStreamingDistribution
- GetCloudFrontOriginAccessIdentity
- GetCloudFrontOriginAccessIdentityConfig
- GetDistribution
- GetDistributionConfig
- GetInvalidation
- GetStreamingDistribution
- GetStreamingDistributionConfig
- ListCloudFrontOriginAccessIdentities
- ListDistributions
- ListDistributionsByWebACLId
- ListInvalidations
- ListStreamingDistributions
- ListTagsForResource
- TagResource
- UntagResource
- UpdateCloudFrontOriginAccessIdentity
- UpdateDistribution
- UpdateStreamingDistribution
- CreateCloudFrontOriginAccessIdentity
- CreateDistribution
- CreateInvalidation
- CreateStreamingDistribution
- DeleteCloudFrontOriginAccessIdentity
- DeleteDistribution
- DeleteStreamingDistribution
- GetCloudFrontOriginAccessIdentity
- GetCloudFrontOriginAccessIdentityConfig
- GetDistribution
- GetDistributionConfig
- GetInvalidation
- GetStreamingDistribution
- GetStreamingDistributionConfig
- ListCloudFrontOriginAccessIdentities
- ListDistributions
- ListDistributionsByWebACLId
- ListInvalidations
- ListStreamingDistributions
- UpdateCloudFrontOriginAccessIdentity
- UpdateDistribution
- UpdateStreamingDistribution
- CreateCloudFrontOriginAccessIdentity
- CreateDistribution
- CreateInvalidation
- CreateStreamingDistribution
- DeleteCloudFrontOriginAccessIdentity
- DeleteDistribution
- DeleteStreamingDistribution
- GetCloudFrontOriginAccessIdentity
- GetCloudFrontOriginAccessIdentityConfig
- GetDistribution
- GetDistributionConfig
- GetInvalidation
- GetStreamingDistribution
- GetStreamingDistributionConfig
- ListCloudFrontOriginAccessIdentities
- ListDistributions
- ListDistributionsByWebACLId
- ListInvalidations
- ListStreamingDistributions
- UpdateCloudFrontOriginAccessIdentity
- UpdateDistribution
- UpdateStreamingDistribution
Table of Contents
Methods
- __call() : mixed
- __construct() : mixed
- The client constructor accepts the following options:
- __sleep() : mixed
- associateAlias() : Result
- associateAliasAsync() : Promise
- copyDistribution() : Result
- copyDistributionAsync() : Promise
- createCachePolicy() : Result
- createCachePolicyAsync() : Promise
- createCloudFrontOriginAccessIdentity() : Result
- createCloudFrontOriginAccessIdentityAsync() : Promise
- createContinuousDeploymentPolicy() : Result
- createContinuousDeploymentPolicyAsync() : Promise
- createDistribution() : Result
- createDistributionAsync() : Promise
- createDistributionWithTags() : Result
- createDistributionWithTagsAsync() : Promise
- createFieldLevelEncryptionConfig() : Result
- createFieldLevelEncryptionConfigAsync() : Promise
- createFieldLevelEncryptionProfile() : Result
- createFieldLevelEncryptionProfileAsync() : Promise
- createFunction() : Result
- createFunctionAsync() : Promise
- createInvalidation() : Result
- createInvalidationAsync() : Promise
- createKeyGroup() : Result
- createKeyGroupAsync() : Promise
- createKeyValueStore() : Result
- createKeyValueStoreAsync() : Promise
- createMonitoringSubscription() : Result
- createMonitoringSubscriptionAsync() : Promise
- createOriginAccessControl() : Result
- createOriginAccessControlAsync() : Promise
- createOriginRequestPolicy() : Result
- createOriginRequestPolicyAsync() : Promise
- createPublicKey() : Result
- createPublicKeyAsync() : Promise
- createRealtimeLogConfig() : Result
- createRealtimeLogConfigAsync() : Promise
- createResponseHeadersPolicy() : Result
- createResponseHeadersPolicyAsync() : Promise
- createStreamingDistribution() : Result
- createStreamingDistributionAsync() : Promise
- createStreamingDistributionWithTags() : Result
- createStreamingDistributionWithTagsAsync() : Promise
- deleteCachePolicy() : Result
- deleteCachePolicyAsync() : Promise
- deleteCloudFrontOriginAccessIdentity() : Result
- deleteCloudFrontOriginAccessIdentityAsync() : Promise
- deleteContinuousDeploymentPolicy() : Result
- deleteContinuousDeploymentPolicyAsync() : Promise
- deleteDistribution() : Result
- deleteDistributionAsync() : Promise
- deleteFieldLevelEncryptionConfig() : Result
- deleteFieldLevelEncryptionConfigAsync() : Promise
- deleteFieldLevelEncryptionProfile() : Result
- deleteFieldLevelEncryptionProfileAsync() : Promise
- deleteFunction() : Result
- deleteFunctionAsync() : Promise
- deleteKeyGroup() : Result
- deleteKeyGroupAsync() : Promise
- deleteKeyValueStore() : Result
- deleteKeyValueStoreAsync() : Promise
- deleteMonitoringSubscription() : Result
- deleteMonitoringSubscriptionAsync() : Promise
- deleteOriginAccessControl() : Result
- deleteOriginAccessControlAsync() : Promise
- deleteOriginRequestPolicy() : Result
- deleteOriginRequestPolicyAsync() : Promise
- deletePublicKey() : Result
- deletePublicKeyAsync() : Promise
- deleteRealtimeLogConfig() : Result
- deleteRealtimeLogConfigAsync() : Promise
- deleteResponseHeadersPolicy() : Result
- deleteResponseHeadersPolicyAsync() : Promise
- deleteServiceLinkedRole() : Result
- deleteServiceLinkedRoleAsync() : Promise
- deleteStreamingDistribution() : Result
- deleteStreamingDistributionAsync() : Promise
- describeFunction() : Result
- describeFunctionAsync() : Promise
- describeKeyValueStore() : Result
- describeKeyValueStoreAsync() : 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.
- getCachePolicy() : Result
- getCachePolicyAsync() : Promise
- getCachePolicyConfig() : Result
- getCachePolicyConfigAsync() : 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.
- getCloudFrontOriginAccessIdentity() : Result
- getCloudFrontOriginAccessIdentityAsync() : Promise
- getCloudFrontOriginAccessIdentityConfig() : Result
- getCloudFrontOriginAccessIdentityConfigAsync() : Promise
- getCommand() : CommandInterface
- getConfig() : mixed|null
- Get a client configuration value.
- getContinuousDeploymentPolicy() : Result
- getContinuousDeploymentPolicyAsync() : Promise
- getContinuousDeploymentPolicyConfig() : Result
- getContinuousDeploymentPolicyConfigAsync() : Promise
- getCredentials() : PromiseInterface
- Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
- getDistribution() : Result
- getDistributionAsync() : Promise
- getDistributionConfig() : Result
- getDistributionConfigAsync() : 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.
- getFieldLevelEncryption() : Result
- getFieldLevelEncryptionAsync() : Promise
- getFieldLevelEncryptionConfig() : Result
- getFieldLevelEncryptionConfigAsync() : Promise
- getFieldLevelEncryptionProfile() : Result
- getFieldLevelEncryptionProfileAsync() : Promise
- getFieldLevelEncryptionProfileConfig() : Result
- getFieldLevelEncryptionProfileConfigAsync() : Promise
- getFunction() : Result
- getFunctionAsync() : Promise
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getInvalidation() : Result
- getInvalidationAsync() : Promise
- getIterator() : mixed
- getKeyGroup() : Result
- getKeyGroupAsync() : Promise
- getKeyGroupConfig() : Result
- getKeyGroupConfigAsync() : Promise
- getMonitoringSubscription() : Result
- getMonitoringSubscriptionAsync() : Promise
- getOriginAccessControl() : Result
- getOriginAccessControlAsync() : Promise
- getOriginAccessControlConfig() : Result
- getOriginAccessControlConfigAsync() : Promise
- getOriginRequestPolicy() : Result
- getOriginRequestPolicyAsync() : Promise
- getOriginRequestPolicyConfig() : Result
- getOriginRequestPolicyConfigAsync() : Promise
- getPaginator() : mixed
- getPublicKey() : Result
- getPublicKeyAsync() : Promise
- getPublicKeyConfig() : Result
- getPublicKeyConfigAsync() : Promise
- getRealtimeLogConfig() : Result
- getRealtimeLogConfigAsync() : Promise
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getResponseHeadersPolicy() : Result
- getResponseHeadersPolicyAsync() : Promise
- getResponseHeadersPolicyConfig() : Result
- getResponseHeadersPolicyConfigAsync() : Promise
- 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() : Result
- getStreamingDistributionAsync() : Promise
- getStreamingDistributionConfig() : Result
- getStreamingDistributionConfigAsync() : Promise
- getWaiter() : mixed
- listCachePolicies() : Result
- listCachePoliciesAsync() : Promise
- listCloudFrontOriginAccessIdentities() : Result
- listCloudFrontOriginAccessIdentitiesAsync() : Promise
- listConflictingAliases() : Result
- listConflictingAliasesAsync() : Promise
- listContinuousDeploymentPolicies() : Result
- listContinuousDeploymentPoliciesAsync() : Promise
- listDistributions() : Result
- listDistributionsAsync() : Promise
- listDistributionsByCachePolicyId() : Result
- listDistributionsByCachePolicyIdAsync() : Promise
- listDistributionsByKeyGroup() : Result
- listDistributionsByKeyGroupAsync() : Promise
- listDistributionsByOriginRequestPolicyId() : Result
- listDistributionsByOriginRequestPolicyIdAsync() : Promise
- listDistributionsByRealtimeLogConfig() : Result
- listDistributionsByRealtimeLogConfigAsync() : Promise
- listDistributionsByResponseHeadersPolicyId() : Result
- listDistributionsByResponseHeadersPolicyIdAsync() : Promise
- listDistributionsByWebACLId() : Result
- listDistributionsByWebACLIdAsync() : Promise
- listFieldLevelEncryptionConfigs() : Result
- listFieldLevelEncryptionConfigsAsync() : Promise
- listFieldLevelEncryptionProfiles() : Result
- listFieldLevelEncryptionProfilesAsync() : Promise
- listFunctions() : Result
- listFunctionsAsync() : Promise
- listInvalidations() : Result
- listInvalidationsAsync() : Promise
- listKeyGroups() : Result
- listKeyGroupsAsync() : Promise
- listKeyValueStores() : Result
- listKeyValueStoresAsync() : Promise
- listOriginAccessControls() : Result
- listOriginAccessControlsAsync() : Promise
- listOriginRequestPolicies() : Result
- listOriginRequestPoliciesAsync() : Promise
- listPublicKeys() : Result
- listPublicKeysAsync() : Promise
- listRealtimeLogConfigs() : Result
- listRealtimeLogConfigsAsync() : Promise
- listResponseHeadersPolicies() : Result
- listResponseHeadersPoliciesAsync() : Promise
- listStreamingDistributions() : Result
- listStreamingDistributionsAsync() : Promise
- listTagsForResource() : Result
- listTagsForResourceAsync() : Promise
- publishFunction() : Result
- publishFunctionAsync() : Promise
- tagResource() : Result
- tagResourceAsync() : Promise
- testFunction() : Result
- testFunctionAsync() : Promise
- untagResource() : Result
- untagResourceAsync() : Promise
- updateCachePolicy() : Result
- updateCachePolicyAsync() : Promise
- updateCloudFrontOriginAccessIdentity() : Result
- updateCloudFrontOriginAccessIdentityAsync() : Promise
- updateContinuousDeploymentPolicy() : Result
- updateContinuousDeploymentPolicyAsync() : Promise
- updateDistribution() : Result
- updateDistributionAsync() : Promise
- updateDistributionWithStagingConfig() : Result
- updateDistributionWithStagingConfigAsync() : Promise
- updateFieldLevelEncryptionConfig() : Result
- updateFieldLevelEncryptionConfigAsync() : Promise
- updateFieldLevelEncryptionProfile() : Result
- updateFieldLevelEncryptionProfileAsync() : Promise
- updateFunction() : Result
- updateFunctionAsync() : Promise
- updateKeyGroup() : Result
- updateKeyGroupAsync() : Promise
- updateKeyValueStore() : Result
- updateKeyValueStoreAsync() : Promise
- updateOriginAccessControl() : Result
- updateOriginAccessControlAsync() : Promise
- updateOriginRequestPolicy() : Result
- updateOriginRequestPolicyAsync() : Promise
- updatePublicKey() : Result
- updatePublicKeyAsync() : Promise
- updateRealtimeLogConfig() : Result
- updateRealtimeLogConfigAsync() : Promise
- updateResponseHeadersPolicy() : Result
- updateResponseHeadersPolicyAsync() : Promise
- updateStreamingDistribution() : Result
- updateStreamingDistributionAsync() : 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
associateAlias()
public
associateAlias(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultassociateAliasAsync()
public
associateAliasAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecopyDistribution()
public
copyDistribution(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcopyDistributionAsync()
public
copyDistributionAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateCachePolicy()
public
createCachePolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateCachePolicyAsync()
public
createCachePolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateCloudFrontOriginAccessIdentity()
public
createCloudFrontOriginAccessIdentity(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateCloudFrontOriginAccessIdentityAsync()
public
createCloudFrontOriginAccessIdentityAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateContinuousDeploymentPolicy()
public
createContinuousDeploymentPolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateContinuousDeploymentPolicyAsync()
public
createContinuousDeploymentPolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateDistribution()
public
createDistribution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateDistributionAsync()
public
createDistributionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateDistributionWithTags()
public
createDistributionWithTags(array<string|int, mixed> $args = []) : Result
(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
ResultcreateDistributionWithTagsAsync()
public
createDistributionWithTagsAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisecreateFieldLevelEncryptionConfig()
public
createFieldLevelEncryptionConfig(array<string|int, mixed> $args = []) : Result
(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
ResultcreateFieldLevelEncryptionConfigAsync()
public
createFieldLevelEncryptionConfigAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisecreateFieldLevelEncryptionProfile()
public
createFieldLevelEncryptionProfile(array<string|int, mixed> $args = []) : Result
(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
ResultcreateFieldLevelEncryptionProfileAsync()
public
createFieldLevelEncryptionProfileAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisecreateFunction()
public
createFunction(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateFunctionAsync()
public
createFunctionAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateInvalidation()
public
createInvalidation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateInvalidationAsync()
public
createInvalidationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateKeyGroup()
public
createKeyGroup(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateKeyGroupAsync()
public
createKeyGroupAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateKeyValueStore()
public
createKeyValueStore(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateKeyValueStoreAsync()
public
createKeyValueStoreAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateMonitoringSubscription()
public
createMonitoringSubscription(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateMonitoringSubscriptionAsync()
public
createMonitoringSubscriptionAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateOriginAccessControl()
public
createOriginAccessControl(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateOriginAccessControlAsync()
public
createOriginAccessControlAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateOriginRequestPolicy()
public
createOriginRequestPolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateOriginRequestPolicyAsync()
public
createOriginRequestPolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreatePublicKey()
public
createPublicKey(array<string|int, mixed> $args = []) : Result
(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
ResultcreatePublicKeyAsync()
public
createPublicKeyAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisecreateRealtimeLogConfig()
public
createRealtimeLogConfig(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateRealtimeLogConfigAsync()
public
createRealtimeLogConfigAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateResponseHeadersPolicy()
public
createResponseHeadersPolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateResponseHeadersPolicyAsync()
public
createResponseHeadersPolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateStreamingDistribution()
public
createStreamingDistribution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateStreamingDistributionAsync()
public
createStreamingDistributionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateStreamingDistributionWithTags()
public
createStreamingDistributionWithTags(array<string|int, mixed> $args = []) : Result
(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
ResultcreateStreamingDistributionWithTagsAsync()
public
createStreamingDistributionWithTagsAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisedeleteCachePolicy()
public
deleteCachePolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteCachePolicyAsync()
public
deleteCachePolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteCloudFrontOriginAccessIdentity()
public
deleteCloudFrontOriginAccessIdentity(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteCloudFrontOriginAccessIdentityAsync()
public
deleteCloudFrontOriginAccessIdentityAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteContinuousDeploymentPolicy()
public
deleteContinuousDeploymentPolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteContinuousDeploymentPolicyAsync()
public
deleteContinuousDeploymentPolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteDistribution()
public
deleteDistribution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteDistributionAsync()
public
deleteDistributionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteFieldLevelEncryptionConfig()
public
deleteFieldLevelEncryptionConfig(array<string|int, mixed> $args = []) : Result
(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
ResultdeleteFieldLevelEncryptionConfigAsync()
public
deleteFieldLevelEncryptionConfigAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisedeleteFieldLevelEncryptionProfile()
public
deleteFieldLevelEncryptionProfile(array<string|int, mixed> $args = []) : Result
(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
ResultdeleteFieldLevelEncryptionProfileAsync()
public
deleteFieldLevelEncryptionProfileAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisedeleteFunction()
public
deleteFunction(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteFunctionAsync()
public
deleteFunctionAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteKeyGroup()
public
deleteKeyGroup(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteKeyGroupAsync()
public
deleteKeyGroupAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteKeyValueStore()
public
deleteKeyValueStore(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteKeyValueStoreAsync()
public
deleteKeyValueStoreAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteMonitoringSubscription()
public
deleteMonitoringSubscription(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteMonitoringSubscriptionAsync()
public
deleteMonitoringSubscriptionAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteOriginAccessControl()
public
deleteOriginAccessControl(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteOriginAccessControlAsync()
public
deleteOriginAccessControlAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteOriginRequestPolicy()
public
deleteOriginRequestPolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteOriginRequestPolicyAsync()
public
deleteOriginRequestPolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeletePublicKey()
public
deletePublicKey(array<string|int, mixed> $args = []) : Result
(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
ResultdeletePublicKeyAsync()
public
deletePublicKeyAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisedeleteRealtimeLogConfig()
public
deleteRealtimeLogConfig(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteRealtimeLogConfigAsync()
public
deleteRealtimeLogConfigAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteResponseHeadersPolicy()
public
deleteResponseHeadersPolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteResponseHeadersPolicyAsync()
public
deleteResponseHeadersPolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteServiceLinkedRole()
public
deleteServiceLinkedRole(array<string|int, mixed> $args = []) : Result
(supported in versions 2017-03-25)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteServiceLinkedRoleAsync()
public
deleteServiceLinkedRoleAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2017-03-25)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteStreamingDistribution()
public
deleteStreamingDistribution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteStreamingDistributionAsync()
public
deleteStreamingDistributionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeFunction()
public
describeFunction(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeFunctionAsync()
public
describeFunctionAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeKeyValueStore()
public
describeKeyValueStore(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeKeyValueStoreAsync()
public
describeKeyValueStoreAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
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>getCachePolicy()
public
getCachePolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCachePolicyAsync()
public
getCachePolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCachePolicyConfig()
public
getCachePolicyConfig(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCachePolicyConfigAsync()
public
getCachePolicyConfigAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
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>getCloudFrontOriginAccessIdentity()
public
getCloudFrontOriginAccessIdentity(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCloudFrontOriginAccessIdentityAsync()
public
getCloudFrontOriginAccessIdentityAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCloudFrontOriginAccessIdentityConfig()
public
getCloudFrontOriginAccessIdentityConfig(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCloudFrontOriginAccessIdentityConfigAsync()
public
getCloudFrontOriginAccessIdentityConfigAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCommand()
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|nullgetContinuousDeploymentPolicy()
public
getContinuousDeploymentPolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetContinuousDeploymentPolicyAsync()
public
getContinuousDeploymentPolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetContinuousDeploymentPolicyConfig()
public
getContinuousDeploymentPolicyConfig(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetContinuousDeploymentPolicyConfigAsync()
public
getContinuousDeploymentPolicyConfigAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCredentials()
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
PromiseInterfacegetDistribution()
public
getDistribution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDistributionAsync()
public
getDistributionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetDistributionConfig()
public
getDistributionConfig(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDistributionConfigAsync()
public
getDistributionConfigAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetEndpoint()
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>getFieldLevelEncryption()
public
getFieldLevelEncryption(array<string|int, mixed> $args = []) : Result
(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
ResultgetFieldLevelEncryptionAsync()
public
getFieldLevelEncryptionAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisegetFieldLevelEncryptionConfig()
public
getFieldLevelEncryptionConfig(array<string|int, mixed> $args = []) : Result
(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
ResultgetFieldLevelEncryptionConfigAsync()
public
getFieldLevelEncryptionConfigAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisegetFieldLevelEncryptionProfile()
public
getFieldLevelEncryptionProfile(array<string|int, mixed> $args = []) : Result
(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
ResultgetFieldLevelEncryptionProfileAsync()
public
getFieldLevelEncryptionProfileAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisegetFieldLevelEncryptionProfileConfig()
public
getFieldLevelEncryptionProfileConfig(array<string|int, mixed> $args = []) : Result
(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
ResultgetFieldLevelEncryptionProfileConfigAsync()
public
getFieldLevelEncryptionProfileConfigAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisegetFunction()
public
getFunction(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetFunctionAsync()
public
getFunctionAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
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
HandlerListgetInvalidation()
public
getInvalidation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetInvalidationAsync()
public
getInvalidationAsync(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> = []
getKeyGroup()
public
getKeyGroup(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetKeyGroupAsync()
public
getKeyGroupAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetKeyGroupConfig()
public
getKeyGroupConfig(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetKeyGroupConfigAsync()
public
getKeyGroupConfigAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetMonitoringSubscription()
public
getMonitoringSubscription(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetMonitoringSubscriptionAsync()
public
getMonitoringSubscriptionAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetOriginAccessControl()
public
getOriginAccessControl(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetOriginAccessControlAsync()
public
getOriginAccessControlAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetOriginAccessControlConfig()
public
getOriginAccessControlConfig(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetOriginAccessControlConfigAsync()
public
getOriginAccessControlConfigAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetOriginRequestPolicy()
public
getOriginRequestPolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetOriginRequestPolicyAsync()
public
getOriginRequestPolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetOriginRequestPolicyConfig()
public
getOriginRequestPolicyConfig(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetOriginRequestPolicyConfigAsync()
public
getOriginRequestPolicyConfigAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
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> = []
getPublicKey()
public
getPublicKey(array<string|int, mixed> $args = []) : Result
(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
ResultgetPublicKeyAsync()
public
getPublicKeyAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisegetPublicKeyConfig()
public
getPublicKeyConfig(array<string|int, mixed> $args = []) : Result
(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
ResultgetPublicKeyConfigAsync()
public
getPublicKeyConfigAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisegetRealtimeLogConfig()
public
getRealtimeLogConfig(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetRealtimeLogConfigAsync()
public
getRealtimeLogConfigAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
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
stringgetResponseHeadersPolicy()
public
getResponseHeadersPolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetResponseHeadersPolicyAsync()
public
getResponseHeadersPolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetResponseHeadersPolicyConfig()
public
getResponseHeadersPolicyConfig(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetResponseHeadersPolicyConfigAsync()
public
getResponseHeadersPolicyConfigAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callablegetSignedCookie()
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
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 to 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
Return values
string —Signed URL with authentication parameters
getStreamingDistribution()
public
getStreamingDistribution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetStreamingDistributionAsync()
public
getStreamingDistributionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetStreamingDistributionConfig()
public
getStreamingDistributionConfig(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetStreamingDistributionConfigAsync()
public
getStreamingDistributionConfigAsync(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> = []
listCachePolicies()
public
listCachePolicies(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistCachePoliciesAsync()
public
listCachePoliciesAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistCloudFrontOriginAccessIdentities()
public
listCloudFrontOriginAccessIdentities(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistCloudFrontOriginAccessIdentitiesAsync()
public
listCloudFrontOriginAccessIdentitiesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistConflictingAliases()
public
listConflictingAliases(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistConflictingAliasesAsync()
public
listConflictingAliasesAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistContinuousDeploymentPolicies()
public
listContinuousDeploymentPolicies(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistContinuousDeploymentPoliciesAsync()
public
listContinuousDeploymentPoliciesAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDistributions()
public
listDistributions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDistributionsAsync()
public
listDistributionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDistributionsByCachePolicyId()
public
listDistributionsByCachePolicyId(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDistributionsByCachePolicyIdAsync()
public
listDistributionsByCachePolicyIdAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDistributionsByKeyGroup()
public
listDistributionsByKeyGroup(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDistributionsByKeyGroupAsync()
public
listDistributionsByKeyGroupAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDistributionsByOriginRequestPolicyId()
public
listDistributionsByOriginRequestPolicyId(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDistributionsByOriginRequestPolicyIdAsync()
public
listDistributionsByOriginRequestPolicyIdAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDistributionsByRealtimeLogConfig()
public
listDistributionsByRealtimeLogConfig(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDistributionsByRealtimeLogConfigAsync()
public
listDistributionsByRealtimeLogConfigAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDistributionsByResponseHeadersPolicyId()
public
listDistributionsByResponseHeadersPolicyId(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDistributionsByResponseHeadersPolicyIdAsync()
public
listDistributionsByResponseHeadersPolicyIdAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistDistributionsByWebACLId()
public
listDistributionsByWebACLId(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistDistributionsByWebACLIdAsync()
public
listDistributionsByWebACLIdAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistFieldLevelEncryptionConfigs()
public
listFieldLevelEncryptionConfigs(array<string|int, mixed> $args = []) : Result
(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
ResultlistFieldLevelEncryptionConfigsAsync()
public
listFieldLevelEncryptionConfigsAsync(array<string|int, mixed> $args = []) : Promise
(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
PromiselistFieldLevelEncryptionProfiles()
public
listFieldLevelEncryptionProfiles(array<string|int, mixed> $args = []) : Result
(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
ResultlistFieldLevelEncryptionProfilesAsync()
public
listFieldLevelEncryptionProfilesAsync(array<string|int, mixed> $args = []) : Promise
(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
PromiselistFunctions()
public
listFunctions(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistFunctionsAsync()
public
listFunctionsAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistInvalidations()
public
listInvalidations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistInvalidationsAsync()
public
listInvalidationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistKeyGroups()
public
listKeyGroups(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistKeyGroupsAsync()
public
listKeyGroupsAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistKeyValueStores()
public
listKeyValueStores(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistKeyValueStoresAsync()
public
listKeyValueStoresAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistOriginAccessControls()
public
listOriginAccessControls(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistOriginAccessControlsAsync()
public
listOriginAccessControlsAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistOriginRequestPolicies()
public
listOriginRequestPolicies(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistOriginRequestPoliciesAsync()
public
listOriginRequestPoliciesAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistPublicKeys()
public
listPublicKeys(array<string|int, mixed> $args = []) : Result
(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
ResultlistPublicKeysAsync()
public
listPublicKeysAsync(array<string|int, mixed> $args = []) : Promise
(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
PromiselistRealtimeLogConfigs()
public
listRealtimeLogConfigs(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistRealtimeLogConfigsAsync()
public
listRealtimeLogConfigsAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistResponseHeadersPolicies()
public
listResponseHeadersPolicies(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistResponseHeadersPoliciesAsync()
public
listResponseHeadersPoliciesAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistStreamingDistributions()
public
listStreamingDistributions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistStreamingDistributionsAsync()
public
listStreamingDistributionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) : Result
(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
ResultlistTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisepublishFunction()
public
publishFunction(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultpublishFunctionAsync()
public
publishFunctionAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetagResource()
public
tagResource(array<string|int, mixed> $args = []) : Result
(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
ResulttagResourceAsync()
public
tagResourceAsync(array<string|int, mixed> $args = []) : Promise
(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
PromisetestFunction()
public
testFunction(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttestFunctionAsync()
public
testFunctionAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseuntagResource()
public
untagResource(array<string|int, mixed> $args = []) : Result
(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
ResultuntagResourceAsync()
public
untagResourceAsync(array<string|int, mixed> $args = []) : Promise
(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
PromiseupdateCachePolicy()
public
updateCachePolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateCachePolicyAsync()
public
updateCachePolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateCloudFrontOriginAccessIdentity()
public
updateCloudFrontOriginAccessIdentity(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateCloudFrontOriginAccessIdentityAsync()
public
updateCloudFrontOriginAccessIdentityAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateContinuousDeploymentPolicy()
public
updateContinuousDeploymentPolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateContinuousDeploymentPolicyAsync()
public
updateContinuousDeploymentPolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateDistribution()
public
updateDistribution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateDistributionAsync()
public
updateDistributionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateDistributionWithStagingConfig()
public
updateDistributionWithStagingConfig(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateDistributionWithStagingConfigAsync()
public
updateDistributionWithStagingConfigAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateFieldLevelEncryptionConfig()
public
updateFieldLevelEncryptionConfig(array<string|int, mixed> $args = []) : Result
(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
ResultupdateFieldLevelEncryptionConfigAsync()
public
updateFieldLevelEncryptionConfigAsync(array<string|int, mixed> $args = []) : Promise
(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
PromiseupdateFieldLevelEncryptionProfile()
public
updateFieldLevelEncryptionProfile(array<string|int, mixed> $args = []) : Result
(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
ResultupdateFieldLevelEncryptionProfileAsync()
public
updateFieldLevelEncryptionProfileAsync(array<string|int, mixed> $args = []) : Promise
(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
PromiseupdateFunction()
public
updateFunction(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateFunctionAsync()
public
updateFunctionAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateKeyGroup()
public
updateKeyGroup(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateKeyGroupAsync()
public
updateKeyGroupAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateKeyValueStore()
public
updateKeyValueStore(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateKeyValueStoreAsync()
public
updateKeyValueStoreAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateOriginAccessControl()
public
updateOriginAccessControl(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateOriginAccessControlAsync()
public
updateOriginAccessControlAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateOriginRequestPolicy()
public
updateOriginRequestPolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateOriginRequestPolicyAsync()
public
updateOriginRequestPolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdatePublicKey()
public
updatePublicKey(array<string|int, mixed> $args = []) : Result
(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
ResultupdatePublicKeyAsync()
public
updatePublicKeyAsync(array<string|int, mixed> $args = []) : Promise
(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
PromiseupdateRealtimeLogConfig()
public
updateRealtimeLogConfig(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateRealtimeLogConfigAsync()
public
updateRealtimeLogConfigAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateResponseHeadersPolicy()
public
updateResponseHeadersPolicy(array<string|int, mixed> $args = []) : Result
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateResponseHeadersPolicyAsync()
public
updateResponseHeadersPolicyAsync(array<string|int, mixed> $args = []) : Promise
(supported in versions 2020-05-31)
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateStreamingDistribution()
public
updateStreamingDistribution(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateStreamingDistributionAsync()
public
updateStreamingDistributionAsync(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> = []