SDK for PHP 3.x

WorkSpacesClient extends AwsClient
in package

Amazon WorkSpaces client.

Table of Contents

Methods

__call()  : mixed
__construct()  : mixed
The client constructor accepts the following options:
__sleep()  : mixed
acceptAccountLinkInvitation()  : Result
acceptAccountLinkInvitationAsync()  : Promise
associateConnectionAlias()  : Result
associateConnectionAliasAsync()  : Promise
associateIpGroups()  : Result
associateIpGroupsAsync()  : Promise
associateWorkspaceApplication()  : Result
associateWorkspaceApplicationAsync()  : Promise
authorizeIpRules()  : Result
authorizeIpRulesAsync()  : Promise
copyWorkspaceImage()  : Result
copyWorkspaceImageAsync()  : Promise
createAccountLinkInvitation()  : Result
createAccountLinkInvitationAsync()  : Promise
createConnectClientAddIn()  : Result
createConnectClientAddInAsync()  : Promise
createConnectionAlias()  : Result
createConnectionAliasAsync()  : Promise
createIpGroup()  : Result
createIpGroupAsync()  : Promise
createStandbyWorkspaces()  : Result
createStandbyWorkspacesAsync()  : Promise
createTags()  : Result
createTagsAsync()  : Promise
createUpdatedWorkspaceImage()  : Result
createUpdatedWorkspaceImageAsync()  : Promise
createWorkspaceBundle()  : Result
createWorkspaceBundleAsync()  : Promise
createWorkspaceImage()  : Result
createWorkspaceImageAsync()  : Promise
createWorkspaces()  : Result
createWorkspacesAsync()  : Promise
deleteAccountLinkInvitation()  : Result
deleteAccountLinkInvitationAsync()  : Promise
deleteClientBranding()  : Result
deleteClientBrandingAsync()  : Promise
deleteConnectClientAddIn()  : Result
deleteConnectClientAddInAsync()  : Promise
deleteConnectionAlias()  : Result
deleteConnectionAliasAsync()  : Promise
deleteIpGroup()  : Result
deleteIpGroupAsync()  : Promise
deleteTags()  : Result
deleteTagsAsync()  : Promise
deleteWorkspaceBundle()  : Result
deleteWorkspaceBundleAsync()  : Promise
deleteWorkspaceImage()  : Result
deleteWorkspaceImageAsync()  : Promise
deployWorkspaceApplications()  : Result
deployWorkspaceApplicationsAsync()  : Promise
deregisterWorkspaceDirectory()  : Result
deregisterWorkspaceDirectoryAsync()  : Promise
describeAccount()  : Result
describeAccountAsync()  : Promise
describeAccountModifications()  : Result
describeAccountModificationsAsync()  : Promise
describeApplicationAssociations()  : Result
describeApplicationAssociationsAsync()  : Promise
describeApplications()  : Result
describeApplicationsAsync()  : Promise
describeBundleAssociations()  : Result
describeBundleAssociationsAsync()  : Promise
describeClientBranding()  : Result
describeClientBrandingAsync()  : Promise
describeClientProperties()  : Result
describeClientPropertiesAsync()  : Promise
describeConnectClientAddIns()  : Result
describeConnectClientAddInsAsync()  : Promise
describeConnectionAliases()  : Result
describeConnectionAliasesAsync()  : Promise
describeConnectionAliasPermissions()  : Result
describeConnectionAliasPermissionsAsync()  : Promise
describeImageAssociations()  : Result
describeImageAssociationsAsync()  : Promise
describeIpGroups()  : Result
describeIpGroupsAsync()  : Promise
describeTags()  : Result
describeTagsAsync()  : Promise
describeWorkspaceAssociations()  : Result
describeWorkspaceAssociationsAsync()  : Promise
describeWorkspaceBundles()  : Result
describeWorkspaceBundlesAsync()  : Promise
describeWorkspaceDirectories()  : Result
describeWorkspaceDirectoriesAsync()  : Promise
describeWorkspaceImagePermissions()  : Result
describeWorkspaceImagePermissionsAsync()  : Promise
describeWorkspaceImages()  : Result
describeWorkspaceImagesAsync()  : Promise
describeWorkspaces()  : Result
describeWorkspacesAsync()  : Promise
describeWorkspacesConnectionStatus()  : Result
describeWorkspacesConnectionStatusAsync()  : Promise
describeWorkspaceSnapshots()  : Result
describeWorkspaceSnapshotsAsync()  : Promise
disassociateConnectionAlias()  : Result
disassociateConnectionAliasAsync()  : Promise
disassociateIpGroups()  : Result
disassociateIpGroupsAsync()  : Promise
disassociateWorkspaceApplication()  : Result
disassociateWorkspaceApplicationAsync()  : Promise
emitDeprecationWarning()  : mixed
execute()  : mixed
executeAsync()  : mixed
factory()  : static
getAccountLink()  : Result
getAccountLinkAsync()  : Promise
getApi()  : Service
getArguments()  : array<string|int, mixed>
Get an array of client constructor arguments used by the client.
getClientBuiltIns()  : array<string|int, mixed>
Provides the set of built-in keys and values used for endpoint resolution
getClientContextParams()  : array<string|int, mixed>
Provides the set of service context parameter key-value pairs used for endpoint resolution.
getCommand()  : CommandInterface
getConfig()  : mixed|null
Get a client configuration value.
getCredentials()  : PromiseInterface
Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.
getEndpoint()  : UriInterface
Gets the default endpoint, or base URL, used by the client.
getEndpointProvider()  : mixed
getEndpointProviderArgs()  : array<string|int, mixed>
Retrieves arguments to be used in endpoint resolution.
getHandlerList()  : HandlerList
Get the handler list used to transfer commands.
getIterator()  : mixed
getPaginator()  : mixed
getRegion()  : string
Get the region to which the client is configured to send requests.
getSignatureProvider()  : callable
Get the signature_provider function of the client.
getWaiter()  : mixed
importClientBranding()  : Result
importClientBrandingAsync()  : Promise
importWorkspaceImage()  : Result
importWorkspaceImageAsync()  : Promise
listAccountLinks()  : Result
listAccountLinksAsync()  : Promise
listAvailableManagementCidrRanges()  : Result
listAvailableManagementCidrRangesAsync()  : Promise
migrateWorkspace()  : Result
migrateWorkspaceAsync()  : Promise
modifyAccount()  : Result
modifyAccountAsync()  : Promise
modifyCertificateBasedAuthProperties()  : Result
modifyCertificateBasedAuthPropertiesAsync()  : Promise
modifyClientProperties()  : Result
modifyClientPropertiesAsync()  : Promise
modifySamlProperties()  : Result
modifySamlPropertiesAsync()  : Promise
modifySelfservicePermissions()  : Result
modifySelfservicePermissionsAsync()  : Promise
modifyWorkspaceAccessProperties()  : Result
modifyWorkspaceAccessPropertiesAsync()  : Promise
modifyWorkspaceCreationProperties()  : Result
modifyWorkspaceCreationPropertiesAsync()  : Promise
modifyWorkspaceProperties()  : Result
modifyWorkspacePropertiesAsync()  : Promise
modifyWorkspaceState()  : Result
modifyWorkspaceStateAsync()  : Promise
rebootWorkspaces()  : Result
rebootWorkspacesAsync()  : Promise
rebuildWorkspaces()  : Result
rebuildWorkspacesAsync()  : Promise
registerWorkspaceDirectory()  : Result
registerWorkspaceDirectoryAsync()  : Promise
rejectAccountLinkInvitation()  : Result
rejectAccountLinkInvitationAsync()  : Promise
restoreWorkspace()  : Result
restoreWorkspaceAsync()  : Promise
revokeIpRules()  : Result
revokeIpRulesAsync()  : Promise
startWorkspaces()  : Result
startWorkspacesAsync()  : Promise
stopWorkspaces()  : Result
stopWorkspacesAsync()  : Promise
terminateWorkspaces()  : Result
terminateWorkspacesAsync()  : Promise
updateConnectClientAddIn()  : Result
updateConnectClientAddInAsync()  : Promise
updateConnectionAliasPermission()  : Result
updateConnectionAliasPermissionAsync()  : Promise
updateRulesOfIpGroup()  : Result
updateRulesOfIpGroupAsync()  : Promise
updateWorkspaceBundle()  : Result
updateWorkspaceBundleAsync()  : Promise
updateWorkspaceImagePermission()  : Result
updateWorkspaceImagePermissionAsync()  : Promise
waitUntil()  : mixed

