SDK for PHP 3.x

Route53Client extends AwsClient
in package

This client is used to interact with the Amazon Route 53 service.

Supported API Versions

This class uses a service description model that is associated at runtime based on the version option given when constructing the client. The version option will determine which API operations, waiters, and paginators are available for a client. Creating a command or a specific API operation can be done using magic methods (e.g., $client->commandName(/** parameters */), or using the $client->getCommand method of the client.

Table of Contents

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
activateKeySigningKey()  : Result
activateKeySigningKeyAsync()  : Promise
associateVPCWithHostedZone()  : Result
associateVPCWithHostedZoneAsync()  : Promise
changeCidrCollection()  : Result
changeCidrCollectionAsync()  : Promise
changeResourceRecordSets()  : Result
changeResourceRecordSetsAsync()  : Promise
changeTagsForResource()  : Result
changeTagsForResourceAsync()  : Promise
createCidrCollection()  : Result
createCidrCollectionAsync()  : Promise
createHealthCheck()  : Result
createHealthCheckAsync()  : Promise
createHostedZone()  : Result
createHostedZoneAsync()  : Promise
createKeySigningKey()  : Result
createKeySigningKeyAsync()  : Promise
createQueryLoggingConfig()  : Result
createQueryLoggingConfigAsync()  : Promise
createReusableDelegationSet()  : Result
createReusableDelegationSetAsync()  : Promise
createTrafficPolicy()  : Result
createTrafficPolicyAsync()  : Promise
createTrafficPolicyInstance()  : Result
createTrafficPolicyInstanceAsync()  : Promise
createTrafficPolicyVersion()  : Result
createTrafficPolicyVersionAsync()  : Promise
createVPCAssociationAuthorization()  : Result
createVPCAssociationAuthorizationAsync()  : Promise
deactivateKeySigningKey()  : Result
deactivateKeySigningKeyAsync()  : Promise
deleteCidrCollection()  : Result
deleteCidrCollectionAsync()  : Promise
deleteHealthCheck()  : Result
deleteHealthCheckAsync()  : Promise
deleteHostedZone()  : Result
deleteHostedZoneAsync()  : Promise
deleteKeySigningKey()  : Result
deleteKeySigningKeyAsync()  : Promise
deleteQueryLoggingConfig()  : Result
deleteQueryLoggingConfigAsync()  : Promise
deleteReusableDelegationSet()  : Result
deleteReusableDelegationSetAsync()  : Promise
deleteTrafficPolicy()  : Result
deleteTrafficPolicyAsync()  : Promise
deleteTrafficPolicyInstance()  : Result
deleteTrafficPolicyInstanceAsync()  : Promise
deleteVPCAssociationAuthorization()  : Result
deleteVPCAssociationAuthorizationAsync()  : Promise
disableHostedZoneDNSSEC()  : Result
disableHostedZoneDNSSECAsync()  : Promise
disassociateVPCFromHostedZone()  : Result
disassociateVPCFromHostedZoneAsync()  : Promise
emitDeprecationWarning()  : mixed
enableHostedZoneDNSSEC()  : Result
enableHostedZoneDNSSECAsync()  : Promise
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getAccountLimit()  : Result
getAccountLimitAsync()  : Promise
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getChange()  : Result
getChangeAsync()  : Promise
getCheckerIpRanges()  : Result
getCheckerIpRangesAsync()  : Promise
getClientBuiltIns()  : array<string|int, mixed>
Provides the set of built-in keys and values used for endpoint resolution
getClientContextParams()  : array<string|int, mixed>
Provides the set of service context parameter key-value pairs used for endpoint resolution.
getCommand()  : CommandInterface
getConfig()  : mixed|null
Get a client configuration value.
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getDNSSEC()  : Result
getDNSSECAsync()  : 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.
getGeoLocation()  : Result
getGeoLocationAsync()  : Promise
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getHealthCheck()  : Result
getHealthCheckAsync()  : Promise
getHealthCheckCount()  : Result
getHealthCheckCountAsync()  : Promise
getHealthCheckLastFailureReason()  : Result
getHealthCheckLastFailureReasonAsync()  : Promise
getHealthCheckStatus()  : Result
getHealthCheckStatusAsync()  : Promise
getHostedZone()  : Result
getHostedZoneAsync()  : Promise
getHostedZoneCount()  : Result
getHostedZoneCountAsync()  : Promise
getHostedZoneLimit()  : Result
getHostedZoneLimitAsync()  : Promise
getIterator()  : mixed
getPaginator()  : mixed
getQueryLoggingConfig()  : Result
getQueryLoggingConfigAsync()  : Promise
getRegion()  : string
Get the region to which the client is configured to send requests.
getReusableDelegationSet()  : Result
getReusableDelegationSetAsync()  : Promise
getReusableDelegationSetLimit()  : Result
getReusableDelegationSetLimitAsync()  : Promise
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getTrafficPolicy()  : Result
getTrafficPolicyAsync()  : Promise
getTrafficPolicyInstance()  : Result
getTrafficPolicyInstanceAsync()  : Promise
getTrafficPolicyInstanceCount()  : Result
getTrafficPolicyInstanceCountAsync()  : Promise
getWaiter()  : mixed
listCidrBlocks()  : Result
listCidrBlocksAsync()  : Promise
listCidrCollections()  : Result
listCidrCollectionsAsync()  : Promise
listCidrLocations()  : Result
listCidrLocationsAsync()  : Promise
listGeoLocations()  : Result
listGeoLocationsAsync()  : Promise
listHealthChecks()  : Result
listHealthChecksAsync()  : Promise
listHostedZones()  : Result
listHostedZonesAsync()  : Promise
listHostedZonesByName()  : Result
listHostedZonesByNameAsync()  : Promise
listHostedZonesByVPC()  : Result
listHostedZonesByVPCAsync()  : Promise
listQueryLoggingConfigs()  : Result
listQueryLoggingConfigsAsync()  : Promise
listResourceRecordSets()  : Result
listResourceRecordSetsAsync()  : Promise
listReusableDelegationSets()  : Result
listReusableDelegationSetsAsync()  : Promise
listTagsForResource()  : Result
listTagsForResourceAsync()  : Promise
listTagsForResources()  : Result
listTagsForResourcesAsync()  : Promise
listTrafficPolicies()  : Result
listTrafficPoliciesAsync()  : Promise
listTrafficPolicyInstances()  : Result
listTrafficPolicyInstancesAsync()  : Promise
listTrafficPolicyInstancesByHostedZone()  : Result
listTrafficPolicyInstancesByHostedZoneAsync()  : Promise
listTrafficPolicyInstancesByPolicy()  : Result
listTrafficPolicyInstancesByPolicyAsync()  : Promise
listTrafficPolicyVersions()  : Result
listTrafficPolicyVersionsAsync()  : Promise
listVPCAssociationAuthorizations()  : Result
listVPCAssociationAuthorizationsAsync()  : Promise
testDNSAnswer()  : Result
testDNSAnswerAsync()  : Promise
updateHealthCheck()  : Result
updateHealthCheckAsync()  : Promise
updateHostedZoneComment()  : Result
updateHostedZoneCommentAsync()  : Promise
updateTrafficPolicyComment()  : Result
updateTrafficPolicyCommentAsync()  : Promise
updateTrafficPolicyInstance()  : Result
updateTrafficPolicyInstanceAsync()  : 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.

__sleep()

public __sleep() : mixed

activateKeySigningKey()

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

activateKeySigningKeyAsync()

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

associateVPCWithHostedZone()

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

associateVPCWithHostedZoneAsync()

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

changeCidrCollection()

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

changeCidrCollectionAsync()

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

changeResourceRecordSets()

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

changeResourceRecordSetsAsync()

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

changeTagsForResource()

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

changeTagsForResourceAsync()

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

createCidrCollection()

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

createCidrCollectionAsync()

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

createHealthCheck()

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

createHealthCheckAsync()

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

createHostedZone()

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

createHostedZoneAsync()

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

createKeySigningKey()

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

createKeySigningKeyAsync()

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

createQueryLoggingConfig()

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

createQueryLoggingConfigAsync()

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

createReusableDelegationSet()

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

createReusableDelegationSetAsync()

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

createTrafficPolicy()

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

createTrafficPolicyAsync()

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

createTrafficPolicyInstance()

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

createTrafficPolicyInstanceAsync()

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

createTrafficPolicyVersion()

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

createTrafficPolicyVersionAsync()

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

createVPCAssociationAuthorization()

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

createVPCAssociationAuthorizationAsync()

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

deactivateKeySigningKey()

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

deactivateKeySigningKeyAsync()

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

deleteCidrCollection()

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

deleteCidrCollectionAsync()

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

deleteHealthCheck()

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

deleteHealthCheckAsync()

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

deleteHostedZone()

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

deleteHostedZoneAsync()

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

deleteKeySigningKey()

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

deleteKeySigningKeyAsync()

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

deleteQueryLoggingConfig()

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

deleteQueryLoggingConfigAsync()

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

deleteReusableDelegationSet()

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

deleteReusableDelegationSetAsync()

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

deleteTrafficPolicy()

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

deleteTrafficPolicyAsync()

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

deleteTrafficPolicyInstance()

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

deleteTrafficPolicyInstanceAsync()

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

deleteVPCAssociationAuthorization()

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

deleteVPCAssociationAuthorizationAsync()

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

disableHostedZoneDNSSEC()

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

disableHostedZoneDNSSECAsync()

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

disassociateVPCFromHostedZone()

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

disassociateVPCFromHostedZoneAsync()

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

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

enableHostedZoneDNSSEC()

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

enableHostedZoneDNSSECAsync()

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

factory()

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

getAccountLimit()

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

getAccountLimitAsync()

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

getArguments()

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

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

getChange()

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

getChangeAsync()

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

getCheckerIpRanges()

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

getCheckerIpRangesAsync()

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

getClientBuiltIns()

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

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

getClientContextParams()

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

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

getCommand()

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

getConfig()

Get a client configuration value.

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

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

Return values
mixed|null

getCredentials()

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

public getCredentials() : PromiseInterface

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

Return values
PromiseInterface

getDNSSEC()

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

getDNSSECAsync()

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

getEndpoint()

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

public getEndpoint() : UriInterface
Return values
UriInterface

getEndpointProvider()

public getEndpointProvider() : mixed

getEndpointProviderArgs()

Retrieves arguments to be used in endpoint resolution.

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

getGeoLocation()

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

getGeoLocationAsync()

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

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 = []) : Result
Parameters
$args = [] : array<string|int, mixed>
Return values
Result

getHealthCheckAsync()

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

getHealthCheckCount()

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

getHealthCheckCountAsync()

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

getHealthCheckLastFailureReason()

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

getHealthCheckLastFailureReasonAsync()

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

getHealthCheckStatus()

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

getHealthCheckStatusAsync()

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

getHostedZone()

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

getHostedZoneAsync()

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

getHostedZoneCount()

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

getHostedZoneCountAsync()

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

getHostedZoneLimit()

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

getHostedZoneLimitAsync()

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

getIterator()

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

getPaginator()

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

getQueryLoggingConfig()

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

getQueryLoggingConfigAsync()

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

getRegion()

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

public getRegion() : string
Return values
string

getReusableDelegationSet()

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

getReusableDelegationSetAsync()

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

getReusableDelegationSetLimit()

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

getReusableDelegationSetLimitAsync()

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

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getTrafficPolicy()

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

getTrafficPolicyAsync()

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

getTrafficPolicyInstance()

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

getTrafficPolicyInstanceAsync()

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

getTrafficPolicyInstanceCount()

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

getTrafficPolicyInstanceCountAsync()

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

getWaiter()

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

listCidrBlocks()

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

listCidrBlocksAsync()

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

listCidrCollections()

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

listCidrCollectionsAsync()

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

listCidrLocations()

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

