SDK for PHP 3.x

NeptuneClient extends AwsClient
in package

This client is used to interact with the Amazon Neptune 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
addRoleToDBCluster()  : Result
addRoleToDBClusterAsync()  : Promise
addSourceIdentifierToSubscription()  : Result
addSourceIdentifierToSubscriptionAsync()  : Promise
addTagsToResource()  : Result
addTagsToResourceAsync()  : Promise
applyPendingMaintenanceAction()  : Result
applyPendingMaintenanceActionAsync()  : Promise
copyDBClusterParameterGroup()  : Result
copyDBClusterParameterGroupAsync()  : Promise
copyDBClusterSnapshot()  : Result
copyDBClusterSnapshotAsync()  : Promise
copyDBParameterGroup()  : Result
copyDBParameterGroupAsync()  : Promise
createDBCluster()  : Result
createDBClusterAsync()  : Promise
createDBClusterEndpoint()  : Result
createDBClusterEndpointAsync()  : Promise
createDBClusterParameterGroup()  : Result
createDBClusterParameterGroupAsync()  : Promise
createDBClusterSnapshot()  : Result
createDBClusterSnapshotAsync()  : Promise
createDBInstance()  : Result
createDBInstanceAsync()  : Promise
createDBParameterGroup()  : Result
createDBParameterGroupAsync()  : Promise
createDBSubnetGroup()  : Result
createDBSubnetGroupAsync()  : Promise
createEventSubscription()  : Result
createEventSubscriptionAsync()  : Promise
createGlobalCluster()  : Result
createGlobalClusterAsync()  : Promise
deleteDBCluster()  : Result
deleteDBClusterAsync()  : Promise
deleteDBClusterEndpoint()  : Result
deleteDBClusterEndpointAsync()  : Promise
deleteDBClusterParameterGroup()  : Result
deleteDBClusterParameterGroupAsync()  : Promise
deleteDBClusterSnapshot()  : Result
deleteDBClusterSnapshotAsync()  : Promise
deleteDBInstance()  : Result
deleteDBInstanceAsync()  : Promise
deleteDBParameterGroup()  : Result
deleteDBParameterGroupAsync()  : Promise
deleteDBSubnetGroup()  : Result
deleteDBSubnetGroupAsync()  : Promise
deleteEventSubscription()  : Result
deleteEventSubscriptionAsync()  : Promise
deleteGlobalCluster()  : Result
deleteGlobalClusterAsync()  : Promise
describeDBClusterEndpoints()  : Result
describeDBClusterEndpointsAsync()  : Promise
describeDBClusterParameterGroups()  : Result
describeDBClusterParameterGroupsAsync()  : Promise
describeDBClusterParameters()  : Result
describeDBClusterParametersAsync()  : Promise
describeDBClusters()  : Result
describeDBClustersAsync()  : Promise
describeDBClusterSnapshotAttributes()  : Result
describeDBClusterSnapshotAttributesAsync()  : Promise
describeDBClusterSnapshots()  : Result
describeDBClusterSnapshotsAsync()  : Promise
describeDBEngineVersions()  : Result
describeDBEngineVersionsAsync()  : Promise
describeDBInstances()  : Result
describeDBInstancesAsync()  : Promise
describeDBParameterGroups()  : Result
describeDBParameterGroupsAsync()  : Promise
describeDBParameters()  : Result
describeDBParametersAsync()  : Promise
describeDBSubnetGroups()  : Result
describeDBSubnetGroupsAsync()  : Promise
describeEngineDefaultClusterParameters()  : Result
describeEngineDefaultClusterParametersAsync()  : Promise
describeEngineDefaultParameters()  : Result
describeEngineDefaultParametersAsync()  : Promise
describeEventCategories()  : Result
describeEventCategoriesAsync()  : Promise
describeEvents()  : Result
describeEventsAsync()  : Promise
describeEventSubscriptions()  : Result
describeEventSubscriptionsAsync()  : Promise
describeGlobalClusters()  : Result
describeGlobalClustersAsync()  : Promise
describeOrderableDBInstanceOptions()  : Result
describeOrderableDBInstanceOptionsAsync()  : Promise
describePendingMaintenanceActions()  : Result
describePendingMaintenanceActionsAsync()  : Promise
describeValidDBInstanceModifications()  : Result
describeValidDBInstanceModificationsAsync()  : Promise
emitDeprecationWarning()  : mixed
execute()  : mixed
executeAsync()  : mixed
factory()  : static
failoverDBCluster()  : Result
failoverDBClusterAsync()  : Promise
failoverGlobalCluster()  : Result
failoverGlobalClusterAsync()  : Promise
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
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.
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.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIterator()  : mixed
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests.
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
listTagsForResource()  : Result
listTagsForResourceAsync()  : Promise
modifyDBCluster()  : Result
modifyDBClusterAsync()  : Promise
modifyDBClusterEndpoint()  : Result
modifyDBClusterEndpointAsync()  : Promise
modifyDBClusterParameterGroup()  : Result
modifyDBClusterParameterGroupAsync()  : Promise
modifyDBClusterSnapshotAttribute()  : Result
modifyDBClusterSnapshotAttributeAsync()  : Promise
modifyDBInstance()  : Result
modifyDBInstanceAsync()  : Promise
modifyDBParameterGroup()  : Result
modifyDBParameterGroupAsync()  : Promise
modifyDBSubnetGroup()  : Result
modifyDBSubnetGroupAsync()  : Promise
modifyEventSubscription()  : Result
modifyEventSubscriptionAsync()  : Promise
modifyGlobalCluster()  : Result
modifyGlobalClusterAsync()  : Promise
promoteReadReplicaDBCluster()  : Result
promoteReadReplicaDBClusterAsync()  : Promise
rebootDBInstance()  : Result
rebootDBInstanceAsync()  : Promise
removeFromGlobalCluster()  : Result
removeFromGlobalClusterAsync()  : Promise
removeRoleFromDBCluster()  : Result
removeRoleFromDBClusterAsync()  : Promise
removeSourceIdentifierFromSubscription()  : Result
removeSourceIdentifierFromSubscriptionAsync()  : Promise
removeTagsFromResource()  : Result
removeTagsFromResourceAsync()  : Promise
resetDBClusterParameterGroup()  : Result
resetDBClusterParameterGroupAsync()  : Promise
resetDBParameterGroup()  : Result
resetDBParameterGroupAsync()  : Promise
restoreDBClusterFromSnapshot()  : Result
restoreDBClusterFromSnapshotAsync()  : Promise
restoreDBClusterToPointInTime()  : Result
restoreDBClusterToPointInTimeAsync()  : Promise
startDBCluster()  : Result
startDBClusterAsync()  : Promise
stopDBCluster()  : Result
stopDBClusterAsync()  : 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

