Route53Client
extends AwsClient
in package
This client is used to interact with the **Amazon Route 53** 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
- activateKeySigningKey() :
- activateKeySigningKeyAsync() :
- associateVPCWithHostedZone() :
- associateVPCWithHostedZoneAsync() :
- changeResourceRecordSets() :
- changeResourceRecordSetsAsync() :
- changeTagsForResource() :
- changeTagsForResourceAsync() :
- createHealthCheck() :
- createHealthCheckAsync() :
- createHostedZone() :
- createHostedZoneAsync() :
- createKeySigningKey() :
- createKeySigningKeyAsync() :
- createQueryLoggingConfig() :
- createQueryLoggingConfigAsync() :
- createReusableDelegationSet() :
- createReusableDelegationSetAsync() :
- createTrafficPolicy() :
- createTrafficPolicyAsync() :
- createTrafficPolicyInstance() :
- createTrafficPolicyInstanceAsync() :
- createTrafficPolicyVersion() :
- createTrafficPolicyVersionAsync() :
- createVPCAssociationAuthorization() :
- createVPCAssociationAuthorizationAsync() :
- deactivateKeySigningKey() :
- deactivateKeySigningKeyAsync() :
- deleteHealthCheck() :
- deleteHealthCheckAsync() :
- deleteHostedZone() :
- deleteHostedZoneAsync() :
- deleteKeySigningKey() :
- deleteKeySigningKeyAsync() :
- deleteQueryLoggingConfig() :
- deleteQueryLoggingConfigAsync() :
- deleteReusableDelegationSet() :
- deleteReusableDelegationSetAsync() :
- deleteTrafficPolicy() :
- deleteTrafficPolicyAsync() :
- deleteTrafficPolicyInstance() :
- deleteTrafficPolicyInstanceAsync() :
- deleteVPCAssociationAuthorization() :
- deleteVPCAssociationAuthorizationAsync() :
- disableHostedZoneDNSSEC() :
- disableHostedZoneDNSSECAsync() :
- disassociateVPCFromHostedZone() :
- disassociateVPCFromHostedZoneAsync() :
- enableHostedZoneDNSSEC() :
- enableHostedZoneDNSSECAsync() :
- execute() : mixed
- executeAsync() : mixed
- factory() : static
- getAccountLimit() :
- getAccountLimitAsync() :
- getApi() : Service
- getArguments() : array<string|int, mixed>
- Get an array of client constructor arguments used by the client.
- getChange() :
- getChangeAsync() :
- getCheckerIpRanges() :
- getCheckerIpRangesAsync() :
- 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.
- getDNSSEC() :
- getDNSSECAsync() :
- getEndpoint() : UriInterface
- Gets the default endpoint, or base URL, used by the client.
- getGeoLocation() :
- getGeoLocationAsync() :
- getHandlerList() : HandlerList
- Get the handler list used to transfer commands.
- getHealthCheck() :
- getHealthCheckAsync() :
- getHealthCheckCount() :
- getHealthCheckCountAsync() :
- getHealthCheckLastFailureReason() :
- getHealthCheckLastFailureReasonAsync() :
- getHealthCheckStatus() :
- getHealthCheckStatusAsync() :
- getHostedZone() :
- getHostedZoneAsync() :
- getHostedZoneCount() :
- getHostedZoneCountAsync() :
- getHostedZoneLimit() :
- getHostedZoneLimitAsync() :
- getIterator() : mixed
- getPaginator() : mixed
- getQueryLoggingConfig() :
- getQueryLoggingConfigAsync() :
- getRegion() : string
- Get the region to which the client is configured to send requests.
- getReusableDelegationSet() :
- getReusableDelegationSetAsync() :
- getReusableDelegationSetLimit() :
- getReusableDelegationSetLimitAsync() :
- getSignatureProvider() : callable
- Get the signature_provider function of the client.
- getTrafficPolicy() :
- getTrafficPolicyAsync() :
- getTrafficPolicyInstance() :
- getTrafficPolicyInstanceAsync() :
- getTrafficPolicyInstanceCount() :
- getTrafficPolicyInstanceCountAsync() :
- getWaiter() : mixed
- listGeoLocations() :
- listGeoLocationsAsync() :
- listHealthChecks() :
- listHealthChecksAsync() :
- listHostedZones() :
- listHostedZonesAsync() :
- listHostedZonesByName() :
- listHostedZonesByNameAsync() :
- listHostedZonesByVPC() :
- listHostedZonesByVPCAsync() :
- listQueryLoggingConfigs() :
- listQueryLoggingConfigsAsync() :
- listResourceRecordSets() :
- listResourceRecordSetsAsync() :
- listReusableDelegationSets() :
- listReusableDelegationSetsAsync() :
- listTagsForResource() :
- listTagsForResourceAsync() :
- listTagsForResources() :
- listTagsForResourcesAsync() :
- listTrafficPolicies() :
- listTrafficPoliciesAsync() :
- listTrafficPolicyInstances() :
- listTrafficPolicyInstancesAsync() :
- listTrafficPolicyInstancesByHostedZone() :
- listTrafficPolicyInstancesByHostedZoneAsync() :
- listTrafficPolicyInstancesByPolicy() :
- listTrafficPolicyInstancesByPolicyAsync() :
- listTrafficPolicyVersions() :
- listTrafficPolicyVersionsAsync() :
- listVPCAssociationAuthorizations() :
- listVPCAssociationAuthorizationsAsync() :
- testDNSAnswer() :
- testDNSAnswerAsync() :
- updateHealthCheck() :
- updateHealthCheckAsync() :
- updateHostedZoneComment() :
- updateHostedZoneCommentAsync() :
- updateTrafficPolicyComment() :
- updateTrafficPolicyCommentAsync() :
- updateTrafficPolicyInstance() :
- updateTrafficPolicyInstanceAsync() :
- waitUntil() : mixed
- addEndpointDiscoveryMiddleware() : mixed
- addEndpointParameterMiddleware() : mixed
- addInvocationId() : mixed
- addSignatureMiddleware() : mixed
- addStreamRequestPayload() : mixed
- cleanId() : mixed
- cleanIdFn() : 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
$api
private
Service
$api
$config
private
array<string|int, mixed>
$config
$credentialProvider
private
callable
$credentialProvider
$defaultRequestOptions
private
array<string|int, mixed>
$defaultRequestOptions
$endpoint
private
string
$endpoint
$handlerList
private
HandlerList
$handlerList
$region
private
string
$region
$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,
falseto 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,
falseto 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_receiveroption 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
schemeto "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.
Return values
mixed —__sleep()
public
__sleep() : mixed
Return values
mixed —activateKeySigningKey()
public
activateKeySigningKey(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—activateKeySigningKeyAsync()
public
activateKeySigningKeyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateVPCWithHostedZone()
public
associateVPCWithHostedZone(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—associateVPCWithHostedZoneAsync()
public
associateVPCWithHostedZoneAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—changeResourceRecordSets()
public
changeResourceRecordSets(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—changeResourceRecordSetsAsync()
public
changeResourceRecordSetsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—changeTagsForResource()
public
changeTagsForResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—changeTagsForResourceAsync()
public
changeTagsForResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createHealthCheck()
public
createHealthCheck(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createHealthCheckAsync()
public
createHealthCheckAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createHostedZone()
public
createHostedZone(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createHostedZoneAsync()
public
createHostedZoneAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createKeySigningKey()
public
createKeySigningKey(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createKeySigningKeyAsync()
public
createKeySigningKeyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createQueryLoggingConfig()
public
createQueryLoggingConfig(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createQueryLoggingConfigAsync()
public
createQueryLoggingConfigAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createReusableDelegationSet()
public
createReusableDelegationSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createReusableDelegationSetAsync()
public
createReusableDelegationSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createTrafficPolicy()
public
createTrafficPolicy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createTrafficPolicyAsync()
public
createTrafficPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createTrafficPolicyInstance()
public
createTrafficPolicyInstance(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createTrafficPolicyInstanceAsync()
public
createTrafficPolicyInstanceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createTrafficPolicyVersion()
public
createTrafficPolicyVersion(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createTrafficPolicyVersionAsync()
public
createTrafficPolicyVersionAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createVPCAssociationAuthorization()
public
createVPCAssociationAuthorization(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—createVPCAssociationAuthorizationAsync()
public
createVPCAssociationAuthorizationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deactivateKeySigningKey()
public
deactivateKeySigningKey(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deactivateKeySigningKeyAsync()
public
deactivateKeySigningKeyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteHealthCheck()
public
deleteHealthCheck(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteHealthCheckAsync()
public
deleteHealthCheckAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteHostedZone()
public
deleteHostedZone(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteHostedZoneAsync()
public
deleteHostedZoneAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteKeySigningKey()
public
deleteKeySigningKey(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteKeySigningKeyAsync()
public
deleteKeySigningKeyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteQueryLoggingConfig()
public
deleteQueryLoggingConfig(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteQueryLoggingConfigAsync()
public
deleteQueryLoggingConfigAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteReusableDelegationSet()
public
deleteReusableDelegationSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteReusableDelegationSetAsync()
public
deleteReusableDelegationSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteTrafficPolicy()
public
deleteTrafficPolicy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteTrafficPolicyAsync()
public
deleteTrafficPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteTrafficPolicyInstance()
public
deleteTrafficPolicyInstance(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteTrafficPolicyInstanceAsync()
public
deleteTrafficPolicyInstanceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteVPCAssociationAuthorization()
public
deleteVPCAssociationAuthorization(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—deleteVPCAssociationAuthorizationAsync()
public
deleteVPCAssociationAuthorizationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disableHostedZoneDNSSEC()
public
disableHostedZoneDNSSEC(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disableHostedZoneDNSSECAsync()
public
disableHostedZoneDNSSECAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateVPCFromHostedZone()
public
disassociateVPCFromHostedZone(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—disassociateVPCFromHostedZoneAsync()
public
disassociateVPCFromHostedZoneAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—enableHostedZoneDNSSEC()
public
enableHostedZoneDNSSEC(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—enableHostedZoneDNSSECAsync()
public
enableHostedZoneDNSSECAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
Return values
mixed —factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
static —getAccountLimit()
public
getAccountLimit(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getAccountLimitAsync()
public
getAccountLimitAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getApi()
public
abstract getApi() : Service
Return values
Service —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> —getChange()
public
getChange(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getChangeAsync()
public
getChangeAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getCheckerIpRanges()
public
getCheckerIpRanges(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getCheckerIpRangesAsync()
public
getCheckerIpRangesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getCommand()
public
abstract getCommand(string $name[, array<string|int, mixed> $args = [] ]) : CommandInterface
Parameters
- $name : string
- $args : array<string|int, mixed> = []
Return values
CommandInterface —getConfig()
Get a client configuration value.
public
getConfig([mixed $option = null ]) : mixed|null
Parameters
- $option : mixed = null
-
The option to retrieve. Pass null to retrieve all options.
Return values
mixed|null —getCredentials()
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
public
getCredentials() : PromiseInterface
If you need the credentials synchronously, then call the wait() method on the returned promise.
Return values
PromiseInterface —getDNSSEC()
public
getDNSSEC(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getDNSSECAsync()
public
getDNSSECAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterface —getGeoLocation()
public
getGeoLocation(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getGeoLocationAsync()
public
getGeoLocationAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHandlerList()
Get the handler list used to transfer commands.
public
getHandlerList() : HandlerList
This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.
Return values
HandlerList —getHealthCheck()
public
getHealthCheck(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHealthCheckAsync()
public
getHealthCheckAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHealthCheckCount()
public
getHealthCheckCount(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHealthCheckCountAsync()
public
getHealthCheckCountAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHealthCheckLastFailureReason()
public
getHealthCheckLastFailureReason(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHealthCheckLastFailureReasonAsync()
public
getHealthCheckLastFailureReasonAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHealthCheckStatus()
public
getHealthCheckStatus(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHealthCheckStatusAsync()
public
getHealthCheckStatusAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHostedZone()
public
getHostedZone(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHostedZoneAsync()
public
getHostedZoneAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHostedZoneCount()
public
getHostedZoneCount(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHostedZoneCountAsync()
public
getHostedZoneCountAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHostedZoneLimit()
public
getHostedZoneLimit(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getHostedZoneLimitAsync()
public
getHostedZoneLimitAsync(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 —getPaginator()
public
getPaginator(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []
Return values
mixed —getQueryLoggingConfig()
public
getQueryLoggingConfig(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getQueryLoggingConfigAsync()
public
getQueryLoggingConfigAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getRegion()
Get the region to which the client is configured to send requests.
public
getRegion() : string
Return values
string —getReusableDelegationSet()
public
getReusableDelegationSet(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getReusableDelegationSetAsync()
public
getReusableDelegationSetAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getReusableDelegationSetLimit()
public
getReusableDelegationSetLimit(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getReusableDelegationSetLimitAsync()
public
getReusableDelegationSetLimitAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callable —getTrafficPolicy()
public
getTrafficPolicy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getTrafficPolicyAsync()
public
getTrafficPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getTrafficPolicyInstance()
public
getTrafficPolicyInstance(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getTrafficPolicyInstanceAsync()
public
getTrafficPolicyInstanceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getTrafficPolicyInstanceCount()
public
getTrafficPolicyInstanceCount(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—getTrafficPolicyInstanceCountAsync()
public
getTrafficPolicyInstanceCountAsync(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 —listGeoLocations()
public
listGeoLocations(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listGeoLocationsAsync()
public
listGeoLocationsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listHealthChecks()
public
listHealthChecks(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listHealthChecksAsync()
public
listHealthChecksAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listHostedZones()
public
listHostedZones(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listHostedZonesAsync()
public
listHostedZonesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listHostedZonesByName()
public
listHostedZonesByName(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listHostedZonesByNameAsync()
public
listHostedZonesByNameAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listHostedZonesByVPC()
public
listHostedZonesByVPC(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listHostedZonesByVPCAsync()
public
listHostedZonesByVPCAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listQueryLoggingConfigs()
public
listQueryLoggingConfigs(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listQueryLoggingConfigsAsync()
public
listQueryLoggingConfigsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listResourceRecordSets()
public
listResourceRecordSets(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listResourceRecordSetsAsync()
public
listResourceRecordSetsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listReusableDelegationSets()
public
listReusableDelegationSets(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listReusableDelegationSetsAsync()
public
listReusableDelegationSetsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTagsForResources()
public
listTagsForResources(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTagsForResourcesAsync()
public
listTagsForResourcesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTrafficPolicies()
public
listTrafficPolicies(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTrafficPoliciesAsync()
public
listTrafficPoliciesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTrafficPolicyInstances()
public
listTrafficPolicyInstances(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTrafficPolicyInstancesAsync()
public
listTrafficPolicyInstancesAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTrafficPolicyInstancesByHostedZone()
public
listTrafficPolicyInstancesByHostedZone(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTrafficPolicyInstancesByHostedZoneAsync()
public
listTrafficPolicyInstancesByHostedZoneAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTrafficPolicyInstancesByPolicy()
public
listTrafficPolicyInstancesByPolicy(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTrafficPolicyInstancesByPolicyAsync()
public
listTrafficPolicyInstancesByPolicyAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTrafficPolicyVersions()
public
listTrafficPolicyVersions(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listTrafficPolicyVersionsAsync()
public
listTrafficPolicyVersionsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listVPCAssociationAuthorizations()
public
listVPCAssociationAuthorizations(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—listVPCAssociationAuthorizationsAsync()
public
listVPCAssociationAuthorizationsAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—testDNSAnswer()
public
testDNSAnswer(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—testDNSAnswerAsync()
public
testDNSAnswerAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateHealthCheck()
public
updateHealthCheck(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateHealthCheckAsync()
public
updateHealthCheckAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateHostedZoneComment()
public
updateHostedZoneComment(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateHostedZoneCommentAsync()
public
updateHostedZoneCommentAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateTrafficPolicyComment()
public
updateTrafficPolicyComment(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateTrafficPolicyCommentAsync()
public
updateTrafficPolicyCommentAsync(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateTrafficPolicyInstance()
public
updateTrafficPolicyInstance(array<string|int, mixed> $args = []) :
Parameters
- $args = [] : array<string|int, mixed>
Return values
—updateTrafficPolicyInstanceAsync()
public
updateTrafficPolicyInstanceAsync(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 —cleanId()
private
cleanId(mixed $id) : mixed
Parameters
- $id : mixed
Return values
mixed —cleanIdFn()
private
cleanIdFn() : 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>