Documentation

LightsailClient extends AwsClient
in package

This client is used to interact with the **Amazon Lightsail** service.

Table of Contents

$aliases  : array<string|int, mixed>
$api  : Service
$config  : array<string|int, mixed>
$credentialProvider  : callable
$defaultRequestOptions  : array<string|int, mixed>
$endpoint  : string
$handlerList  : HandlerList
$region  : string
$signatureProvider  : callable
__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
allocateStaticIp()  :
allocateStaticIpAsync()  :
attachCertificateToDistribution()  :
attachCertificateToDistributionAsync()  :
attachDisk()  :
attachDiskAsync()  :
attachInstancesToLoadBalancer()  :
attachInstancesToLoadBalancerAsync()  :
attachLoadBalancerTlsCertificate()  :
attachLoadBalancerTlsCertificateAsync()  :
attachStaticIp()  :
attachStaticIpAsync()  :
closeInstancePublicPorts()  :
closeInstancePublicPortsAsync()  :
copySnapshot()  :
copySnapshotAsync()  :
createCertificate()  :
createCertificateAsync()  :
createCloudFormationStack()  :
createCloudFormationStackAsync()  :
createContactMethod()  :
createContactMethodAsync()  :
createContainerService()  :
createContainerServiceAsync()  :
createContainerServiceDeployment()  :
createContainerServiceDeploymentAsync()  :
createContainerServiceRegistryLogin()  :
createContainerServiceRegistryLoginAsync()  :
createDisk()  :
createDiskAsync()  :
createDiskFromSnapshot()  :
createDiskFromSnapshotAsync()  :
createDiskSnapshot()  :
createDiskSnapshotAsync()  :
createDistribution()  :
createDistributionAsync()  :
createDomain()  :
createDomainAsync()  :
createDomainEntry()  :
createDomainEntryAsync()  :
createInstances()  :
createInstancesAsync()  :
createInstancesFromSnapshot()  :
createInstancesFromSnapshotAsync()  :
createInstanceSnapshot()  :
createInstanceSnapshotAsync()  :
createKeyPair()  :
createKeyPairAsync()  :
createLoadBalancer()  :
createLoadBalancerAsync()  :
createLoadBalancerTlsCertificate()  :
createLoadBalancerTlsCertificateAsync()  :
createRelationalDatabase()  :
createRelationalDatabaseAsync()  :
createRelationalDatabaseFromSnapshot()  :
createRelationalDatabaseFromSnapshotAsync()  :
createRelationalDatabaseSnapshot()  :
createRelationalDatabaseSnapshotAsync()  :
deleteAlarm()  :
deleteAlarmAsync()  :
deleteAutoSnapshot()  :
deleteAutoSnapshotAsync()  :
deleteCertificate()  :
deleteCertificateAsync()  :
deleteContactMethod()  :
deleteContactMethodAsync()  :
deleteContainerImage()  :
deleteContainerImageAsync()  :
deleteContainerService()  :
deleteContainerServiceAsync()  :
deleteDisk()  :
deleteDiskAsync()  :
deleteDiskSnapshot()  :
deleteDiskSnapshotAsync()  :
deleteDistribution()  :
deleteDistributionAsync()  :
deleteDomain()  :
deleteDomainAsync()  :
deleteDomainEntry()  :
deleteDomainEntryAsync()  :
deleteInstance()  :
deleteInstanceAsync()  :
deleteInstanceSnapshot()  :
deleteInstanceSnapshotAsync()  :
deleteKeyPair()  :
deleteKeyPairAsync()  :
deleteKnownHostKeys()  :
deleteKnownHostKeysAsync()  :
deleteLoadBalancer()  :
deleteLoadBalancerAsync()  :
deleteLoadBalancerTlsCertificate()  :
deleteLoadBalancerTlsCertificateAsync()  :
deleteRelationalDatabase()  :
deleteRelationalDatabaseAsync()  :
deleteRelationalDatabaseSnapshot()  :
deleteRelationalDatabaseSnapshotAsync()  :
detachCertificateFromDistribution()  :
detachCertificateFromDistributionAsync()  :
detachDisk()  :
detachDiskAsync()  :
detachInstancesFromLoadBalancer()  :
detachInstancesFromLoadBalancerAsync()  :
detachStaticIp()  :
detachStaticIpAsync()  :
disableAddOn()  :
disableAddOnAsync()  :
downloadDefaultKeyPair()  :
downloadDefaultKeyPairAsync()  :
enableAddOn()  :
enableAddOnAsync()  :
execute()  : mixed
executeAsync()  : mixed
exportSnapshot()  :
exportSnapshotAsync()  :
factory()  : static
getActiveNames()  :
getActiveNamesAsync()  :
getAlarms()  :
getAlarmsAsync()  :
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getAutoSnapshots()  :
getAutoSnapshotsAsync()  :
getBlueprints()  :
getBlueprintsAsync()  :
getBundles()  :
getBundlesAsync()  :
getCertificates()  :
getCertificatesAsync()  :
getCloudFormationStackRecords()  :
getCloudFormationStackRecordsAsync()  :
getCommand()  : CommandInterface
getConfig()  : mixed|null
Get a client configuration value.
getContactMethods()  :
getContactMethodsAsync()  :
getContainerAPIMetadata()  :
getContainerAPIMetadataAsync()  :
getContainerImages()  :
getContainerImagesAsync()  :
getContainerLog()  :
getContainerLogAsync()  :
getContainerServiceDeployments()  :
getContainerServiceDeploymentsAsync()  :
getContainerServiceMetricData()  :
getContainerServiceMetricDataAsync()  :
getContainerServicePowers()  :
getContainerServicePowersAsync()  :
getContainerServices()  :
getContainerServicesAsync()  :
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getDisk()  :
getDiskAsync()  :
getDisks()  :
getDisksAsync()  :
getDiskSnapshot()  :
getDiskSnapshotAsync()  :
getDiskSnapshots()  :
getDiskSnapshotsAsync()  :
getDistributionBundles()  :
getDistributionBundlesAsync()  :
getDistributionLatestCacheReset()  :
getDistributionLatestCacheResetAsync()  :
getDistributionMetricData()  :
getDistributionMetricDataAsync()  :
getDistributions()  :
getDistributionsAsync()  :
getDomain()  :
getDomainAsync()  :
getDomains()  :
getDomainsAsync()  :
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getExportSnapshotRecords()  :
getExportSnapshotRecordsAsync()  :
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getInstance()  :
getInstanceAccessDetails()  :
getInstanceAccessDetailsAsync()  :
getInstanceAsync()  :
getInstanceMetricData()  :
getInstanceMetricDataAsync()  :
getInstancePortStates()  :
getInstancePortStatesAsync()  :
getInstances()  :
getInstancesAsync()  :
getInstanceSnapshot()  :
getInstanceSnapshotAsync()  :
getInstanceSnapshots()  :
getInstanceSnapshotsAsync()  :
getInstanceState()  :
getInstanceStateAsync()  :
getIterator()  : mixed
getKeyPair()  :
getKeyPairAsync()  :
getKeyPairs()  :
getKeyPairsAsync()  :
getLoadBalancer()  :
getLoadBalancerAsync()  :
getLoadBalancerMetricData()  :
getLoadBalancerMetricDataAsync()  :
getLoadBalancers()  :
getLoadBalancersAsync()  :
getLoadBalancerTlsCertificates()  :
getLoadBalancerTlsCertificatesAsync()  :
getOperation()  :
getOperationAsync()  :
getOperations()  :
getOperationsAsync()  :
getOperationsForResource()  :
getOperationsForResourceAsync()  :
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests.
getRegions()  :
getRegionsAsync()  :
getRelationalDatabase()  :
getRelationalDatabaseAsync()  :
getRelationalDatabaseBlueprints()  :
getRelationalDatabaseBlueprintsAsync()  :
getRelationalDatabaseBundles()  :
getRelationalDatabaseBundlesAsync()  :
getRelationalDatabaseEvents()  :
getRelationalDatabaseEventsAsync()  :
getRelationalDatabaseLogEvents()  :
getRelationalDatabaseLogEventsAsync()  :
getRelationalDatabaseLogStreams()  :
getRelationalDatabaseLogStreamsAsync()  :
getRelationalDatabaseMasterUserPassword()  :
getRelationalDatabaseMasterUserPasswordAsync()  :
getRelationalDatabaseMetricData()  :
getRelationalDatabaseMetricDataAsync()  :
getRelationalDatabaseParameters()  :
getRelationalDatabaseParametersAsync()  :
getRelationalDatabases()  :
getRelationalDatabasesAsync()  :
getRelationalDatabaseSnapshot()  :
getRelationalDatabaseSnapshotAsync()  :
getRelationalDatabaseSnapshots()  :
getRelationalDatabaseSnapshotsAsync()  :
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getStaticIp()  :
getStaticIpAsync()  :
getStaticIps()  :
getStaticIpsAsync()  :
getWaiter()  : mixed
importKeyPair()  :
importKeyPairAsync()  :
isVpcPeered()  :
isVpcPeeredAsync()  :
openInstancePublicPorts()  :
openInstancePublicPortsAsync()  :
peerVpc()  :
peerVpcAsync()  :
putAlarm()  :
putAlarmAsync()  :
putInstancePublicPorts()  :
putInstancePublicPortsAsync()  :
rebootInstance()  :
rebootInstanceAsync()  :
rebootRelationalDatabase()  :
rebootRelationalDatabaseAsync()  :
registerContainerImage()  :
registerContainerImageAsync()  :
releaseStaticIp()  :
releaseStaticIpAsync()  :
resetDistributionCache()  :
resetDistributionCacheAsync()  :
sendContactMethodVerification()  :
sendContactMethodVerificationAsync()  :
startInstance()  :
startInstanceAsync()  :
startRelationalDatabase()  :
startRelationalDatabaseAsync()  :
stopInstance()  :
stopInstanceAsync()  :
stopRelationalDatabase()  :
stopRelationalDatabaseAsync()  :
tagResource()  :
tagResourceAsync()  :
testAlarm()  :
testAlarmAsync()  :
unpeerVpc()  :
unpeerVpcAsync()  :
untagResource()  :
untagResourceAsync()  :
updateContainerService()  :
updateContainerServiceAsync()  :
updateDistribution()  :
updateDistributionAsync()  :
updateDistributionBundle()  :
updateDistributionBundleAsync()  :
updateDomainEntry()  :
updateDomainEntryAsync()  :
updateLoadBalancerAttribute()  :
updateLoadBalancerAttributeAsync()  :
updateRelationalDatabase()  :
updateRelationalDatabaseAsync()  :
updateRelationalDatabaseParameters()  :
updateRelationalDatabaseParametersAsync()  :
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.