Methods

__call()

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

__construct()

The client constructor accepts the following options:

public __construct(array<string|int, mixed> $args) : mixed
  • api_provider: (callable) An optional PHP callable that accepts a type, service, and version argument, and returns an array of corresponding configuration data. The type value can be one of api, waiter, or paginator.
  • credentials: (Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies the credentials used to sign requests. Provide an Aws\Credentials\CredentialsInterface object, an associative array of "key", "secret", and an optional "token" key, false to use null credentials, or a callable credentials provider used to create credentials or return null. See Aws\Credentials\CredentialProvider for a list of built-in credentials providers. If no credentials are provided, the SDK will attempt to load them from the environment.
  • token: (Aws\Token\TokenInterface|array|bool|callable) Specifies the token used to authorize requests. Provide an Aws\Token\TokenInterface object, an associative array of "token" and an optional "expires" key, false to use no token, or a callable token provider used to create a token or return null. See Aws\Token\TokenProvider for a list of built-in token providers. If no token is provided, the SDK will attempt to load one from the environment.
  • csm: (Aws\ClientSideMonitoring\ConfigurationInterface|array|callable) Specifies the credentials used to sign requests. Provide an Aws\ClientSideMonitoring\ConfigurationInterface object, a callable configuration provider used to create client-side monitoring configuration, false to disable csm, or an associative array with the following keys: enabled: (bool) Set to true to enable client-side monitoring, defaults to false; host: (string) the host location to send monitoring events to, defaults to 127.0.0.1; port: (int) The port used for the host connection, defaults to 31000; client_id: (string) An identifier for this project
  • debug: (bool|array) Set to true to display debug information when sending requests. Alternatively, you can provide an associative array with the following keys: logfn: (callable) Function that is invoked with log messages; stream_size: (int) When the size of a stream is greater than this number, the stream data will not be logged (set to "0" to not log any stream data); scrub_auth: (bool) Set to false to disable the scrubbing of auth data from the logged messages; http: (bool) Set to false to disable the "debug" feature of lower level HTTP adapters (e.g., verbose curl output).
  • stats: (bool|array) Set to true to gather transfer statistics on requests sent. Alternatively, you can provide an associative array with the following keys: retries: (bool) Set to false to disable reporting on retries attempted; http: (bool) Set to true to enable collecting statistics from lower level HTTP adapters (e.g., values returned in GuzzleHttp\TransferStats). HTTP handlers must support an http_stats_receiver option for this to have an effect; timer: (bool) Set to true to enable a command timer that reports the total wall clock time spent on an operation in seconds.
  • disable_host_prefix_injection: (bool) Set to true to disable host prefix injection logic for services that use it. This disables the entire prefix injection, including the portions supplied by user-defined parameters. Setting this flag will have no effect on services that do not use host prefix injection.
  • endpoint: (string) The full URI of the webservice. This is only required when connecting to a custom endpoint (e.g., a local version of S3).
  • endpoint_discovery: (Aws\EndpointDiscovery\ConfigurationInterface, Aws\CacheInterface, array, callable) Settings for endpoint discovery. Provide an instance of Aws\EndpointDiscovery\ConfigurationInterface, an instance Aws\CacheInterface, a callable that provides a promise for a Configuration object, or an associative array with the following keys: enabled: (bool) Set to true to enable endpoint discovery, false to explicitly disable it, defaults to false; cache_limit: (int) The maximum number of keys in the endpoints cache, defaults to 1000.
  • endpoint_provider: (callable) An optional PHP callable that accepts a hash of options including a "service" and "region" key and returns NULL or a hash of endpoint data, of which the "endpoint" key is required. See Aws\Endpoint\EndpointProvider for a list of built-in providers.
  • handler: (callable) A handler that accepts a command object, request object and returns a promise that is fulfilled with an Aws\ResultInterface object or rejected with an Aws\Exception\AwsException. A handler does not accept a next handler as it is terminal and expected to fulfill a command. If no handler is provided, a default Guzzle handler will be utilized.
  • http: (array, default=array(0)) Set to an array of SDK request options to apply to each request (e.g., proxy, verify, etc.).
  • http_handler: (callable) An HTTP handler is a function that accepts a PSR-7 request object and returns a promise that is fulfilled with a PSR-7 response object or rejected with an array of exception data. NOTE: This option supersedes any provided "handler" option.
  • idempotency_auto_fill: (bool|callable) Set to false to disable SDK to populate parameters that enabled 'idempotencyToken' trait with a random UUID v4 value on your behalf. Using default value 'true' still allows parameter value to be overwritten when provided. Note: auto-fill only works when cryptographically secure random bytes generator functions (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be found. You may also provide a callable source of random bytes.
  • profile: (string) Allows you to specify which profile to use when credentials are created from the AWS credentials file in your HOME directory. This setting overrides the AWS_PROFILE environment variable. Note: Specifying "profile" will cause the "credentials" key to be ignored.
  • region: (string, required) Region to connect to. See http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of available regions.
  • retries: (int, Aws\Retry\ConfigurationInterface, Aws\CacheInterface, array, callable) Configures the retry mode and maximum number of allowed retries for a client (pass 0 to disable retries). Provide an integer for 'legacy' mode with the specified number of retries. Otherwise provide an instance of Aws\Retry\ConfigurationInterface, an instance of Aws\CacheInterface, a callable function, or an array with the following keys: mode: (string) Set to 'legacy', 'standard' (uses retry quota management), or 'adapative' (an experimental mode that adds client-side rate limiting to standard mode); max_attempts (int) The maximum number of attempts for a given request.
  • scheme: (string, default=string(5) "https") URI scheme to use when connecting connect. The SDK will utilize "https" endpoints (i.e., utilize SSL/TLS connections) by default. You can attempt to connect to a service over an unencrypted "http" endpoint by setting scheme to "http".
  • signature_provider: (callable) A callable that accepts a signature version name (e.g., "v4"), a service name, and region, and returns a SignatureInterface object or null. This provider is used to create signers utilized by the client. See Aws\Signature\SignatureProvider for a list of built-in providers
  • signature_version: (string) A string representing a custom signature version to use with a service (e.g., v4). Note that per/operation signature version MAY override this requested signature version.
  • use_aws_shared_config_files: (bool, default=bool(true)) Set to false to disable checking for shared config file in '~/.aws/config' and '~/.aws/credentials'. This will override the AWS_CONFIG_FILE environment variable.
  • validate: (bool, default=bool(true)) Set to false to disable client-side parameter validation.
  • version: (string, required) The version of the webservice to utilize (e.g., 2006-03-01).
  • ua_append: (string, array) To pass custom user agent parameters.
  • app_id: (string) an optional application specific identifier that can be set. When set it will be appended to the User-Agent header of every request in the form of App/{AppId}. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. See https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html for more information on environment variables and shared config settings.
Parameters
$args : array<string|int, mixed>

Client configuration arguments.

Tags
throws
InvalidArgumentException

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

__sleep()

public __sleep() : mixed

acceptAccountLinkInvitation()

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

acceptAccountLinkInvitationAsync()

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

associateConnectionAlias()

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

associateConnectionAliasAsync()

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

associateIpGroups()

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

associateIpGroupsAsync()

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

associateWorkspaceApplication()

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

associateWorkspaceApplicationAsync()

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

authorizeIpRules()

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

authorizeIpRulesAsync()

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

copyWorkspaceImage()

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

copyWorkspaceImageAsync()

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

createAccountLinkInvitation()

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

createAccountLinkInvitationAsync()

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

createConnectClientAddIn()

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

createConnectClientAddInAsync()

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

createConnectionAlias()

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

createConnectionAliasAsync()

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

createIpGroup()

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

createIpGroupAsync()

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

createStandbyWorkspaces()

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

createStandbyWorkspacesAsync()

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

createTags()

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

createTagsAsync()

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

createUpdatedWorkspaceImage()

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

createUpdatedWorkspaceImageAsync()

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

createWorkspaceBundle()

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

createWorkspaceBundleAsync()

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

createWorkspaceImage()

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

createWorkspaceImageAsync()

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

createWorkspaces()

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

createWorkspacesAsync()

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

deleteAccountLinkInvitation()

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

deleteAccountLinkInvitationAsync()

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

deleteClientBranding()

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

deleteClientBrandingAsync()

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

deleteConnectClientAddIn()

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

deleteConnectClientAddInAsync()

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

deleteConnectionAlias()

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

deleteConnectionAliasAsync()

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

deleteIpGroup()

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

deleteIpGroupAsync()

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

deleteTags()

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

deleteTagsAsync()

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

deleteWorkspaceBundle()

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

deleteWorkspaceBundleAsync()

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

deleteWorkspaceImage()

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

deleteWorkspaceImageAsync()

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

deployWorkspaceApplications()

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

deployWorkspaceApplicationsAsync()

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

deregisterWorkspaceDirectory()

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

deregisterWorkspaceDirectoryAsync()

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

describeAccount()

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

describeAccountAsync()

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

describeAccountModifications()

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

describeAccountModificationsAsync()

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

describeApplicationAssociations()

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

describeApplicationAssociationsAsync()

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

describeApplications()

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

describeApplicationsAsync()

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

describeBundleAssociations()

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

describeBundleAssociationsAsync()

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

describeClientBranding()

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

describeClientBrandingAsync()

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

describeClientProperties()

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

describeClientPropertiesAsync()

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

describeConnectClientAddIns()

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

describeConnectClientAddInsAsync()

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

describeConnectionAliases()

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

describeConnectionAliasesAsync()

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

describeConnectionAliasPermissions()

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

describeConnectionAliasPermissionsAsync()

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

describeImageAssociations()

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

describeImageAssociationsAsync()

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

describeIpGroups()

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

describeIpGroupsAsync()

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

describeTags()

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

describeTagsAsync()

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

describeWorkspaceAssociations()

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

describeWorkspaceAssociationsAsync()

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

describeWorkspaceBundles()

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

describeWorkspaceBundlesAsync()

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

describeWorkspaceDirectories()

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

describeWorkspaceDirectoriesAsync()

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

describeWorkspaceImagePermissions()

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

describeWorkspaceImagePermissionsAsync()

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

describeWorkspaceImages()

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

describeWorkspaceImagesAsync()

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

describeWorkspaces()

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

describeWorkspacesAsync()

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

describeWorkspacesConnectionStatus()

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

describeWorkspacesConnectionStatusAsync()

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

describeWorkspaceSnapshots()

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

describeWorkspaceSnapshotsAsync()

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

disassociateConnectionAlias()

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

disassociateConnectionAliasAsync()

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

disassociateIpGroups()

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

disassociateIpGroupsAsync()

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

disassociateWorkspaceApplication()

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

disassociateWorkspaceApplicationAsync()

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

emitDeprecationWarning()

public static emitDeprecationWarning() : mixed

factory()

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

getAccountLink()

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

getAccountLinkAsync()

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

getArguments()

Get an array of client constructor arguments used by the client.

public static getArguments() : array<string|int, mixed>
Return values
array<string|int, mixed>

getClientBuiltIns()

Provides the set of built-in keys and values used for endpoint resolution

public getClientBuiltIns() : array<string|int, mixed>
Return values
array<string|int, mixed>

getClientContextParams()

Provides the set of service context parameter key-value pairs used for endpoint resolution.

public getClientContextParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

getCommand()

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

getConfig()

Get a client configuration value.

public getConfig([mixed $option = null ]) : mixed|null
Parameters
$option : mixed = null

The option to retrieve. Pass null to retrieve all options.

Return values
mixed|null

getCredentials()

Returns a promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface} object.

public getCredentials() : PromiseInterface

If you need the credentials synchronously, then call the wait() method on the returned promise.

Return values
PromiseInterface

getEndpoint()

Gets the default endpoint, or base URL, used by the client.

public getEndpoint() : UriInterface
Return values
UriInterface

getEndpointProvider()

public getEndpointProvider() : mixed

getEndpointProviderArgs()

Retrieves arguments to be used in endpoint resolution.

public getEndpointProviderArgs() : array<string|int, mixed>
Return values
array<string|int, mixed>

getHandlerList()

Get the handler list used to transfer commands.

public getHandlerList() : HandlerList

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

Return values
HandlerList

getIterator()

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

getPaginator()

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

getRegion()

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

public getRegion() : string
Return values
string

getSignatureProvider()

Get the signature_provider function of the client.

public final getSignatureProvider() : callable
Return values
callable

getWaiter()

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

importClientBranding()

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

importClientBrandingAsync()

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

importWorkspaceImage()

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

importWorkspaceImageAsync()

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

listAccountLinks()

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

listAccountLinksAsync()

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

listAvailableManagementCidrRanges()

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

listAvailableManagementCidrRangesAsync()

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

migrateWorkspace()

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

migrateWorkspaceAsync()

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

modifyAccount()

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

modifyAccountAsync()

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

modifyCertificateBasedAuthProperties()

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

modifyCertificateBasedAuthPropertiesAsync()

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

modifyClientProperties()

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

modifyClientPropertiesAsync()

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

modifySamlProperties()

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

modifySamlPropertiesAsync()

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

modifySelfservicePermissions()

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

modifySelfservicePermissionsAsync()

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

modifyWorkspaceAccessProperties()

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

modifyWorkspaceAccessPropertiesAsync()

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

modifyWorkspaceCreationProperties()

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

modifyWorkspaceCreationPropertiesAsync()

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

modifyWorkspaceProperties()

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

modifyWorkspacePropertiesAsync()

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

modifyWorkspaceState()

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

modifyWorkspaceStateAsync()

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

rebootWorkspaces()

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

rebootWorkspacesAsync()

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

rebuildWorkspaces()

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

rebuildWorkspacesAsync()

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

registerWorkspaceDirectory()

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

registerWorkspaceDirectoryAsync()

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

rejectAccountLinkInvitation()

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

rejectAccountLinkInvitationAsync()

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

restoreWorkspace()

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

restoreWorkspaceAsync()

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

revokeIpRules()

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

revokeIpRulesAsync()

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

startWorkspaces()

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

startWorkspacesAsync()

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

stopWorkspaces()

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

stopWorkspacesAsync()

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

terminateWorkspaces()

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

terminateWorkspacesAsync()

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

updateConnectClientAddIn()

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

updateConnectClientAddInAsync()

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

updateConnectionAliasPermission()

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

updateConnectionAliasPermissionAsync()

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

updateRulesOfIpGroup()

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

updateRulesOfIpGroupAsync()

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

updateWorkspaceBundle()

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

updateWorkspaceBundleAsync()

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

updateWorkspaceImagePermission()

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

updateWorkspaceImagePermissionAsync()

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

waitUntil()

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