addRoleToDBCluster()

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

addRoleToDBClusterAsync()

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

addSourceIdentifierToSubscription()

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

addSourceIdentifierToSubscriptionAsync()

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

addTagsToResource()

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

addTagsToResourceAsync()

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

applyPendingMaintenanceAction()

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

applyPendingMaintenanceActionAsync()

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

copyDBClusterParameterGroup()

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

copyDBClusterParameterGroupAsync()

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

copyDBClusterSnapshot()

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

copyDBClusterSnapshotAsync()

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

copyDBParameterGroup()

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

copyDBParameterGroupAsync()

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

createDBCluster()

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

createDBClusterAsync()

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

createDBClusterEndpoint()

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

createDBClusterEndpointAsync()

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

createDBClusterParameterGroup()

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

createDBClusterParameterGroupAsync()

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

createDBClusterSnapshot()

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

createDBClusterSnapshotAsync()

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

createDBInstance()

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

createDBInstanceAsync()

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

createDBParameterGroup()

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

createDBParameterGroupAsync()

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

createDBSubnetGroup()

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

createDBSubnetGroupAsync()

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

createEventSubscription()

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

createEventSubscriptionAsync()

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

createGlobalCluster()

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

createGlobalClusterAsync()

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

deleteDBCluster()

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

deleteDBClusterAsync()

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

deleteDBClusterEndpoint()

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

deleteDBClusterEndpointAsync()

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

deleteDBClusterParameterGroup()

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

deleteDBClusterParameterGroupAsync()

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

deleteDBClusterSnapshot()

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

