Documentation

WorkSpacesClient extends AwsClient
in package

Amazon WorkSpaces 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
associateConnectionAlias()  :
associateConnectionAliasAsync()  :
associateIpGroups()  :
associateIpGroupsAsync()  :
authorizeIpRules()  :
authorizeIpRulesAsync()  :
copyWorkspaceImage()  :
copyWorkspaceImageAsync()  :
createConnectionAlias()  :
createConnectionAliasAsync()  :
createIpGroup()  :
createIpGroupAsync()  :
createTags()  :
createTagsAsync()  :
createWorkspaces()  :
createWorkspacesAsync()  :
deleteConnectionAlias()  :
deleteConnectionAliasAsync()  :
deleteIpGroup()  :
deleteIpGroupAsync()  :
deleteTags()  :
deleteTagsAsync()  :
deleteWorkspaceImage()  :
deleteWorkspaceImageAsync()  :
deregisterWorkspaceDirectory()  :
deregisterWorkspaceDirectoryAsync()  :
describeAccount()  :
describeAccountAsync()  :
describeAccountModifications()  :
describeAccountModificationsAsync()  :
describeClientProperties()  :
describeClientPropertiesAsync()  :
describeConnectionAliases()  :
describeConnectionAliasesAsync()  :
describeConnectionAliasPermissions()  :
describeConnectionAliasPermissionsAsync()  :
describeIpGroups()  :
describeIpGroupsAsync()  :
describeTags()  :
describeTagsAsync()  :
describeWorkspaceBundles()  :
describeWorkspaceBundlesAsync()  :
describeWorkspaceDirectories()  :
describeWorkspaceDirectoriesAsync()  :
describeWorkspaceImagePermissions()  :
describeWorkspaceImagePermissionsAsync()  :
describeWorkspaceImages()  :
describeWorkspaceImagesAsync()  :
describeWorkspaces()  :
describeWorkspacesAsync()  :
describeWorkspacesConnectionStatus()  :
describeWorkspacesConnectionStatusAsync()  :
describeWorkspaceSnapshots()  :
describeWorkspaceSnapshotsAsync()  :
disassociateConnectionAlias()  :
disassociateConnectionAliasAsync()  :
disassociateIpGroups()  :
disassociateIpGroupsAsync()  :
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
importWorkspaceImage()  :
importWorkspaceImageAsync()  :
listAvailableManagementCidrRanges()  :
listAvailableManagementCidrRangesAsync()  :
migrateWorkspace()  :
migrateWorkspaceAsync()  :
modifyAccount()  :
modifyAccountAsync()  :
modifyClientProperties()  :
modifyClientPropertiesAsync()  :
modifySelfservicePermissions()  :
modifySelfservicePermissionsAsync()  :
modifyWorkspaceAccessProperties()  :
modifyWorkspaceAccessPropertiesAsync()  :
modifyWorkspaceCreationProperties()  :
modifyWorkspaceCreationPropertiesAsync()  :
modifyWorkspaceProperties()  :
modifyWorkspacePropertiesAsync()  :
modifyWorkspaceState()  :
modifyWorkspaceStateAsync()  :
rebootWorkspaces()  :
rebootWorkspacesAsync()  :
rebuildWorkspaces()  :
rebuildWorkspacesAsync()  :
registerWorkspaceDirectory()  :
registerWorkspaceDirectoryAsync()  :
restoreWorkspace()  :
restoreWorkspaceAsync()  :
revokeIpRules()  :
revokeIpRulesAsync()  :
startWorkspaces()  :
startWorkspacesAsync()  :
stopWorkspaces()  :
stopWorkspacesAsync()  :
terminateWorkspaces()  :
terminateWorkspacesAsync()  :
updateConnectionAliasPermission()  :
updateConnectionAliasPermissionAsync()  :
updateRulesOfIpGroup()  :
updateRulesOfIpGroupAsync()  :
updateWorkspaceImagePermission()  :
updateWorkspaceImagePermissionAsync()  :
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

associateConnectionAlias()

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

associateConnectionAliasAsync()

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

associateIpGroups()

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

associateIpGroupsAsync()

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

authorizeIpRules()

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

authorizeIpRulesAsync()

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

copyWorkspaceImage()

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

copyWorkspaceImageAsync()

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

createConnectionAlias()

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

createConnectionAliasAsync()

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

createIpGroup()

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

createIpGroupAsync()

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

createTags()

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

createTagsAsync()

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

createWorkspaces()

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

createWorkspacesAsync()

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

deleteConnectionAlias()

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

deleteConnectionAliasAsync()

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

deleteIpGroup()

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

deleteIpGroupAsync()

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

deleteTags()

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

deleteTagsAsync()

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

deleteWorkspaceImage()

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

deleteWorkspaceImageAsync()

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

deregisterWorkspaceDirectory()

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

deregisterWorkspaceDirectoryAsync()

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

describeAccount()

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

describeAccountAsync()

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

describeAccountModifications()

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

describeAccountModificationsAsync()

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

describeClientProperties()

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

describeClientPropertiesAsync()

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

describeConnectionAliases()

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

describeConnectionAliasesAsync()

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

describeConnectionAliasPermissions()

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

describeConnectionAliasPermissionsAsync()

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

describeIpGroups()

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

describeIpGroupsAsync()

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

describeTags()

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

describeTagsAsync()

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

describeWorkspaceBundles()

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

describeWorkspaceBundlesAsync()

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

describeWorkspaceDirectories()

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

describeWorkspaceDirectoriesAsync()

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

describeWorkspaceImagePermissions()

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

describeWorkspaceImagePermissionsAsync()

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

describeWorkspaceImages()

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

describeWorkspaceImagesAsync()

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

describeWorkspaces()

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

describeWorkspacesAsync()

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

describeWorkspacesConnectionStatus()

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

describeWorkspacesConnectionStatusAsync()

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

describeWorkspaceSnapshots()

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

describeWorkspaceSnapshotsAsync()

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

disassociateConnectionAlias()

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

disassociateConnectionAliasAsync()

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

disassociateIpGroups()

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

disassociateIpGroupsAsync()

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

importWorkspaceImage()

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

importWorkspaceImageAsync()

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

listAvailableManagementCidrRanges()

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

listAvailableManagementCidrRangesAsync()

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

migrateWorkspace()

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

migrateWorkspaceAsync()

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

modifyAccount()

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

modifyAccountAsync()

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

modifyClientProperties()

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

modifyClientPropertiesAsync()

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

modifySelfservicePermissions()

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

modifySelfservicePermissionsAsync()

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

modifyWorkspaceAccessProperties()

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

modifyWorkspaceAccessPropertiesAsync()

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

modifyWorkspaceCreationProperties()

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

modifyWorkspaceCreationPropertiesAsync()

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

modifyWorkspaceProperties()

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

modifyWorkspacePropertiesAsync()

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

modifyWorkspaceState()

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

modifyWorkspaceStateAsync()

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

rebootWorkspaces()

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

rebootWorkspacesAsync()

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

rebuildWorkspaces()

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

rebuildWorkspacesAsync()

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

registerWorkspaceDirectory()

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

registerWorkspaceDirectoryAsync()

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

restoreWorkspace()

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

restoreWorkspaceAsync()

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

revokeIpRules()

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

revokeIpRulesAsync()

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

startWorkspaces()

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

startWorkspacesAsync()

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

stopWorkspaces()

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

stopWorkspacesAsync()

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

terminateWorkspaces()

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

terminateWorkspacesAsync()

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

updateConnectionAliasPermission()

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

updateConnectionAliasPermissionAsync()

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

updateRulesOfIpGroup()

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

updateRulesOfIpGroupAsync()

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

updateWorkspaceImagePermission()

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

updateWorkspaceImagePermissionAsync()

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