WorkSpaces#
Client#
- class WorkSpaces.Client#
A low-level client representing Amazon WorkSpaces
Amazon WorkSpaces enables you to provision virtual, cloud-based Microsoft Windows or Amazon Linux desktops for your users, known as WorkSpaces. WorkSpaces eliminates the need to procure and deploy hardware or install complex software. You can quickly add or remove users as your needs change. Users can access their virtual desktops from multiple devices or web browsers.
This API Reference provides detailed information about the actions, data types, parameters, and errors of the WorkSpaces service. For more information about the supported Amazon Web Services Regions, endpoints, and service quotas of the Amazon WorkSpaces service, see WorkSpaces endpoints and quotas in the Amazon Web Services General Reference.
You can also manage your WorkSpaces resources using the WorkSpaces console, Command Line Interface (CLI), and SDKs. For more information about administering WorkSpaces, see the Amazon WorkSpaces Administration Guide. For more information about using the Amazon WorkSpaces client application or web browser to access provisioned WorkSpaces, see the Amazon WorkSpaces User Guide. For more information about using the CLI to manage your WorkSpaces resources, see the WorkSpaces section of the CLI Reference.
client = session.create_client('workspaces')
These are the available methods:
- accept_account_link_invitation
- associate_connection_alias
- associate_ip_groups
- associate_workspace_application
- authorize_ip_rules
- can_paginate
- close
- copy_workspace_image
- create_account_link_invitation
- create_connect_client_add_in
- create_connection_alias
- create_ip_group
- create_standby_workspaces
- create_tags
- create_updated_workspace_image
- create_workspace_bundle
- create_workspace_image
- create_workspaces
- create_workspaces_pool
- delete_account_link_invitation
- delete_client_branding
- delete_connect_client_add_in
- delete_connection_alias
- delete_ip_group
- delete_tags
- delete_workspace_bundle
- delete_workspace_image
- deploy_workspace_applications
- deregister_workspace_directory
- describe_account
- describe_account_modifications
- describe_application_associations
- describe_applications
- describe_bundle_associations
- describe_client_branding
- describe_client_properties
- describe_connect_client_add_ins
- describe_connection_alias_permissions
- describe_connection_aliases
- describe_image_associations
- describe_ip_groups
- describe_tags
- describe_workspace_associations
- describe_workspace_bundles
- describe_workspace_directories
- describe_workspace_image_permissions
- describe_workspace_images
- describe_workspace_snapshots
- describe_workspaces
- describe_workspaces_connection_status
- describe_workspaces_pool_sessions
- describe_workspaces_pools
- disassociate_connection_alias
- disassociate_ip_groups
- disassociate_workspace_application
- get_account_link
- get_paginator
- get_waiter
- import_client_branding
- import_workspace_image
- list_account_links
- list_available_management_cidr_ranges
- migrate_workspace
- modify_account
- modify_certificate_based_auth_properties
- modify_client_properties
- modify_saml_properties
- modify_selfservice_permissions
- modify_streaming_properties
- modify_workspace_access_properties
- modify_workspace_creation_properties
- modify_workspace_properties
- modify_workspace_state
- reboot_workspaces
- rebuild_workspaces
- register_workspace_directory
- reject_account_link_invitation
- restore_workspace
- revoke_ip_rules
- start_workspaces
- start_workspaces_pool
- stop_workspaces
- stop_workspaces_pool
- terminate_workspaces
- terminate_workspaces_pool
- terminate_workspaces_pool_session
- update_connect_client_add_in
- update_connection_alias_permission
- update_rules_of_ip_group
- update_workspace_bundle
- update_workspace_image_permission
- update_workspaces_pool
Client Exceptions#
Client exceptions are available on a client instance via the exceptions property. For more detailed instructions and examples on the exact usage of client exceptions, see the error handling user guide.
The available client exceptions are:
- AccessDeniedException
- ApplicationNotSupportedException
- ComputeNotCompatibleException
- ConflictException
- IncompatibleApplicationsException
- InternalServerException
- InvalidParameterValuesException
- InvalidResourceStateException
- OperatingSystemNotCompatibleException
- OperationInProgressException
- OperationNotSupportedException
- ResourceAlreadyExistsException
- ResourceAssociatedException
- ResourceCreationFailedException
- ResourceInUseException
- ResourceLimitExceededException
- ResourceNotFoundException
- ResourceUnavailableException
- UnsupportedNetworkConfigurationException
- UnsupportedWorkspaceConfigurationException
- ValidationException
- WorkspacesDefaultRoleNotFoundException
Paginators#
Paginators are available on a client instance via the get_paginator method. For more detailed instructions and examples on the usage of paginators, see the paginators user guide.
The available paginators are: