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.
- ActivateKeySigningKey
- AssociateVPCWithHostedZone
- ChangeCidrCollection
- ChangeResourceRecordSets
- ChangeTagsForResource
- CreateCidrCollection
- CreateHealthCheck
- CreateHostedZone
- CreateKeySigningKey
- CreateQueryLoggingConfig
- CreateReusableDelegationSet
- CreateTrafficPolicy
- CreateTrafficPolicyInstance
- CreateTrafficPolicyVersion
- CreateVPCAssociationAuthorization
- DeactivateKeySigningKey
- DeleteCidrCollection
- DeleteHealthCheck
- DeleteHostedZone
- DeleteKeySigningKey
- DeleteQueryLoggingConfig
- DeleteReusableDelegationSet
- DeleteTrafficPolicy
- DeleteTrafficPolicyInstance
- DeleteVPCAssociationAuthorization
- DisableHostedZoneDNSSEC
- DisassociateVPCFromHostedZone
- EnableHostedZoneDNSSEC
- GetAccountLimit
- GetChange
- GetCheckerIpRanges
- GetDNSSEC
- GetGeoLocation
- GetHealthCheck
- GetHealthCheckCount
- GetHealthCheckLastFailureReason
- GetHealthCheckStatus
- GetHostedZone
- GetHostedZoneCount
- GetHostedZoneLimit
- GetQueryLoggingConfig
- GetReusableDelegationSet
- GetReusableDelegationSetLimit
- GetTrafficPolicy
- GetTrafficPolicyInstance
- GetTrafficPolicyInstanceCount
- ListCidrBlocks
- ListCidrCollections
- ListCidrLocations
- ListGeoLocations
- ListHealthChecks
- ListHostedZones
- ListHostedZonesByName
- ListHostedZonesByVPC
- ListQueryLoggingConfigs
- ListResourceRecordSets
- ListReusableDelegationSets
- ListTagsForResource
- ListTagsForResources
- ListTrafficPolicies
- ListTrafficPolicyInstances
- ListTrafficPolicyInstancesByHostedZone
- ListTrafficPolicyInstancesByPolicy
- ListTrafficPolicyVersions
- ListVPCAssociationAuthorizations
- TestDNSAnswer
- UpdateHealthCheck
- UpdateHostedZoneComment
- UpdateTrafficPolicyComment
- UpdateTrafficPolicyInstance
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
ResultactivateKeySigningKeyAsync()
public
activateKeySigningKeyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseassociateVPCWithHostedZone()
public
associateVPCWithHostedZone(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultassociateVPCWithHostedZoneAsync()
public
associateVPCWithHostedZoneAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisechangeCidrCollection()
public
changeCidrCollection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultchangeCidrCollectionAsync()
public
changeCidrCollectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisechangeResourceRecordSets()
public
changeResourceRecordSets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultchangeResourceRecordSetsAsync()
public
changeResourceRecordSetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisechangeTagsForResource()
public
changeTagsForResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultchangeTagsForResourceAsync()
public
changeTagsForResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateCidrCollection()
public
createCidrCollection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateCidrCollectionAsync()
public
createCidrCollectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateHealthCheck()
public
createHealthCheck(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateHealthCheckAsync()
public
createHealthCheckAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateHostedZone()
public
createHostedZone(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateHostedZoneAsync()
public
createHostedZoneAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateKeySigningKey()
public
createKeySigningKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateKeySigningKeyAsync()
public
createKeySigningKeyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateQueryLoggingConfig()
public
createQueryLoggingConfig(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateQueryLoggingConfigAsync()
public
createQueryLoggingConfigAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateReusableDelegationSet()
public
createReusableDelegationSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateReusableDelegationSetAsync()
public
createReusableDelegationSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateTrafficPolicy()
public
createTrafficPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateTrafficPolicyAsync()
public
createTrafficPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateTrafficPolicyInstance()
public
createTrafficPolicyInstance(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateTrafficPolicyInstanceAsync()
public
createTrafficPolicyInstanceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateTrafficPolicyVersion()
public
createTrafficPolicyVersion(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateTrafficPolicyVersionAsync()
public
createTrafficPolicyVersionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateVPCAssociationAuthorization()
public
createVPCAssociationAuthorization(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateVPCAssociationAuthorizationAsync()
public
createVPCAssociationAuthorizationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeactivateKeySigningKey()
public
deactivateKeySigningKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeactivateKeySigningKeyAsync()
public
deactivateKeySigningKeyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteCidrCollection()
public
deleteCidrCollection(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteCidrCollectionAsync()
public
deleteCidrCollectionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteHealthCheck()
public
deleteHealthCheck(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteHealthCheckAsync()
public
deleteHealthCheckAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteHostedZone()
public
deleteHostedZone(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteHostedZoneAsync()
public
deleteHostedZoneAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteKeySigningKey()
public
deleteKeySigningKey(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteKeySigningKeyAsync()
public
deleteKeySigningKeyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteQueryLoggingConfig()
public
deleteQueryLoggingConfig(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteQueryLoggingConfigAsync()
public
deleteQueryLoggingConfigAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteReusableDelegationSet()
public
deleteReusableDelegationSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteReusableDelegationSetAsync()
public
deleteReusableDelegationSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteTrafficPolicy()
public
deleteTrafficPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteTrafficPolicyAsync()
public
deleteTrafficPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteTrafficPolicyInstance()
public
deleteTrafficPolicyInstance(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteTrafficPolicyInstanceAsync()
public
deleteTrafficPolicyInstanceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteVPCAssociationAuthorization()
public
deleteVPCAssociationAuthorization(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteVPCAssociationAuthorizationAsync()
public
deleteVPCAssociationAuthorizationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedisableHostedZoneDNSSEC()
public
disableHostedZoneDNSSEC(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdisableHostedZoneDNSSECAsync()
public
disableHostedZoneDNSSECAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedisassociateVPCFromHostedZone()
public
disassociateVPCFromHostedZone(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdisassociateVPCFromHostedZoneAsync()
public
disassociateVPCFromHostedZoneAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseemitDeprecationWarning()
public
static emitDeprecationWarning() : mixed
enableHostedZoneDNSSEC()
public
enableHostedZoneDNSSEC(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultenableHostedZoneDNSSECAsync()
public
enableHostedZoneDNSSECAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
Promiseexecute()
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
staticgetAccountLimit()
public
getAccountLimit(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetAccountLimitAsync()
public
getAccountLimitAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetApi()
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>getChange()
public
getChange(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetChangeAsync()
public
getChangeAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetCheckerIpRanges()
public
getCheckerIpRanges(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetCheckerIpRangesAsync()
public
getCheckerIpRangesAsync(array<string|int, mixed> $args = []) : Promise
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>getCommand()
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|nullgetCredentials()
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
PromiseInterfacegetDNSSEC()
public
getDNSSEC(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetDNSSECAsync()
public
getDNSSECAsync(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>getGeoLocation()
public
getGeoLocation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetGeoLocationAsync()
public
getGeoLocationAsync(array<string|int, mixed> $args = []) : Promise
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
HandlerListgetHealthCheck()
public
getHealthCheck(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetHealthCheckAsync()
public
getHealthCheckAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetHealthCheckCount()
public
getHealthCheckCount(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetHealthCheckCountAsync()
public
getHealthCheckCountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetHealthCheckLastFailureReason()
public
getHealthCheckLastFailureReason(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetHealthCheckLastFailureReasonAsync()
public
getHealthCheckLastFailureReasonAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetHealthCheckStatus()
public
getHealthCheckStatus(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetHealthCheckStatusAsync()
public
getHealthCheckStatusAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetHostedZone()
public
getHostedZone(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetHostedZoneAsync()
public
getHostedZoneAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetHostedZoneCount()
public
getHostedZoneCount(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetHostedZoneCountAsync()
public
getHostedZoneCountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetHostedZoneLimit()
public
getHostedZoneLimit(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetHostedZoneLimitAsync()
public
getHostedZoneLimitAsync(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> = []
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
ResultgetQueryLoggingConfigAsync()
public
getQueryLoggingConfigAsync(array<string|int, mixed> $args = []) : Promise
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
stringgetReusableDelegationSet()
public
getReusableDelegationSet(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetReusableDelegationSetAsync()
public
getReusableDelegationSetAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetReusableDelegationSetLimit()
public
getReusableDelegationSetLimit(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetReusableDelegationSetLimitAsync()
public
getReusableDelegationSetLimitAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callablegetTrafficPolicy()
public
getTrafficPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetTrafficPolicyAsync()
public
getTrafficPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetTrafficPolicyInstance()
public
getTrafficPolicyInstance(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetTrafficPolicyInstanceAsync()
public
getTrafficPolicyInstanceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetTrafficPolicyInstanceCount()
public
getTrafficPolicyInstanceCount(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetTrafficPolicyInstanceCountAsync()
public
getTrafficPolicyInstanceCountAsync(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> = []
listCidrBlocks()
public
listCidrBlocks(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistCidrBlocksAsync()
public
listCidrBlocksAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistCidrCollections()
public
listCidrCollections(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistCidrCollectionsAsync()
public
listCidrCollectionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistCidrLocations()
public
listCidrLocations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistCidrLocationsAsync()
public
listCidrLocationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistGeoLocations()
public
listGeoLocations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistGeoLocationsAsync()
public
listGeoLocationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistHealthChecks()
public
listHealthChecks(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistHealthChecksAsync()
public
listHealthChecksAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistHostedZones()
public
listHostedZones(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistHostedZonesAsync()
public
listHostedZonesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistHostedZonesByName()
public
listHostedZonesByName(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistHostedZonesByNameAsync()
public
listHostedZonesByNameAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistHostedZonesByVPC()
public
listHostedZonesByVPC(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistHostedZonesByVPCAsync()
public
listHostedZonesByVPCAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistQueryLoggingConfigs()
public
listQueryLoggingConfigs(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistQueryLoggingConfigsAsync()
public
listQueryLoggingConfigsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistResourceRecordSets()
public
listResourceRecordSets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistResourceRecordSetsAsync()
public
listResourceRecordSetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistReusableDelegationSets()
public
listReusableDelegationSets(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistReusableDelegationSetsAsync()
public
listReusableDelegationSetsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTagsForResource()
public
listTagsForResource(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTagsForResourceAsync()
public
listTagsForResourceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTagsForResources()
public
listTagsForResources(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTagsForResourcesAsync()
public
listTagsForResourcesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTrafficPolicies()
public
listTrafficPolicies(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTrafficPoliciesAsync()
public
listTrafficPoliciesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTrafficPolicyInstances()
public
listTrafficPolicyInstances(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTrafficPolicyInstancesAsync()
public
listTrafficPolicyInstancesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTrafficPolicyInstancesByHostedZone()
public
listTrafficPolicyInstancesByHostedZone(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTrafficPolicyInstancesByHostedZoneAsync()
public
listTrafficPolicyInstancesByHostedZoneAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTrafficPolicyInstancesByPolicy()
public
listTrafficPolicyInstancesByPolicy(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTrafficPolicyInstancesByPolicyAsync()
public
listTrafficPolicyInstancesByPolicyAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistTrafficPolicyVersions()
public
listTrafficPolicyVersions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistTrafficPolicyVersionsAsync()
public
listTrafficPolicyVersionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistVPCAssociationAuthorizations()
public
listVPCAssociationAuthorizations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistVPCAssociationAuthorizationsAsync()
public
listVPCAssociationAuthorizationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisetestDNSAnswer()
public
testDNSAnswer(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResulttestDNSAnswerAsync()
public
testDNSAnswerAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateHealthCheck()
public
updateHealthCheck(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateHealthCheckAsync()
public
updateHealthCheckAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateHostedZoneComment()
public
updateHostedZoneComment(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateHostedZoneCommentAsync()
public
updateHostedZoneCommentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateTrafficPolicyComment()
public
updateTrafficPolicyComment(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateTrafficPolicyCommentAsync()
public
updateTrafficPolicyCommentAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateTrafficPolicyInstance()
public
updateTrafficPolicyInstance(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateTrafficPolicyInstanceAsync()
public
updateTrafficPolicyInstanceAsync(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> = []