Tags
throws
InvalidArgumentException

if any required options are missing or the service is not supported.

Return values
mixed —

__sleep()

public __sleep() : mixed
Return values
mixed —

allocateStaticIp()

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

allocateStaticIpAsync()

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

attachCertificateToDistribution()

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

attachCertificateToDistributionAsync()

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

attachDisk()

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

attachDiskAsync()

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

attachInstancesToLoadBalancer()

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

attachInstancesToLoadBalancerAsync()

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

attachLoadBalancerTlsCertificate()

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

attachLoadBalancerTlsCertificateAsync()

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

attachStaticIp()

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

attachStaticIpAsync()

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

closeInstancePublicPorts()

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

closeInstancePublicPortsAsync()

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

copySnapshot()

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

copySnapshotAsync()

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

createCertificate()

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

createCertificateAsync()

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

createCloudFormationStack()

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

createCloudFormationStackAsync()

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

createContactMethod()

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

createContactMethodAsync()

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

createContainerService()

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

createContainerServiceAsync()

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

createContainerServiceDeployment()

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

createContainerServiceDeploymentAsync()

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

createContainerServiceRegistryLogin()

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

createContainerServiceRegistryLoginAsync()

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

createDisk()

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

createDiskAsync()

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

createDiskFromSnapshot()

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

