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
__sleep()
public
__sleep() : mixed
acceptAccountLinkInvitation()
public
acceptAccountLinkInvitation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultacceptAccountLinkInvitationAsync()
public
acceptAccountLinkInvitationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseassociateConnectionAlias()
public
associateConnectionAlias(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultassociateConnectionAliasAsync()
public
associateConnectionAliasAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseassociateIpGroups()
public
associateIpGroups(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultassociateIpGroupsAsync()
public
associateIpGroupsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseassociateWorkspaceApplication()
public
associateWorkspaceApplication(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultassociateWorkspaceApplicationAsync()
public
associateWorkspaceApplicationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseauthorizeIpRules()
public
authorizeIpRules(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultauthorizeIpRulesAsync()
public
authorizeIpRulesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecopyWorkspaceImage()
public
copyWorkspaceImage(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcopyWorkspaceImageAsync()
public
copyWorkspaceImageAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateAccountLinkInvitation()
public
createAccountLinkInvitation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateAccountLinkInvitationAsync()
public
createAccountLinkInvitationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateConnectClientAddIn()
public
createConnectClientAddIn(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateConnectClientAddInAsync()
public
createConnectClientAddInAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateConnectionAlias()
public
createConnectionAlias(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateConnectionAliasAsync()
public
createConnectionAliasAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateIpGroup()
public
createIpGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateIpGroupAsync()
public
createIpGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateStandbyWorkspaces()
public
createStandbyWorkspaces(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateStandbyWorkspacesAsync()
public
createStandbyWorkspacesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateTags()
public
createTags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateTagsAsync()
public
createTagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateUpdatedWorkspaceImage()
public
createUpdatedWorkspaceImage(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateUpdatedWorkspaceImageAsync()
public
createUpdatedWorkspaceImageAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateWorkspaceBundle()
public
createWorkspaceBundle(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateWorkspaceBundleAsync()
public
createWorkspaceBundleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateWorkspaceImage()
public
createWorkspaceImage(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateWorkspaceImageAsync()
public
createWorkspaceImageAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisecreateWorkspaces()
public
createWorkspaces(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultcreateWorkspacesAsync()
public
createWorkspacesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteAccountLinkInvitation()
public
deleteAccountLinkInvitation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteAccountLinkInvitationAsync()
public
deleteAccountLinkInvitationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteClientBranding()
public
deleteClientBranding(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteClientBrandingAsync()
public
deleteClientBrandingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteConnectClientAddIn()
public
deleteConnectClientAddIn(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteConnectClientAddInAsync()
public
deleteConnectClientAddInAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteConnectionAlias()
public
deleteConnectionAlias(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteConnectionAliasAsync()
public
deleteConnectionAliasAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteIpGroup()
public
deleteIpGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteIpGroupAsync()
public
deleteIpGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteTags()
public
deleteTags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteTagsAsync()
public
deleteTagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteWorkspaceBundle()
public
deleteWorkspaceBundle(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteWorkspaceBundleAsync()
public
deleteWorkspaceBundleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeleteWorkspaceImage()
public
deleteWorkspaceImage(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeleteWorkspaceImageAsync()
public
deleteWorkspaceImageAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedeployWorkspaceApplications()
public
deployWorkspaceApplications(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdeployWorkspaceApplicationsAsync()
public
deployWorkspaceApplicationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisederegisterWorkspaceDirectory()
public
deregisterWorkspaceDirectory(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultderegisterWorkspaceDirectoryAsync()
public
deregisterWorkspaceDirectoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeAccount()
public
describeAccount(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeAccountAsync()
public
describeAccountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeAccountModifications()
public
describeAccountModifications(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeAccountModificationsAsync()
public
describeAccountModificationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeApplicationAssociations()
public
describeApplicationAssociations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeApplicationAssociationsAsync()
public
describeApplicationAssociationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeApplications()
public
describeApplications(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeApplicationsAsync()
public
describeApplicationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeBundleAssociations()
public
describeBundleAssociations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeBundleAssociationsAsync()
public
describeBundleAssociationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeClientBranding()
public
describeClientBranding(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeClientBrandingAsync()
public
describeClientBrandingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeClientProperties()
public
describeClientProperties(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeClientPropertiesAsync()
public
describeClientPropertiesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeConnectClientAddIns()
public
describeConnectClientAddIns(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeConnectClientAddInsAsync()
public
describeConnectClientAddInsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeConnectionAliases()
public
describeConnectionAliases(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeConnectionAliasesAsync()
public
describeConnectionAliasesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeConnectionAliasPermissions()
public
describeConnectionAliasPermissions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeConnectionAliasPermissionsAsync()
public
describeConnectionAliasPermissionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeImageAssociations()
public
describeImageAssociations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeImageAssociationsAsync()
public
describeImageAssociationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeIpGroups()
public
describeIpGroups(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeIpGroupsAsync()
public
describeIpGroupsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeTags()
public
describeTags(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeTagsAsync()
public
describeTagsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeWorkspaceAssociations()
public
describeWorkspaceAssociations(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeWorkspaceAssociationsAsync()
public
describeWorkspaceAssociationsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeWorkspaceBundles()
public
describeWorkspaceBundles(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeWorkspaceBundlesAsync()
public
describeWorkspaceBundlesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeWorkspaceDirectories()
public
describeWorkspaceDirectories(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeWorkspaceDirectoriesAsync()
public
describeWorkspaceDirectoriesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeWorkspaceImagePermissions()
public
describeWorkspaceImagePermissions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeWorkspaceImagePermissionsAsync()
public
describeWorkspaceImagePermissionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeWorkspaceImages()
public
describeWorkspaceImages(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeWorkspaceImagesAsync()
public
describeWorkspaceImagesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeWorkspaces()
public
describeWorkspaces(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeWorkspacesAsync()
public
describeWorkspacesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeWorkspacesConnectionStatus()
public
describeWorkspacesConnectionStatus(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeWorkspacesConnectionStatusAsync()
public
describeWorkspacesConnectionStatusAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedescribeWorkspaceSnapshots()
public
describeWorkspaceSnapshots(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdescribeWorkspaceSnapshotsAsync()
public
describeWorkspaceSnapshotsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedisassociateConnectionAlias()
public
disassociateConnectionAlias(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdisassociateConnectionAliasAsync()
public
disassociateConnectionAliasAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedisassociateIpGroups()
public
disassociateIpGroups(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdisassociateIpGroupsAsync()
public
disassociateIpGroupsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisedisassociateWorkspaceApplication()
public
disassociateWorkspaceApplication(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultdisassociateWorkspaceApplicationAsync()
public
disassociateWorkspaceApplicationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseemitDeprecationWarning()
public
static emitDeprecationWarning() : mixed
execute()
public
execute(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
executeAsync()
public
executeAsync(CommandInterface $command) : mixed
Parameters
- $command : CommandInterface
factory()
public
static factory([array<string|int, mixed> $config = [] ]) : static
Parameters
- $config : array<string|int, mixed> = []
Tags
Return values
staticgetAccountLink()
public
getAccountLink(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultgetAccountLinkAsync()
public
getAccountLinkAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisegetApi()
public
abstract getApi() : Service
Return values
ServicegetArguments()
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
CommandInterfacegetConfig()
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|nullgetCredentials()
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
PromiseInterfacegetEndpoint()
Gets the default endpoint, or base URL, used by the client.
public
getEndpoint() : UriInterface
Return values
UriInterfacegetEndpointProvider()
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
HandlerListgetIterator()
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
stringgetSignatureProvider()
Get the signature_provider function of the client.
public
final getSignatureProvider() : callable
Return values
callablegetWaiter()
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
ResultimportClientBrandingAsync()
public
importClientBrandingAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseimportWorkspaceImage()
public
importWorkspaceImage(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultimportWorkspaceImageAsync()
public
importWorkspaceImageAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistAccountLinks()
public
listAccountLinks(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistAccountLinksAsync()
public
listAccountLinksAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiselistAvailableManagementCidrRanges()
public
listAvailableManagementCidrRanges(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultlistAvailableManagementCidrRangesAsync()
public
listAvailableManagementCidrRangesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisemigrateWorkspace()
public
migrateWorkspace(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultmigrateWorkspaceAsync()
public
migrateWorkspaceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisemodifyAccount()
public
modifyAccount(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultmodifyAccountAsync()
public
modifyAccountAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisemodifyCertificateBasedAuthProperties()
public
modifyCertificateBasedAuthProperties(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultmodifyCertificateBasedAuthPropertiesAsync()
public
modifyCertificateBasedAuthPropertiesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisemodifyClientProperties()
public
modifyClientProperties(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultmodifyClientPropertiesAsync()
public
modifyClientPropertiesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisemodifySamlProperties()
public
modifySamlProperties(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultmodifySamlPropertiesAsync()
public
modifySamlPropertiesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisemodifySelfservicePermissions()
public
modifySelfservicePermissions(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultmodifySelfservicePermissionsAsync()
public
modifySelfservicePermissionsAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisemodifyWorkspaceAccessProperties()
public
modifyWorkspaceAccessProperties(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultmodifyWorkspaceAccessPropertiesAsync()
public
modifyWorkspaceAccessPropertiesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisemodifyWorkspaceCreationProperties()
public
modifyWorkspaceCreationProperties(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultmodifyWorkspaceCreationPropertiesAsync()
public
modifyWorkspaceCreationPropertiesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisemodifyWorkspaceProperties()
public
modifyWorkspaceProperties(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultmodifyWorkspacePropertiesAsync()
public
modifyWorkspacePropertiesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisemodifyWorkspaceState()
public
modifyWorkspaceState(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultmodifyWorkspaceStateAsync()
public
modifyWorkspaceStateAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiserebootWorkspaces()
public
rebootWorkspaces(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultrebootWorkspacesAsync()
public
rebootWorkspacesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiserebuildWorkspaces()
public
rebuildWorkspaces(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultrebuildWorkspacesAsync()
public
rebuildWorkspacesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseregisterWorkspaceDirectory()
public
registerWorkspaceDirectory(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultregisterWorkspaceDirectoryAsync()
public
registerWorkspaceDirectoryAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiserejectAccountLinkInvitation()
public
rejectAccountLinkInvitation(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultrejectAccountLinkInvitationAsync()
public
rejectAccountLinkInvitationAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiserestoreWorkspace()
public
restoreWorkspace(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultrestoreWorkspaceAsync()
public
restoreWorkspaceAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiserevokeIpRules()
public
revokeIpRules(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultrevokeIpRulesAsync()
public
revokeIpRulesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestartWorkspaces()
public
startWorkspaces(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstartWorkspacesAsync()
public
startWorkspacesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisestopWorkspaces()
public
stopWorkspaces(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultstopWorkspacesAsync()
public
stopWorkspacesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseterminateWorkspaces()
public
terminateWorkspaces(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultterminateWorkspacesAsync()
public
terminateWorkspacesAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateConnectClientAddIn()
public
updateConnectClientAddIn(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateConnectClientAddInAsync()
public
updateConnectClientAddInAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateConnectionAliasPermission()
public
updateConnectionAliasPermission(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateConnectionAliasPermissionAsync()
public
updateConnectionAliasPermissionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateRulesOfIpGroup()
public
updateRulesOfIpGroup(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateRulesOfIpGroupAsync()
public
updateRulesOfIpGroupAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateWorkspaceBundle()
public
updateWorkspaceBundle(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateWorkspaceBundleAsync()
public
updateWorkspaceBundleAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromiseupdateWorkspaceImagePermission()
public
updateWorkspaceImagePermission(array<string|int, mixed> $args = []) : Result
Parameters
- $args = [] : array<string|int, mixed>
Return values
ResultupdateWorkspaceImagePermissionAsync()
public
updateWorkspaceImagePermissionAsync(array<string|int, mixed> $args = []) : Promise
Parameters
- $args = [] : array<string|int, mixed>
Return values
PromisewaitUntil()
public
waitUntil(mixed $name[, array<string|int, mixed> $args = [] ]) : mixed
Parameters
- $name : mixed
- $args : array<string|int, mixed> = []