Documentation

RdsClient extends AwsClient
in package

This client is used to interact with the **Amazon Relational Database Service (Amazon RDS)**.

Table of Contents

$aliases  : array<string|int, mixed>
$api  : Service
$config  : array<string|int, mixed>
$credentialProvider  : callable
$defaultRequestOptions  : array<string|int, mixed>
$endpoint  : string
$handlerList  : HandlerList
$region  : string
$signatureProvider  : callable
__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
addRoleToDBCluster()  :
addRoleToDBClusterAsync()  :
addRoleToDBInstance()  :
addRoleToDBInstanceAsync()  :
addSourceIdentifierToSubscription()  :
addSourceIdentifierToSubscriptionAsync()  :
addTagsToResource()  :
addTagsToResourceAsync()  :
applyPendingMaintenanceAction()  :
applyPendingMaintenanceActionAsync()  :
authorizeDBSecurityGroupIngress()  :
authorizeDBSecurityGroupIngressAsync()  :
backtrackDBCluster()  :
backtrackDBClusterAsync()  :
cancelExportTask()  :
cancelExportTaskAsync()  :
copyDBClusterParameterGroup()  :
copyDBClusterParameterGroupAsync()  :
copyDBClusterSnapshot()  :
copyDBClusterSnapshotAsync()  :
copyDBParameterGroup()  :
copyDBParameterGroupAsync()  :
copyDBSnapshot()  :
copyDBSnapshotAsync()  :
copyOptionGroup()  :
copyOptionGroupAsync()  :
createCustomAvailabilityZone()  :
createCustomAvailabilityZoneAsync()  :
createDBCluster()  :
createDBClusterAsync()  :
createDBClusterEndpoint()  :
createDBClusterEndpointAsync()  :
createDBClusterParameterGroup()  :
createDBClusterParameterGroupAsync()  :
createDBClusterSnapshot()  :
createDBClusterSnapshotAsync()  :
createDBInstance()  :
createDBInstanceAsync()  :
createDBInstanceReadReplica()  :
createDBInstanceReadReplicaAsync()  :
createDBParameterGroup()  :
createDBParameterGroupAsync()  :
createDBProxy()  :
createDBProxyAsync()  :
createDBSecurityGroup()  :
createDBSecurityGroupAsync()  :
createDBSnapshot()  :
createDBSnapshotAsync()  :
createDBSubnetGroup()  :
createDBSubnetGroupAsync()  :
createEventSubscription()  :
createEventSubscriptionAsync()  :
createGlobalCluster()  :
createGlobalClusterAsync()  :
createOptionGroup()  :
createOptionGroupAsync()  :
deleteCustomAvailabilityZone()  :
deleteCustomAvailabilityZoneAsync()  :
deleteDBCluster()  :
deleteDBClusterAsync()  :
deleteDBClusterEndpoint()  :
deleteDBClusterEndpointAsync()  :
deleteDBClusterParameterGroup()  :
deleteDBClusterParameterGroupAsync()  :
deleteDBClusterSnapshot()  :
deleteDBClusterSnapshotAsync()  :
deleteDBInstance()  :
deleteDBInstanceAsync()  :
deleteDBInstanceAutomatedBackup()  :
deleteDBInstanceAutomatedBackupAsync()  :
deleteDBParameterGroup()  :
deleteDBParameterGroupAsync()  :
deleteDBProxy()  :
deleteDBProxyAsync()  :
deleteDBSecurityGroup()  :
deleteDBSecurityGroupAsync()  :
deleteDBSnapshot()  :
deleteDBSnapshotAsync()  :
deleteDBSubnetGroup()  :
deleteDBSubnetGroupAsync()  :
deleteEventSubscription()  :
deleteEventSubscriptionAsync()  :
deleteGlobalCluster()  :
deleteGlobalClusterAsync()  :
deleteInstallationMedia()  :
deleteInstallationMediaAsync()  :
deleteOptionGroup()  :
deleteOptionGroupAsync()  :
deregisterDBProxyTargets()  :
deregisterDBProxyTargetsAsync()  :
describeAccountAttributes()  :
describeAccountAttributesAsync()  :
describeCertificates()  :
describeCertificatesAsync()  :
describeCustomAvailabilityZones()  :
describeCustomAvailabilityZonesAsync()  :
describeDBClusterBacktracks()  :
describeDBClusterBacktracksAsync()  :
describeDBClusterEndpoints()  :
describeDBClusterEndpointsAsync()  :
describeDBClusterParameterGroups()  :
describeDBClusterParameterGroupsAsync()  :
describeDBClusterParameters()  :
describeDBClusterParametersAsync()  :
describeDBClusters()  :
describeDBClustersAsync()  :
describeDBClusterSnapshotAttributes()  :
describeDBClusterSnapshotAttributesAsync()  :
describeDBClusterSnapshots()  :
describeDBClusterSnapshotsAsync()  :
describeDBEngineVersions()  :
describeDBEngineVersionsAsync()  :
describeDBInstanceAutomatedBackups()  :
describeDBInstanceAutomatedBackupsAsync()  :
describeDBInstances()  :
describeDBInstancesAsync()  :
describeDBLogFiles()  :
describeDBLogFilesAsync()  :
describeDBParameterGroups()  :
describeDBParameterGroupsAsync()  :
describeDBParameters()  :
describeDBParametersAsync()  :
describeDBProxies()  :
describeDBProxiesAsync()  :
describeDBProxyTargetGroups()  :
describeDBProxyTargetGroupsAsync()  :
describeDBProxyTargets()  :
describeDBProxyTargetsAsync()  :
describeDBSecurityGroups()  :
describeDBSecurityGroupsAsync()  :
describeDBSnapshotAttributes()  :
describeDBSnapshotAttributesAsync()  :
describeDBSnapshots()  :
describeDBSnapshotsAsync()  :
describeDBSubnetGroups()  :
describeDBSubnetGroupsAsync()  :
describeEngineDefaultClusterParameters()  :
describeEngineDefaultClusterParametersAsync()  :
describeEngineDefaultParameters()  :
describeEngineDefaultParametersAsync()  :
describeEventCategories()  :
describeEventCategoriesAsync()  :
describeEvents()  :
describeEventsAsync()  :
describeEventSubscriptions()  :
describeEventSubscriptionsAsync()  :
describeExportTasks()  :
describeExportTasksAsync()  :
describeGlobalClusters()  :
describeGlobalClustersAsync()  :
describeInstallationMedia()  :
describeInstallationMediaAsync()  :
describeOptionGroupOptions()  :
describeOptionGroupOptionsAsync()  :
describeOptionGroups()  :
describeOptionGroupsAsync()  :
describeOrderableDBInstanceOptions()  :
describeOrderableDBInstanceOptionsAsync()  :
describePendingMaintenanceActions()  :
describePendingMaintenanceActionsAsync()  :
describeReservedDBInstances()  :
describeReservedDBInstancesAsync()  :
describeReservedDBInstancesOfferings()  :
describeReservedDBInstancesOfferingsAsync()  :
describeSourceRegions()  :
describeSourceRegionsAsync()  :
describeValidDBInstanceModifications()  :
describeValidDBInstanceModificationsAsync()  :
downloadDBLogFilePortion()  :
downloadDBLogFilePortionAsync()  :
execute()  : mixed
executeAsync()  : mixed
factory()  : static
failoverDBCluster()  :
failoverDBClusterAsync()  :
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
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.
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
importInstallationMedia()  :
importInstallationMediaAsync()  :
listTagsForResource()  :
listTagsForResourceAsync()  :
modifyCertificates()  :
modifyCertificatesAsync()  :
modifyCurrentDBClusterCapacity()  :
modifyCurrentDBClusterCapacityAsync()  :
modifyDBCluster()  :
modifyDBClusterAsync()  :
modifyDBClusterEndpoint()  :
modifyDBClusterEndpointAsync()  :
modifyDBClusterParameterGroup()  :
modifyDBClusterParameterGroupAsync()  :
modifyDBClusterSnapshotAttribute()  :
modifyDBClusterSnapshotAttributeAsync()  :
modifyDBInstance()  :
modifyDBInstanceAsync()  :
modifyDBParameterGroup()  :
modifyDBParameterGroupAsync()  :
modifyDBProxy()  :
modifyDBProxyAsync()  :
modifyDBProxyTargetGroup()  :
modifyDBProxyTargetGroupAsync()  :
modifyDBSnapshot()  :
modifyDBSnapshotAsync()  :
modifyDBSnapshotAttribute()  :
modifyDBSnapshotAttributeAsync()  :
modifyDBSubnetGroup()  :
modifyDBSubnetGroupAsync()  :
modifyEventSubscription()  :
modifyEventSubscriptionAsync()  :
modifyGlobalCluster()  :
modifyGlobalClusterAsync()  :
modifyOptionGroup()  :
modifyOptionGroupAsync()  :
promoteReadReplica()  :
promoteReadReplicaAsync()  :
promoteReadReplicaDBCluster()  :
promoteReadReplicaDBClusterAsync()  :
purchaseReservedDBInstancesOffering()  :
purchaseReservedDBInstancesOfferingAsync()  :
rebootDBInstance()  :
rebootDBInstanceAsync()  :
registerDBProxyTargets()  :
registerDBProxyTargetsAsync()  :
removeFromGlobalCluster()  :
removeFromGlobalClusterAsync()  :
removeRoleFromDBCluster()  :
removeRoleFromDBClusterAsync()  :
removeRoleFromDBInstance()  :
removeRoleFromDBInstanceAsync()  :
removeSourceIdentifierFromSubscription()  :
removeSourceIdentifierFromSubscriptionAsync()  :
removeTagsFromResource()  :
removeTagsFromResourceAsync()  :
resetDBClusterParameterGroup()  :
resetDBClusterParameterGroupAsync()  :
resetDBParameterGroup()  :
resetDBParameterGroupAsync()  :
restoreDBClusterFromS3()  :
restoreDBClusterFromS3Async()  :
restoreDBClusterFromSnapshot()  :
restoreDBClusterFromSnapshotAsync()  :
restoreDBClusterToPointInTime()  :
restoreDBClusterToPointInTimeAsync()  :
restoreDBInstanceFromDBSnapshot()  :
restoreDBInstanceFromDBSnapshotAsync()  :
restoreDBInstanceFromS3()  :
restoreDBInstanceFromS3Async()  :
restoreDBInstanceToPointInTime()  :
restoreDBInstanceToPointInTimeAsync()  :
revokeDBSecurityGroupIngress()  :
revokeDBSecurityGroupIngressAsync()  :
startActivityStream()  :
startActivityStreamAsync()  :
startDBCluster()  :
startDBClusterAsync()  :
startDBInstance()  :
startDBInstanceAsync()  :
startDBInstanceAutomatedBackupsReplication()  :
startDBInstanceAutomatedBackupsReplicationAsync()  :
startExportTask()  :
startExportTaskAsync()  :
stopActivityStream()  :
stopActivityStreamAsync()  :
stopDBCluster()  :
stopDBClusterAsync()  :
stopDBInstance()  :
stopDBInstanceAsync()  :
stopDBInstanceAutomatedBackupsReplication()  :
stopDBInstanceAutomatedBackupsReplicationAsync()  :
waitUntil()  : mixed
addEndpointDiscoveryMiddleware()  : mixed
addEndpointParameterMiddleware()  : mixed
addInvocationId()  : mixed
addSignatureMiddleware()  : mixed
addStreamRequestPayload()  : mixed
loadAliases()  : mixed
parseClass()  : array<string|int, mixed>
Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