listCidrLocationsAsync()

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

listGeoLocations()

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

listGeoLocationsAsync()

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

listHealthChecks()

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

listHealthChecksAsync()

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

listHostedZones()

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

listHostedZonesAsync()

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

listHostedZonesByName()

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

listHostedZonesByNameAsync()

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

listHostedZonesByVPC()

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

listHostedZonesByVPCAsync()

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

listQueryLoggingConfigs()

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

listQueryLoggingConfigsAsync()

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

listResourceRecordSets()

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

listResourceRecordSetsAsync()

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

listReusableDelegationSets()

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

listReusableDelegationSetsAsync()

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

listTagsForResource()

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

listTagsForResourceAsync()

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

listTagsForResources()

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

listTagsForResourcesAsync()

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

listTrafficPolicies()

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

listTrafficPoliciesAsync()

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

listTrafficPolicyInstances()

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

listTrafficPolicyInstancesAsync()

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

listTrafficPolicyInstancesByHostedZone()

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

listTrafficPolicyInstancesByHostedZoneAsync()

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

listTrafficPolicyInstancesByPolicy()

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

listTrafficPolicyInstancesByPolicyAsync()

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

listTrafficPolicyVersions()

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

listTrafficPolicyVersionsAsync()

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

listVPCAssociationAuthorizations()

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

listVPCAssociationAuthorizationsAsync()

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

testDNSAnswer()

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

testDNSAnswerAsync()

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

updateHealthCheck()

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

updateHealthCheckAsync()

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

updateHostedZoneComment()

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

updateHostedZoneCommentAsync()

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

updateTrafficPolicyComment()

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

updateTrafficPolicyCommentAsync()

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

updateTrafficPolicyInstance()

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

updateTrafficPolicyInstanceAsync()

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

waitUntil()

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