createDiskFromSnapshotAsync()

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

createDiskSnapshot()

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

createDiskSnapshotAsync()

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

createDistribution()

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

createDistributionAsync()

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

createDomain()

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

createDomainAsync()

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

createDomainEntry()

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

createDomainEntryAsync()

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

createInstances()

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

createInstancesAsync()

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

createInstancesFromSnapshot()

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

createInstancesFromSnapshotAsync()

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

createInstanceSnapshot()

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

createInstanceSnapshotAsync()

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

createKeyPair()

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

createKeyPairAsync()

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

createLoadBalancer()

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

createLoadBalancerAsync()

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

createLoadBalancerTlsCertificate()

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

createLoadBalancerTlsCertificateAsync()

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

createRelationalDatabase()

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

createRelationalDatabaseAsync()

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

createRelationalDatabaseFromSnapshot()

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

createRelationalDatabaseFromSnapshotAsync()

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

createRelationalDatabaseSnapshot()

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

createRelationalDatabaseSnapshotAsync()

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

deleteAlarm()

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

deleteAlarmAsync()

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

deleteAutoSnapshot()

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

deleteAutoSnapshotAsync()

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

deleteCertificate()

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

deleteCertificateAsync()

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

deleteContactMethod()

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

deleteContactMethodAsync()

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