deleteDBClusterSnapshotAsync()

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

deleteDBInstance()

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

deleteDBInstanceAsync()

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

deleteDBParameterGroup()

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

deleteDBParameterGroupAsync()

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

deleteDBSubnetGroup()

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

deleteDBSubnetGroupAsync()

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

deleteEventSubscription()

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

deleteEventSubscriptionAsync()

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

deleteGlobalCluster()

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

deleteGlobalClusterAsync()

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

describeDBClusterEndpoints()

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

describeDBClusterEndpointsAsync()

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

describeDBClusterParameterGroups()

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

describeDBClusterParameterGroupsAsync()

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

describeDBClusterParameters()

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

describeDBClusterParametersAsync()

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

describeDBClusters()

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

describeDBClustersAsync()

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

describeDBClusterSnapshotAttributes()

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

describeDBClusterSnapshotAttributesAsync()

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

describeDBClusterSnapshots()

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

describeDBClusterSnapshotsAsync()

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

describeDBEngineVersions()

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

describeDBEngineVersionsAsync()

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

describeDBInstances()

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

describeDBInstancesAsync()

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

describeDBParameterGroups()

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

describeDBParameterGroupsAsync()

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

describeDBParameters()

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

describeDBParametersAsync()

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

describeDBSubnetGroups()

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

describeDBSubnetGroupsAsync()

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

describeEngineDefaultClusterParameters()

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

describeEngineDefaultClusterParametersAsync()

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

describeEngineDefaultParameters()

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

describeEngineDefaultParametersAsync()

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

describeEventCategories()

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

describeEventCategoriesAsync()

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

describeEvents()

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

describeEventsAsync()

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

describeEventSubscriptions()

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

describeEventSubscriptionsAsync()

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

describeGlobalClusters()

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

describeGlobalClustersAsync()

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

describeOrderableDBInstanceOptions()

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

describeOrderableDBInstanceOptionsAsync()

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

describePendingMaintenanceActions()

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

describePendingMaintenanceActionsAsync()

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

describeValidDBInstanceModifications()

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

describeValidDBInstanceModificationsAsync()

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

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

factory()

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

failoverDBCluster()

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

failoverDBClusterAsync()

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

failoverGlobalCluster()

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

failoverGlobalClusterAsync()

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

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

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>

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

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> = []

getRegion()

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

public getRegion() : string
Return values
string

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getWaiter()

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

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

modifyDBCluster()

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

modifyDBClusterAsync()

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

modifyDBClusterEndpoint()

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

modifyDBClusterEndpointAsync()

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

modifyDBClusterParameterGroup()

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

modifyDBClusterParameterGroupAsync()

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

modifyDBClusterSnapshotAttribute()

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

modifyDBClusterSnapshotAttributeAsync()

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

modifyDBInstance()

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

modifyDBInstanceAsync()

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

modifyDBParameterGroup()

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

modifyDBParameterGroupAsync()

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

modifyDBSubnetGroup()

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

modifyDBSubnetGroupAsync()

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

modifyEventSubscription()

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

modifyEventSubscriptionAsync()

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

modifyGlobalCluster()

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

modifyGlobalClusterAsync()

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

promoteReadReplicaDBCluster()

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

promoteReadReplicaDBClusterAsync()

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

rebootDBInstance()

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

rebootDBInstanceAsync()

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

removeFromGlobalCluster()

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

removeFromGlobalClusterAsync()

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

removeRoleFromDBCluster()

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

removeRoleFromDBClusterAsync()

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

removeSourceIdentifierFromSubscription()

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

removeSourceIdentifierFromSubscriptionAsync()

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

removeTagsFromResource()

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

removeTagsFromResourceAsync()

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

resetDBClusterParameterGroup()

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

resetDBClusterParameterGroupAsync()

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

resetDBParameterGroup()

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

resetDBParameterGroupAsync()

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

restoreDBClusterFromSnapshot()

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

restoreDBClusterFromSnapshotAsync()

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

restoreDBClusterToPointInTime()

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

restoreDBClusterToPointInTimeAsync()

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

startDBCluster()

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

startDBClusterAsync()

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

stopDBCluster()

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

stopDBClusterAsync()

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