Documentation

StorageGatewayClient extends AwsClient
in package

AWS Storage Gateway client.

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
activateGateway()  :
activateGatewayAsync()  :
addCache()  :
addCacheAsync()  :
addTagsToResource()  :
addTagsToResourceAsync()  :
addUploadBuffer()  :
addUploadBufferAsync()  :
addWorkingStorage()  :
addWorkingStorageAsync()  :
assignTapePool()  :
assignTapePoolAsync()  :
attachVolume()  :
attachVolumeAsync()  :
cancelArchival()  :
cancelArchivalAsync()  :
cancelRetrieval()  :
cancelRetrievalAsync()  :
createCachediSCSIVolume()  :
createCachediSCSIVolumeAsync()  :
createNFSFileShare()  :
createNFSFileShareAsync()  :
createSMBFileShare()  :
createSMBFileShareAsync()  :
createSnapshot()  :
createSnapshotAsync()  :
createSnapshotFromVolumeRecoveryPoint()  :
createSnapshotFromVolumeRecoveryPointAsync()  :
createStorediSCSIVolume()  :
createStorediSCSIVolumeAsync()  :
createTapePool()  :
createTapePoolAsync()  :
createTapes()  :
createTapesAsync()  :
createTapeWithBarcode()  :
createTapeWithBarcodeAsync()  :
deleteAutomaticTapeCreationPolicy()  :
deleteAutomaticTapeCreationPolicyAsync()  :
deleteBandwidthRateLimit()  :
deleteBandwidthRateLimitAsync()  :
deleteChapCredentials()  :
deleteChapCredentialsAsync()  :
deleteFileShare()  :
deleteFileShareAsync()  :
deleteGateway()  :
deleteGatewayAsync()  :
deleteSnapshotSchedule()  :
deleteSnapshotScheduleAsync()  :
deleteTape()  :
deleteTapeArchive()  :
deleteTapeArchiveAsync()  :
deleteTapeAsync()  :
deleteTapePool()  :
deleteTapePoolAsync()  :
deleteVolume()  :
deleteVolumeAsync()  :
describeAvailabilityMonitorTest()  :
describeAvailabilityMonitorTestAsync()  :
describeBandwidthRateLimit()  :
describeBandwidthRateLimitAsync()  :
describeBandwidthRateLimitSchedule()  :
describeBandwidthRateLimitScheduleAsync()  :
describeCache()  :
describeCacheAsync()  :
describeCachediSCSIVolumes()  :
describeCachediSCSIVolumesAsync()  :
describeChapCredentials()  :
describeChapCredentialsAsync()  :
describeGatewayInformation()  :
describeGatewayInformationAsync()  :
describeMaintenanceStartTime()  :
describeMaintenanceStartTimeAsync()  :
describeNFSFileShares()  :
describeNFSFileSharesAsync()  :
describeSMBFileShares()  :
describeSMBFileSharesAsync()  :
describeSMBSettings()  :
describeSMBSettingsAsync()  :
describeSnapshotSchedule()  :
describeSnapshotScheduleAsync()  :
describeStorediSCSIVolumes()  :
describeStorediSCSIVolumesAsync()  :
describeTapeArchives()  :
describeTapeArchivesAsync()  :
describeTapeRecoveryPoints()  :
describeTapeRecoveryPointsAsync()  :
describeTapes()  :
describeTapesAsync()  :
describeUploadBuffer()  :
describeUploadBufferAsync()  :
describeVTLDevices()  :
describeVTLDevicesAsync()  :
describeWorkingStorage()  :
describeWorkingStorageAsync()  :
detachVolume()  :
detachVolumeAsync()  :
disableGateway()  :
disableGatewayAsync()  :
execute()  : mixed
executeAsync()  : mixed
factory()  : static
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
joinDomain()  :
joinDomainAsync()  :
listAutomaticTapeCreationPolicies()  :
listAutomaticTapeCreationPoliciesAsync()  :
listFileShares()  :
listFileSharesAsync()  :
listGateways()  :
listGatewaysAsync()  :
listLocalDisks()  :
listLocalDisksAsync()  :
listTagsForResource()  :
listTagsForResourceAsync()  :
listTapePools()  :
listTapePoolsAsync()  :
listTapes()  :
listTapesAsync()  :
listVolumeInitiators()  :
listVolumeInitiatorsAsync()  :
listVolumeRecoveryPoints()  :
listVolumeRecoveryPointsAsync()  :
listVolumes()  :
listVolumesAsync()  :
notifyWhenUploaded()  :
notifyWhenUploadedAsync()  :
refreshCache()  :
refreshCacheAsync()  :
removeTagsFromResource()  :
removeTagsFromResourceAsync()  :
resetCache()  :
resetCacheAsync()  :
retrieveTapeArchive()  :
retrieveTapeArchiveAsync()  :
retrieveTapeRecoveryPoint()  :
retrieveTapeRecoveryPointAsync()  :
setLocalConsolePassword()  :
setLocalConsolePasswordAsync()  :
setSMBGuestPassword()  :
setSMBGuestPasswordAsync()  :
shutdownGateway()  :
shutdownGatewayAsync()  :
startAvailabilityMonitorTest()  :
startAvailabilityMonitorTestAsync()  :
startGateway()  :
startGatewayAsync()  :
updateAutomaticTapeCreationPolicy()  :
updateAutomaticTapeCreationPolicyAsync()  :
updateBandwidthRateLimit()  :
updateBandwidthRateLimitAsync()  :
updateBandwidthRateLimitSchedule()  :
updateBandwidthRateLimitScheduleAsync()  :
updateChapCredentials()  :
updateChapCredentialsAsync()  :
updateGatewayInformation()  :
updateGatewayInformationAsync()  :
updateGatewaySoftwareNow()  :
updateGatewaySoftwareNowAsync()  :
updateMaintenanceStartTime()  :
updateMaintenanceStartTimeAsync()  :
updateNFSFileShare()  :
updateNFSFileShareAsync()  :
updateSMBFileShare()  :
updateSMBFileShareAsync()  :
updateSMBFileShareVisibility()  :
updateSMBFileShareVisibilityAsync()  :
updateSMBSecurityStrategy()  :
updateSMBSecurityStrategyAsync()  :
updateSnapshotSchedule()  :
updateSnapshotScheduleAsync()  :
updateVTLDeviceType()  :
updateVTLDeviceTypeAsync()  :
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 —