deleteContainerImage()

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

deleteContainerImageAsync()

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

deleteContainerService()

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

deleteContainerServiceAsync()

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

deleteDisk()

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

deleteDiskAsync()

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

deleteDiskSnapshot()

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

deleteDiskSnapshotAsync()

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

deleteDistribution()

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

deleteDistributionAsync()

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

deleteDomain()

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

deleteDomainAsync()

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

deleteDomainEntry()

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

deleteDomainEntryAsync()

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

deleteInstance()

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

deleteInstanceAsync()

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

deleteInstanceSnapshot()

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

deleteInstanceSnapshotAsync()

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

deleteKeyPair()

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

deleteKeyPairAsync()

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

deleteKnownHostKeys()

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

deleteKnownHostKeysAsync()

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

deleteLoadBalancer()

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

deleteLoadBalancerAsync()

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

deleteLoadBalancerTlsCertificate()

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

deleteLoadBalancerTlsCertificateAsync()

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

deleteRelationalDatabase()

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

deleteRelationalDatabaseAsync()

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

deleteRelationalDatabaseSnapshot()

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

deleteRelationalDatabaseSnapshotAsync()

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

detachCertificateFromDistribution()

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

detachCertificateFromDistributionAsync()

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

detachDisk()

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

detachDiskAsync()

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

detachInstancesFromLoadBalancer()

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

detachInstancesFromLoadBalancerAsync()

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

detachStaticIp()

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

detachStaticIpAsync()

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

disableAddOn()

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

disableAddOnAsync()

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

downloadDefaultKeyPair()

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

downloadDefaultKeyPairAsync()

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

enableAddOn()

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

enableAddOnAsync()

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

exportSnapshot()

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

exportSnapshotAsync()