Properties

$aliases

private array<string|int, mixed> $aliases

$config

private array<string|int, mixed> $config

$credentialProvider

private callable $credentialProvider

$defaultRequestOptions

private array<string|int, mixed> $defaultRequestOptions

$signatureProvider

private callable $signatureProvider

Methods

__call()

public __call(mixed $name, array<string|int, mixed> $args) : mixed
Parameters
$name : mixed
$args : array<string|int, mixed>
Return values
mixed

__construct()

The client constructor accepts the following options:

public __construct(array<string|int, mixed> $args) : mixed
  • api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
  • credentials: (Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies the credentials used to sign requests. Provide an Aws\Credentials\CredentialsInterface object, an associative array of "key", "secret", and an optional "token" key, 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.
  • 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).
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Return values
mixed

__sleep()

public __sleep() : mixed
Return values
mixed

addRoleToDBCluster()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

addRoleToDBClusterAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

addRoleToDBInstance()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

addRoleToDBInstanceAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

addSourceIdentifierToSubscription()

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

addSourceIdentifierToSubscriptionAsync()

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

addTagsToResource()

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

addTagsToResourceAsync()

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

applyPendingMaintenanceAction()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

applyPendingMaintenanceActionAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

authorizeDBSecurityGroupIngress()

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

authorizeDBSecurityGroupIngressAsync()

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