activateGateway()

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

activateGatewayAsync()

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

addCache()

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

addCacheAsync()

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

addUploadBuffer()

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

addUploadBufferAsync()

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

addWorkingStorage()

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

addWorkingStorageAsync()

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

assignTapePool()

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

assignTapePoolAsync()

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

attachVolume()

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

attachVolumeAsync()

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

cancelArchival()

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

cancelArchivalAsync()

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

cancelRetrieval()

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

cancelRetrievalAsync()

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

createCachediSCSIVolume()

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

createCachediSCSIVolumeAsync()

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

createNFSFileShare()

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

createNFSFileShareAsync()

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

createSMBFileShare()

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

createSMBFileShareAsync()

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

createSnapshot()

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

createSnapshotAsync()

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

createSnapshotFromVolumeRecoveryPoint()

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

createSnapshotFromVolumeRecoveryPointAsync()

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

createStorediSCSIVolume()

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

createStorediSCSIVolumeAsync()

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

createTapePool()

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

createTapePoolAsync()

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

createTapes()

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

createTapesAsync()

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

createTapeWithBarcode()

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

createTapeWithBarcodeAsync()

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

deleteAutomaticTapeCreationPolicy()

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

deleteAutomaticTapeCreationPolicyAsync()

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

deleteBandwidthRateLimit()

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

deleteBandwidthRateLimitAsync()

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

deleteChapCredentials()

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

deleteChapCredentialsAsync()

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

deleteFileShare()

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

deleteFileShareAsync()

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

deleteGateway()

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

deleteGatewayAsync()

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

deleteSnapshotSchedule()

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

deleteSnapshotScheduleAsync()

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

deleteTape()

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

deleteTapeArchive()

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

deleteTapeArchiveAsync()

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

deleteTapeAsync()

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

deleteTapePool()

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

deleteTapePoolAsync()

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

deleteVolume()

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

deleteVolumeAsync()

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