public exportSnapshotAsync(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 —

getActiveNames()

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

getActiveNamesAsync()

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

getAlarms()

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

getAlarmsAsync()

public getAlarmsAsync(array<string|int, mixed> $args = []) :
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> —

getAutoSnapshots()

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

getAutoSnapshotsAsync()

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

getBlueprints()

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

getBlueprintsAsync()

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

getBundles()

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

getBundlesAsync()

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

getCertificates()

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

getCertificatesAsync()

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

getCloudFormationStackRecords()

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

getCloudFormationStackRecordsAsync()

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

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 —

getContactMethods()

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

getContactMethodsAsync()

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

getContainerAPIMetadata()

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

getContainerAPIMetadataAsync()

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

getContainerImages()

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

getContainerImagesAsync()

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

getContainerLog()

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

getContainerLogAsync()

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

getContainerServiceDeployments()

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

getContainerServiceDeploymentsAsync()

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

getContainerServiceMetricData()

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

getContainerServiceMetricDataAsync()

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

getContainerServicePowers()

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

getContainerServicePowersAsync()

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

getContainerServices()

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

getContainerServicesAsync()

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

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 —

getDisk()

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

getDiskAsync()

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

getDisks()

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

getDisksAsync()

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

getDiskSnapshot()

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

getDiskSnapshotAsync()

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

getDiskSnapshots()

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

getDiskSnapshotsAsync()

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

getDistributionBundles()

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

getDistributionBundlesAsync()

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

getDistributionLatestCacheReset()

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

getDistributionLatestCacheResetAsync()

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

getDistributionMetricData()

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

getDistributionMetricDataAsync()

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

getDistributions()

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

getDistributionsAsync()

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

getDomain()

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

getDomainAsync()

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

getDomains()

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

getDomainsAsync()

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

getExportSnapshotRecords()

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

getExportSnapshotRecordsAsync()

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

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

This list can be modified to add middleware or to change the underlying handler used to send HTTP requests.

Return values
HandlerList —

getInstance()

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

getInstanceAccessDetails()

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

getInstanceAccessDetailsAsync()

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

getInstanceAsync()

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

getInstanceMetricData()

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

getInstanceMetricDataAsync()

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

getInstancePortStates()

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

getInstancePortStatesAsync()

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

getInstances()

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

getInstancesAsync()

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

getInstanceSnapshot()

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

getInstanceSnapshotAsync()

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

getInstanceSnapshots()

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

getInstanceSnapshotsAsync()

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

getInstanceState()

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

getInstanceStateAsync()

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

getIterator()

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

getKeyPair()

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

getKeyPairAsync()

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

getKeyPairs()

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

getKeyPairsAsync()

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

getLoadBalancer()

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

getLoadBalancerAsync()

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

getLoadBalancerMetricData()

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

getLoadBalancerMetricDataAsync()

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

getLoadBalancers()

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

getLoadBalancersAsync()

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

getLoadBalancerTlsCertificates()

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

getLoadBalancerTlsCertificatesAsync()

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

getOperation()

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

getOperationAsync()

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

getOperations()

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

getOperationsAsync()

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

getOperationsForResource()

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

getOperationsForResourceAsync()

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

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 —

getRegions()

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

getRegionsAsync()

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

getRelationalDatabase()

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

getRelationalDatabaseAsync()

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

getRelationalDatabaseBlueprints()

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

getRelationalDatabaseBlueprintsAsync()

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

getRelationalDatabaseBundles()

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

getRelationalDatabaseBundlesAsync()

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

getRelationalDatabaseEvents()

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

getRelationalDatabaseEventsAsync()

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

getRelationalDatabaseLogEvents()

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

getRelationalDatabaseLogEventsAsync()

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

getRelationalDatabaseLogStreams()

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

getRelationalDatabaseLogStreamsAsync()

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

getRelationalDatabaseMasterUserPassword()

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

getRelationalDatabaseMasterUserPasswordAsync()

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

getRelationalDatabaseMetricData()

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

getRelationalDatabaseMetricDataAsync()

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

getRelationalDatabaseParameters()

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

getRelationalDatabaseParametersAsync()

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

getRelationalDatabases()

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

getRelationalDatabasesAsync()

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

getRelationalDatabaseSnapshot()

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

getRelationalDatabaseSnapshotAsync()

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

getRelationalDatabaseSnapshots()

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

getRelationalDatabaseSnapshotsAsync()

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

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable —

getStaticIp()

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

getStaticIpAsync()

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

getStaticIps()

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

getStaticIpsAsync()

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

getWaiter()

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

importKeyPair()

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

importKeyPairAsync()

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

isVpcPeered()

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

isVpcPeeredAsync()

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

openInstancePublicPorts()

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

openInstancePublicPortsAsync()

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

peerVpc()

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

peerVpcAsync()

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

putAlarm()

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

putAlarmAsync()

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

putInstancePublicPorts()

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

putInstancePublicPortsAsync()

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

rebootInstance()

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

rebootInstanceAsync()

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

rebootRelationalDatabase()

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

rebootRelationalDatabaseAsync()

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

registerContainerImage()

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

registerContainerImageAsync()

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

releaseStaticIp()

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

releaseStaticIpAsync()

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

resetDistributionCache()

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

resetDistributionCacheAsync()

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

sendContactMethodVerification()

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

sendContactMethodVerificationAsync()

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

startInstance()

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

startInstanceAsync()

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

startRelationalDatabase()

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

startRelationalDatabaseAsync()

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

stopInstance()

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

stopInstanceAsync()

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

stopRelationalDatabase()

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

stopRelationalDatabaseAsync()

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

tagResource()

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

tagResourceAsync()

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

testAlarm()

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

testAlarmAsync()

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

unpeerVpc()

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

unpeerVpcAsync()

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

untagResource()

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

untagResourceAsync()

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

updateContainerService()

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

updateContainerServiceAsync()

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

updateDistribution()

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

updateDistributionAsync()

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

updateDistributionBundle()

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

updateDistributionBundleAsync()

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

updateDomainEntry()

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

updateDomainEntryAsync()

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

updateLoadBalancerAttribute()

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

updateLoadBalancerAttributeAsync()

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

updateRelationalDatabase()

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

updateRelationalDatabaseAsync()

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

updateRelationalDatabaseParameters()

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

updateRelationalDatabaseParametersAsync()

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

waitUntil()

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

addEndpointDiscoveryMiddleware()

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

addEndpointParameterMiddleware()

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

addInvocationId()

private addInvocationId() : mixed
Return values
mixed —

addSignatureMiddleware()

private addSignatureMiddleware() : mixed
Return values
mixed —

addStreamRequestPayload()

private addStreamRequestPayload() : mixed
Return values
mixed —

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