backtrackDBCluster()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

backtrackDBClusterAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

cancelExportTask()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

cancelExportTaskAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

copyDBClusterParameterGroup()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

copyDBClusterParameterGroupAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

copyDBClusterSnapshot()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

copyDBClusterSnapshotAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

copyDBParameterGroup()

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

copyDBParameterGroupAsync()

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

copyDBSnapshot()

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

copyDBSnapshotAsync()

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

copyOptionGroup()

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

copyOptionGroupAsync()

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

createCustomAvailabilityZone()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createCustomAvailabilityZoneAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createDBCluster()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createDBClusterAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createDBClusterEndpoint()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createDBClusterEndpointAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createDBClusterParameterGroup()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createDBClusterParameterGroupAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createDBClusterSnapshot()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createDBClusterSnapshotAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createDBInstance()

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

createDBInstanceAsync()

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

createDBInstanceReadReplica()

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

createDBInstanceReadReplicaAsync()

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

createDBParameterGroup()

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

createDBParameterGroupAsync()

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

createDBProxy()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createDBProxyAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createDBSecurityGroup()

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

createDBSecurityGroupAsync()

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

createDBSnapshot()

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

createDBSnapshotAsync()

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

createDBSubnetGroup()

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

createDBSubnetGroupAsync()

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