describeAvailabilityMonitorTest()

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

describeAvailabilityMonitorTestAsync()

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

describeBandwidthRateLimit()

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

describeBandwidthRateLimitAsync()

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

describeBandwidthRateLimitSchedule()

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

describeBandwidthRateLimitScheduleAsync()

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

describeCache()

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

describeCacheAsync()

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

describeCachediSCSIVolumes()

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

describeCachediSCSIVolumesAsync()

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

describeChapCredentials()

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

describeChapCredentialsAsync()

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

describeGatewayInformation()

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

describeGatewayInformationAsync()

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

describeMaintenanceStartTime()

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

describeMaintenanceStartTimeAsync()

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

describeNFSFileShares()

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

describeNFSFileSharesAsync()

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

describeSMBFileShares()

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

describeSMBFileSharesAsync()

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

describeSMBSettings()

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

describeSMBSettingsAsync()

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

describeSnapshotSchedule()

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

describeSnapshotScheduleAsync()

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

describeStorediSCSIVolumes()

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

describeStorediSCSIVolumesAsync()

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

describeTapeArchives()

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

describeTapeArchivesAsync()

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

describeTapeRecoveryPoints()

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

describeTapeRecoveryPointsAsync()

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

describeTapes()

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

describeTapesAsync()

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

describeUploadBuffer()

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

describeUploadBufferAsync()

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

describeVTLDevices()

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

describeVTLDevicesAsync()

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

describeWorkingStorage()

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

describeWorkingStorageAsync()

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

detachVolume()

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

detachVolumeAsync()

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

disableGateway()

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

disableGatewayAsync()

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

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 —

joinDomain()

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

joinDomainAsync()

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

listAutomaticTapeCreationPolicies()

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

listAutomaticTapeCreationPoliciesAsync()

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

listFileShares()

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

listFileSharesAsync()

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

listGateways()

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

listGatewaysAsync()

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

listLocalDisks()

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

listLocalDisksAsync()

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

listTapePools()

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

listTapePoolsAsync()

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

listTapes()

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

listTapesAsync()

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

listVolumeInitiators()

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

listVolumeInitiatorsAsync()

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

listVolumeRecoveryPoints()

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

listVolumeRecoveryPointsAsync()

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

listVolumes()

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

listVolumesAsync()

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

notifyWhenUploaded()

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

notifyWhenUploadedAsync()

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

refreshCache()

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

refreshCacheAsync()

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

resetCache()

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

resetCacheAsync()

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

retrieveTapeArchive()

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

retrieveTapeArchiveAsync()

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

retrieveTapeRecoveryPoint()

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

retrieveTapeRecoveryPointAsync()

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

setLocalConsolePassword()

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

setLocalConsolePasswordAsync()

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

setSMBGuestPassword()

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

setSMBGuestPasswordAsync()

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

shutdownGateway()

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

shutdownGatewayAsync()

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

startAvailabilityMonitorTest()

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

startAvailabilityMonitorTestAsync()

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

startGateway()

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

startGatewayAsync()

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

updateAutomaticTapeCreationPolicy()

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

updateAutomaticTapeCreationPolicyAsync()

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

updateBandwidthRateLimit()

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

updateBandwidthRateLimitAsync()

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

updateBandwidthRateLimitSchedule()

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

updateBandwidthRateLimitScheduleAsync()

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

updateChapCredentials()

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

updateChapCredentialsAsync()

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

updateGatewayInformation()

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

updateGatewayInformationAsync()

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

updateGatewaySoftwareNow()

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

updateGatewaySoftwareNowAsync()

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

updateMaintenanceStartTime()

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

updateMaintenanceStartTimeAsync()

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

updateNFSFileShare()

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

updateNFSFileShareAsync()

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

updateSMBFileShare()

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

updateSMBFileShareAsync()

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

updateSMBFileShareVisibility()

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

updateSMBFileShareVisibilityAsync()

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

updateSMBSecurityStrategy()

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

updateSMBSecurityStrategyAsync()

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

updateSnapshotSchedule()

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

updateSnapshotScheduleAsync()

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

updateVTLDeviceType()

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

updateVTLDeviceTypeAsync()

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