createEventSubscription()

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

createEventSubscriptionAsync()

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

createGlobalCluster()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createGlobalClusterAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

createOptionGroup()

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

createOptionGroupAsync()

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

deleteCustomAvailabilityZone()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteCustomAvailabilityZoneAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteDBCluster()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteDBClusterAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteDBClusterEndpoint()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteDBClusterEndpointAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteDBClusterParameterGroup()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteDBClusterParameterGroupAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteDBClusterSnapshot()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteDBClusterSnapshotAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteDBInstance()

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

deleteDBInstanceAsync()

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

deleteDBInstanceAutomatedBackup()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteDBInstanceAutomatedBackupAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteDBParameterGroup()

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

deleteDBParameterGroupAsync()

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

deleteDBProxy()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteDBProxyAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteDBSecurityGroup()

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

deleteDBSecurityGroupAsync()

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

deleteDBSnapshot()

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

deleteDBSnapshotAsync()

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

deleteDBSubnetGroup()

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

deleteDBSubnetGroupAsync()

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

deleteEventSubscription()

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

deleteEventSubscriptionAsync()

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

deleteGlobalCluster()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteGlobalClusterAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteInstallationMedia()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteInstallationMediaAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deleteOptionGroup()

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

deleteOptionGroupAsync()

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

deregisterDBProxyTargets()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

deregisterDBProxyTargetsAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeAccountAttributes()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeAccountAttributesAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeCertificates()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeCertificatesAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeCustomAvailabilityZones()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeCustomAvailabilityZonesAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBClusterBacktracks()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBClusterBacktracksAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBClusterEndpoints()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBClusterEndpointsAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBClusterParameterGroups()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBClusterParameterGroupsAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBClusterParameters()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBClusterParametersAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBClusters()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBClustersAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBClusterSnapshotAttributes()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBClusterSnapshotAttributesAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBClusterSnapshots()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBClusterSnapshotsAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBEngineVersions()

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

describeDBEngineVersionsAsync()

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

describeDBInstanceAutomatedBackups()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBInstanceAutomatedBackupsAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBInstances()

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

describeDBInstancesAsync()

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

describeDBLogFiles()

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

describeDBLogFilesAsync()

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

describeDBParameterGroups()

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

describeDBParameterGroupsAsync()

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

describeDBParameters()

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

describeDBParametersAsync()

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

describeDBProxies()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBProxiesAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBProxyTargetGroups()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBProxyTargetGroupsAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBProxyTargets()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBProxyTargetsAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBSecurityGroups()

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

describeDBSecurityGroupsAsync()

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

describeDBSnapshotAttributes()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBSnapshotAttributesAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeDBSnapshots()

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

describeDBSnapshotsAsync()

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

describeDBSubnetGroups()

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

describeDBSubnetGroupsAsync()

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

describeEngineDefaultClusterParameters()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeEngineDefaultClusterParametersAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeEngineDefaultParameters()

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

describeEngineDefaultParametersAsync()

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

describeEventCategories()

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

describeEventCategoriesAsync()

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

describeEvents()

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

describeEventsAsync()

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

describeEventSubscriptions()

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

describeEventSubscriptionsAsync()

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

describeExportTasks()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeExportTasksAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeGlobalClusters()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeGlobalClustersAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeInstallationMedia()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeInstallationMediaAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeOptionGroupOptions()

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

describeOptionGroupOptionsAsync()

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

describeOptionGroups()

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

describeOptionGroupsAsync()

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

describeOrderableDBInstanceOptions()

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

describeOrderableDBInstanceOptionsAsync()

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

describePendingMaintenanceActions()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describePendingMaintenanceActionsAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeReservedDBInstances()

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

describeReservedDBInstancesAsync()

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

describeReservedDBInstancesOfferings()

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

describeReservedDBInstancesOfferingsAsync()

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

describeSourceRegions()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeSourceRegionsAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeValidDBInstanceModifications()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

describeValidDBInstanceModificationsAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

downloadDBLogFilePortion()

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

downloadDBLogFilePortionAsync()

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

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

failoverDBClusterAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

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>

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

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> = []
Return values
mixed

getPaginator()

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

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> = []
Return values
mixed

importInstallationMedia()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

importInstallationMediaAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

listTagsForResource()

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

listTagsForResourceAsync()

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

modifyCertificates()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyCertificatesAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyCurrentDBClusterCapacity()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyCurrentDBClusterCapacityAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBCluster()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBClusterAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBClusterEndpoint()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBClusterEndpointAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBClusterParameterGroup()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBClusterParameterGroupAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBClusterSnapshotAttribute()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBClusterSnapshotAttributeAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBInstance()

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

modifyDBInstanceAsync()

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

modifyDBParameterGroup()

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

modifyDBParameterGroupAsync()

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

modifyDBProxy()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBProxyAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBProxyTargetGroup()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBProxyTargetGroupAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBSnapshot()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBSnapshotAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBSnapshotAttribute()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBSnapshotAttributeAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyDBSubnetGroup()

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

modifyDBSubnetGroupAsync()

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

modifyEventSubscription()

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

modifyEventSubscriptionAsync()

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

modifyGlobalCluster()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyGlobalClusterAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

modifyOptionGroup()

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

modifyOptionGroupAsync()

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

promoteReadReplica()

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

promoteReadReplicaAsync()

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

promoteReadReplicaDBCluster()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

promoteReadReplicaDBClusterAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

purchaseReservedDBInstancesOffering()

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

purchaseReservedDBInstancesOfferingAsync()

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

rebootDBInstance()

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

rebootDBInstanceAsync()

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

registerDBProxyTargets()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

registerDBProxyTargetsAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

removeFromGlobalCluster()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

removeFromGlobalClusterAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

removeRoleFromDBCluster()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

removeRoleFromDBClusterAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

removeRoleFromDBInstance()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

removeRoleFromDBInstanceAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

removeSourceIdentifierFromSubscription()

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

removeSourceIdentifierFromSubscriptionAsync()

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

removeTagsFromResource()

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

removeTagsFromResourceAsync()

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

resetDBClusterParameterGroup()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

resetDBClusterParameterGroupAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

resetDBParameterGroup()

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

resetDBParameterGroupAsync()

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

restoreDBClusterFromS3()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

restoreDBClusterFromS3Async()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

restoreDBClusterFromSnapshot()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

restoreDBClusterFromSnapshotAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

restoreDBClusterToPointInTime()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

restoreDBClusterToPointInTimeAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

restoreDBInstanceFromDBSnapshot()

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

restoreDBInstanceFromDBSnapshotAsync()

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

restoreDBInstanceFromS3()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

restoreDBInstanceFromS3Async()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

restoreDBInstanceToPointInTime()

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

restoreDBInstanceToPointInTimeAsync()

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

revokeDBSecurityGroupIngress()

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

revokeDBSecurityGroupIngressAsync()

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

startActivityStream()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

startActivityStreamAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

startDBCluster()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

startDBClusterAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

startDBInstance()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

startDBInstanceAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

startDBInstanceAutomatedBackupsReplication()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

startDBInstanceAutomatedBackupsReplicationAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

startExportTask()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

startExportTaskAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

stopActivityStream()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

stopActivityStreamAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

stopDBCluster()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

stopDBClusterAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

stopDBInstance()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

stopDBInstanceAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

stopDBInstanceAutomatedBackupsReplication()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

stopDBInstanceAutomatedBackupsReplicationAsync()

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

(supported in versions 2014-10-31)

Parameters
$args = [] : array<string|int, mixed>
Return values

waitUntil()

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

addEndpointDiscoveryMiddleware()

private addEndpointDiscoveryMiddleware(mixed $config, mixed $args) : mixed
Parameters
$config : mixed
$args : mixed
Return values
mixed

addEndpointParameterMiddleware()

private addEndpointParameterMiddleware(mixed $args) : mixed
Parameters
$args : mixed
Return values
mixed

addInvocationId()

private addInvocationId() : mixed
Return values
mixed

addSignatureMiddleware()

private addSignatureMiddleware() : mixed
Return values
mixed

addStreamRequestPayload()

private addStreamRequestPayload() : mixed
Return values
mixed

loadAliases()

private loadAliases([mixed $file = null ]) : mixed
Parameters
$file : mixed = null
Return values
mixed

parseClass()

Parse the class name and setup the custom exception class of the client and return the "service" name of the client and "exception_class".

private parseClass() : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results