Class: Aws::WorkSpaces::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::WorkSpaces::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb
Overview
An API client for WorkSpaces. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::WorkSpaces::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_connection_alias(params = {}) ⇒ Types::AssociateConnectionAliasResult
Associates the specified connection alias with the specified directory to enable cross-Region redirection.
-
#associate_ip_groups(params = {}) ⇒ Struct
Associates the specified IP access control group with the specified directory.
-
#authorize_ip_rules(params = {}) ⇒ Struct
Adds one or more rules to the specified IP access control group.
-
#copy_workspace_image(params = {}) ⇒ Types::CopyWorkspaceImageResult
Copies the specified image from the specified Region to the current Region.
-
#create_connection_alias(params = {}) ⇒ Types::CreateConnectionAliasResult
Creates the specified connection alias for use with cross-Region redirection.
-
#create_ip_group(params = {}) ⇒ Types::CreateIpGroupResult
Creates an IP access control group.
-
#create_tags(params = {}) ⇒ Struct
Creates the specified tags for the specified WorkSpaces resource.
-
#create_workspaces(params = {}) ⇒ Types::CreateWorkspacesResult
Creates one or more WorkSpaces.
-
#delete_connection_alias(params = {}) ⇒ Struct
Deletes the specified connection alias.
-
#delete_ip_group(params = {}) ⇒ Struct
Deletes the specified IP access control group.
-
#delete_tags(params = {}) ⇒ Struct
Deletes the specified tags from the specified WorkSpaces resource.
-
#delete_workspace_image(params = {}) ⇒ Struct
Deletes the specified image from your account.
-
#deregister_workspace_directory(params = {}) ⇒ Struct
Deregisters the specified directory.
-
#describe_account(params = {}) ⇒ Types::DescribeAccountResult
Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
-
#describe_account_modifications(params = {}) ⇒ Types::DescribeAccountModificationsResult
Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
-
#describe_client_properties(params = {}) ⇒ Types::DescribeClientPropertiesResult
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
-
#describe_connection_alias_permissions(params = {}) ⇒ Types::DescribeConnectionAliasPermissionsResult
Describes the permissions that the owner of a connection alias has granted to another AWS account for the specified connection alias.
-
#describe_connection_aliases(params = {}) ⇒ Types::DescribeConnectionAliasesResult
Retrieves a list that describes the connection aliases used for cross-Region redirection.
-
#describe_ip_groups(params = {}) ⇒ Types::DescribeIpGroupsResult
Describes one or more of your IP access control groups.
-
#describe_tags(params = {}) ⇒ Types::DescribeTagsResult
Describes the specified tags for the specified WorkSpaces resource.
-
#describe_workspace_bundles(params = {}) ⇒ Types::DescribeWorkspaceBundlesResult
Retrieves a list that describes the available WorkSpace bundles.
-
#describe_workspace_directories(params = {}) ⇒ Types::DescribeWorkspaceDirectoriesResult
Describes the available directories that are registered with Amazon WorkSpaces.
-
#describe_workspace_image_permissions(params = {}) ⇒ Types::DescribeWorkspaceImagePermissionsResult
Describes the permissions that the owner of an image has granted to other AWS accounts for an image.
-
#describe_workspace_images(params = {}) ⇒ Types::DescribeWorkspaceImagesResult
Retrieves a list that describes one or more specified images, if the image identifiers are provided.
-
#describe_workspace_snapshots(params = {}) ⇒ Types::DescribeWorkspaceSnapshotsResult
Describes the snapshots for the specified WorkSpace.
-
#describe_workspaces(params = {}) ⇒ Types::DescribeWorkspacesResult
Describes the specified WorkSpaces.
-
#describe_workspaces_connection_status(params = {}) ⇒ Types::DescribeWorkspacesConnectionStatusResult
Describes the connection status of the specified WorkSpaces.
-
#disassociate_connection_alias(params = {}) ⇒ Struct
Disassociates a connection alias from a directory.
-
#disassociate_ip_groups(params = {}) ⇒ Struct
Disassociates the specified IP access control group from the specified directory.
-
#import_workspace_image(params = {}) ⇒ Types::ImportWorkspaceImageResult
Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces.
-
#list_available_management_cidr_ranges(params = {}) ⇒ Types::ListAvailableManagementCidrRangesResult
Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).
-
#migrate_workspace(params = {}) ⇒ Types::MigrateWorkspaceResult
Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.
-
#modify_account(params = {}) ⇒ Struct
Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
-
#modify_client_properties(params = {}) ⇒ Struct
Modifies the properties of the specified Amazon WorkSpaces clients.
-
#modify_selfservice_permissions(params = {}) ⇒ Struct
Modifies the self-service WorkSpace management capabilities for your users.
-
#modify_workspace_access_properties(params = {}) ⇒ Struct
Specifies which devices and operating systems users can use to access their WorkSpaces.
-
#modify_workspace_creation_properties(params = {}) ⇒ Struct
Modify the default properties used to create WorkSpaces.
-
#modify_workspace_properties(params = {}) ⇒ Struct
Modifies the specified WorkSpace properties.
-
#modify_workspace_state(params = {}) ⇒ Struct
Sets the state of the specified WorkSpace.
-
#reboot_workspaces(params = {}) ⇒ Types::RebootWorkspacesResult
Reboots the specified WorkSpaces.
-
#rebuild_workspaces(params = {}) ⇒ Types::RebuildWorkspacesResult
Rebuilds the specified WorkSpace.
-
#register_workspace_directory(params = {}) ⇒ Struct
Registers the specified directory.
-
#restore_workspace(params = {}) ⇒ Struct
Restores the specified WorkSpace to its last known healthy state.
-
#revoke_ip_rules(params = {}) ⇒ Struct
Removes one or more rules from the specified IP access control group.
-
#start_workspaces(params = {}) ⇒ Types::StartWorkspacesResult
Starts the specified WorkSpaces.
-
#stop_workspaces(params = {}) ⇒ Types::StopWorkspacesResult
Stops the specified WorkSpaces.
-
#terminate_workspaces(params = {}) ⇒ Types::TerminateWorkspacesResult
Terminates the specified WorkSpaces.
-
#update_connection_alias_permission(params = {}) ⇒ Struct
Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory.
-
#update_rules_of_ip_group(params = {}) ⇒ Struct
Replaces the current rules of the specified IP access control group with the specified rules.
-
#update_workspace_image_permission(params = {}) ⇒ Struct
Shares or unshares an image with one account in the same AWS Region by specifying whether that account has permission to copy the image.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
334 335 336 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#associate_connection_alias(params = {}) ⇒ Types::AssociateConnectionAliasResult
Associates the specified connection alias with the specified directory to enable cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
CREATED
.
381 382 383 384 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 381 def associate_connection_alias(params = {}, = {}) req = build_request(:associate_connection_alias, params) req.send_request() end |
#associate_ip_groups(params = {}) ⇒ Struct
Associates the specified IP access control group with the specified directory.
408 409 410 411 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 408 def associate_ip_groups(params = {}, = {}) req = build_request(:associate_ip_groups, params) req.send_request() end |
#authorize_ip_rules(params = {}) ⇒ Struct
Adds one or more rules to the specified IP access control group.
This action gives users permission to access their WorkSpaces from the CIDR address ranges specified in the rules.
442 443 444 445 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 442 def (params = {}, = {}) req = build_request(:authorize_ip_rules, params) req.send_request() end |
#copy_workspace_image(params = {}) ⇒ Types::CopyWorkspaceImageResult
Copies the specified image from the specified Region to the current Region. For more information about copying images, see Copy a Custom WorkSpaces Image.
In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS Support.
Before copying a shared image, be sure to verify that it has been shared from the correct AWS account. To determine if an image has been shared and to see the AWS account ID that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.
513 514 515 516 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 513 def copy_workspace_image(params = {}, = {}) req = build_request(:copy_workspace_image, params) req.send_request() end |
#create_connection_alias(params = {}) ⇒ Types::CreateConnectionAliasResult
Creates the specified connection alias for use with cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
563 564 565 566 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 563 def create_connection_alias(params = {}, = {}) req = build_request(:create_connection_alias, params) req.send_request() end |
#create_ip_group(params = {}) ⇒ Types::CreateIpGroupResult
Creates an IP access control group.
An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using AuthorizeIpRules.
There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.
627 628 629 630 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 627 def create_ip_group(params = {}, = {}) req = build_request(:create_ip_group, params) req.send_request() end |
#create_tags(params = {}) ⇒ Struct
Creates the specified tags for the specified WorkSpaces resource.
660 661 662 663 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 660 def (params = {}, = {}) req = build_request(:create_tags, params) req.send_request() end |
#create_workspaces(params = {}) ⇒ Types::CreateWorkspacesResult
Creates one or more WorkSpaces.
This operation is asynchronous and returns before the WorkSpaces are created.
752 753 754 755 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 752 def create_workspaces(params = {}, = {}) req = build_request(:create_workspaces, params) req.send_request() end |
#delete_connection_alias(params = {}) ⇒ Struct
Deletes the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
If you will no longer be using a fully qualified domain name (FQDN) as the registration code for your WorkSpaces users, you must take certain precautions to prevent potential security issues. For more information, see Security Considerations if You Stop Using Cross-Region Redirection.
795 796 797 798 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 795 def delete_connection_alias(params = {}, = {}) req = build_request(:delete_connection_alias, params) req.send_request() end |
#delete_ip_group(params = {}) ⇒ Struct
Deletes the specified IP access control group.
You cannot delete an IP access control group that is associated with a directory.
820 821 822 823 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 820 def delete_ip_group(params = {}, = {}) req = build_request(:delete_ip_group, params) req.send_request() end |
#delete_tags(params = {}) ⇒ Struct
Deletes the specified tags from the specified WorkSpaces resource.
848 849 850 851 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 848 def (params = {}, = {}) req = build_request(:delete_tags, params) req.send_request() end |
#delete_workspace_image(params = {}) ⇒ Struct
Deletes the specified image from your account. To delete an image, you must first delete any bundles that are associated with the image and unshare the image if it is shared with other accounts.
872 873 874 875 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 872 def delete_workspace_image(params = {}, = {}) req = build_request(:delete_workspace_image, params) req.send_request() end |
#deregister_workspace_directory(params = {}) ⇒ Struct
Deregisters the specified directory. This operation is asynchronous and returns before the WorkSpace directory is deregistered. If any WorkSpaces are registered to this directory, you must remove them before you can deregister the directory.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
919 920 921 922 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 919 def deregister_workspace_directory(params = {}, = {}) req = build_request(:deregister_workspace_directory, params) req.send_request() end |
#describe_account(params = {}) ⇒ Types::DescribeAccountResult
Retrieves a list that describes the configuration of Bring Your Own License (BYOL) for the specified account.
941 942 943 944 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 941 def describe_account(params = {}, = {}) req = build_request(:describe_account, params) req.send_request() end |
#describe_account_modifications(params = {}) ⇒ Types::DescribeAccountModificationsResult
Retrieves a list that describes modifications to the configuration of Bring Your Own License (BYOL) for the specified account.
979 980 981 982 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 979 def describe_account_modifications(params = {}, = {}) req = build_request(:describe_account_modifications, params) req.send_request() end |
#describe_client_properties(params = {}) ⇒ Types::DescribeClientPropertiesResult
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
1010 1011 1012 1013 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1010 def describe_client_properties(params = {}, = {}) req = build_request(:describe_client_properties, params) req.send_request() end |
#describe_connection_alias_permissions(params = {}) ⇒ Types::DescribeConnectionAliasPermissionsResult
Describes the permissions that the owner of a connection alias has granted to another AWS account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
1060 1061 1062 1063 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1060 def (params = {}, = {}) req = build_request(:describe_connection_alias_permissions, params) req.send_request() end |
#describe_connection_aliases(params = {}) ⇒ Types::DescribeConnectionAliasesResult
Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
1118 1119 1120 1121 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1118 def describe_connection_aliases(params = {}, = {}) req = build_request(:describe_connection_aliases, params) req.send_request() end |
#describe_ip_groups(params = {}) ⇒ Types::DescribeIpGroupsResult
Describes one or more of your IP access control groups.
1163 1164 1165 1166 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1163 def describe_ip_groups(params = {}, = {}) req = build_request(:describe_ip_groups, params) req.send_request() end |
#describe_tags(params = {}) ⇒ Types::DescribeTagsResult
Describes the specified tags for the specified WorkSpaces resource.
1195 1196 1197 1198 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1195 def (params = {}, = {}) req = build_request(:describe_tags, params) req.send_request() end |
#describe_workspace_bundles(params = {}) ⇒ Types::DescribeWorkspaceBundlesResult
Retrieves a list that describes the available WorkSpace bundles.
You can filter the results using either bundle ID or owner, but not both.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1253 1254 1255 1256 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1253 def describe_workspace_bundles(params = {}, = {}) req = build_request(:describe_workspace_bundles, params) req.send_request() end |
#describe_workspace_directories(params = {}) ⇒ Types::DescribeWorkspaceDirectoriesResult
Describes the available directories that are registered with Amazon WorkSpaces.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1330 1331 1332 1333 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1330 def describe_workspace_directories(params = {}, = {}) req = build_request(:describe_workspace_directories, params) req.send_request() end |
#describe_workspace_image_permissions(params = {}) ⇒ Types::DescribeWorkspaceImagePermissionsResult
Describes the permissions that the owner of an image has granted to other AWS accounts for an image.
1373 1374 1375 1376 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1373 def (params = {}, = {}) req = build_request(:describe_workspace_image_permissions, params) req.send_request() end |
#describe_workspace_images(params = {}) ⇒ Types::DescribeWorkspaceImagesResult
Retrieves a list that describes one or more specified images, if the image identifiers are provided. Otherwise, all images in the account are described.
1428 1429 1430 1431 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1428 def describe_workspace_images(params = {}, = {}) req = build_request(:describe_workspace_images, params) req.send_request() end |
#describe_workspace_snapshots(params = {}) ⇒ Types::DescribeWorkspaceSnapshotsResult
Describes the snapshots for the specified WorkSpace.
1460 1461 1462 1463 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1460 def describe_workspace_snapshots(params = {}, = {}) req = build_request(:describe_workspace_snapshots, params) req.send_request() end |
#describe_workspaces(params = {}) ⇒ Types::DescribeWorkspacesResult
Describes the specified WorkSpaces.
You can filter the results by using the bundle identifier, directory identifier, or owner, but you can specify only one filter at a time.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1547 1548 1549 1550 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1547 def describe_workspaces(params = {}, = {}) req = build_request(:describe_workspaces, params) req.send_request() end |
#describe_workspaces_connection_status(params = {}) ⇒ Types::DescribeWorkspacesConnectionStatusResult
Describes the connection status of the specified WorkSpaces.
1587 1588 1589 1590 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1587 def describe_workspaces_connection_status(params = {}, = {}) req = build_request(:describe_workspaces_connection_status, params) req.send_request() end |
#disassociate_connection_alias(params = {}) ⇒ Struct
Disassociates a connection alias from a directory. Disassociating a connection alias disables cross-Region redirection between two directories in different AWS Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
CREATED
.
1623 1624 1625 1626 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1623 def disassociate_connection_alias(params = {}, = {}) req = build_request(:disassociate_connection_alias, params) req.send_request() end |
#disassociate_ip_groups(params = {}) ⇒ Struct
Disassociates the specified IP access control group from the specified directory.
1650 1651 1652 1653 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1650 def disassociate_ip_groups(params = {}, = {}) req = build_request(:disassociate_ip_groups, params) req.send_request() end |
#import_workspace_image(params = {}) ⇒ Types::ImportWorkspaceImageResult
Imports the specified Windows 10 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your AWS account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
1731 1732 1733 1734 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1731 def import_workspace_image(params = {}, = {}) req = build_request(:import_workspace_image, params) req.send_request() end |
#list_available_management_cidr_ranges(params = {}) ⇒ Types::ListAvailableManagementCidrRangesResult
Retrieves a list of IP address ranges, specified as IPv4 CIDR blocks, that you can use for the network management interface when you enable Bring Your Own License (BYOL).
This operation can be run only by AWS accounts that are enabled for
BYOL. If your account isn't enabled for BYOL, you'll receive an
AccessDeniedException
error.
The management network interface is connected to a secure Amazon WorkSpaces management network. It is used for interactive streaming of the WorkSpace desktop to Amazon WorkSpaces clients, and to allow Amazon WorkSpaces to manage the WorkSpace.
1784 1785 1786 1787 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1784 def list_available_management_cidr_ranges(params = {}, = {}) req = build_request(:list_available_management_cidr_ranges, params) req.send_request() end |
#migrate_workspace(params = {}) ⇒ Types::MigrateWorkspaceResult
Migrates a WorkSpace from one operating system or bundle type to another, while retaining the data on the user volume.
The migration process recreates the WorkSpace by using a new root
volume from the target bundle image and the user volume from the last
available snapshot of the original WorkSpace. During migration, the
original D:\Users\%USERNAME%
user profile folder is renamed to
D:\Users\%USERNAME%MMddyyTHHmmss%.NotMigrated
. A new
D:\Users\%USERNAME%
folder is generated by the new OS. Certain
files in the old user profile are moved to the new user profile.
For available migration scenarios, details about what happens during migration, and best practices, see Migrate a WorkSpace.
1834 1835 1836 1837 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1834 def migrate_workspace(params = {}, = {}) req = build_request(:migrate_workspace, params) req.send_request() end |
#modify_account(params = {}) ⇒ Struct
Modifies the configuration of Bring Your Own License (BYOL) for the specified account.
1866 1867 1868 1869 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1866 def modify_account(params = {}, = {}) req = build_request(:modify_account, params) req.send_request() end |
#modify_client_properties(params = {}) ⇒ Struct
Modifies the properties of the specified Amazon WorkSpaces clients.
1894 1895 1896 1897 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1894 def modify_client_properties(params = {}, = {}) req = build_request(:modify_client_properties, params) req.send_request() end |
#modify_selfservice_permissions(params = {}) ⇒ Struct
Modifies the self-service WorkSpace management capabilities for your users. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
1932 1933 1934 1935 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1932 def (params = {}, = {}) req = build_request(:modify_selfservice_permissions, params) req.send_request() end |
#modify_workspace_access_properties(params = {}) ⇒ Struct
Specifies which devices and operating systems users can use to access their WorkSpaces. For more information, see Control Device Access.
1973 1974 1975 1976 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1973 def modify_workspace_access_properties(params = {}, = {}) req = build_request(:modify_workspace_access_properties, params) req.send_request() end |
#modify_workspace_creation_properties(params = {}) ⇒ Struct
Modify the default properties used to create WorkSpaces.
2006 2007 2008 2009 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2006 def modify_workspace_creation_properties(params = {}, = {}) req = build_request(:modify_workspace_creation_properties, params) req.send_request() end |
#modify_workspace_properties(params = {}) ⇒ Struct
Modifies the specified WorkSpace properties. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.
2044 2045 2046 2047 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2044 def modify_workspace_properties(params = {}, = {}) req = build_request(:modify_workspace_properties, params) req.send_request() end |
#modify_workspace_state(params = {}) ⇒ Struct
Sets the state of the specified WorkSpace.
To maintain a WorkSpace without being interrupted, set the WorkSpace
state to ADMIN_MAINTENANCE
. WorkSpaces in this state do not respond
to requests to reboot, stop, start, rebuild, or restore. An AutoStop
WorkSpace in this state is not stopped. Users cannot log into a
WorkSpace in the ADMIN_MAINTENANCE
state.
2076 2077 2078 2079 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2076 def modify_workspace_state(params = {}, = {}) req = build_request(:modify_workspace_state, params) req.send_request() end |
#reboot_workspaces(params = {}) ⇒ Types::RebootWorkspacesResult
Reboots the specified WorkSpaces.
You cannot reboot a WorkSpace unless its state is AVAILABLE
or
UNHEALTHY
.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
2117 2118 2119 2120 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2117 def reboot_workspaces(params = {}, = {}) req = build_request(:reboot_workspaces, params) req.send_request() end |
#rebuild_workspaces(params = {}) ⇒ Types::RebuildWorkspacesResult
Rebuilds the specified WorkSpace.
You cannot rebuild a WorkSpace unless its state is AVAILABLE
,
ERROR
, UNHEALTHY
, STOPPED
, or REBOOTING
.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Rebuild a WorkSpace.
This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.
2166 2167 2168 2169 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2166 def rebuild_workspaces(params = {}, = {}) req = build_request(:rebuild_workspaces, params) req.send_request() end |
#register_workspace_directory(params = {}) ⇒ Struct
Registers the specified directory. This operation is asynchronous and returns before the WorkSpace directory is registered. If this is the first time you are registering a directory, you will need to create the workspaces_DefaultRole role before you can register a directory. For more information, see Creating the workspaces_DefaultRole Role.
2244 2245 2246 2247 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2244 def register_workspace_directory(params = {}, = {}) req = build_request(:register_workspace_directory, params) req.send_request() end |
#restore_workspace(params = {}) ⇒ Struct
Restores the specified WorkSpace to its last known healthy state.
You cannot restore a WorkSpace unless its state is AVAILABLE
,
ERROR
, UNHEALTHY
, or STOPPED
.
Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see Restore a WorkSpace.
This operation is asynchronous and returns before the WorkSpace is completely restored.
2280 2281 2282 2283 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2280 def restore_workspace(params = {}, = {}) req = build_request(:restore_workspace, params) req.send_request() end |
#revoke_ip_rules(params = {}) ⇒ Struct
Removes one or more rules from the specified IP access control group.
2306 2307 2308 2309 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2306 def revoke_ip_rules(params = {}, = {}) req = build_request(:revoke_ip_rules, params) req.send_request() end |
#start_workspaces(params = {}) ⇒ Types::StartWorkspacesResult
Starts the specified WorkSpaces.
You cannot start a WorkSpace unless it has a running mode of
AutoStop
and a state of STOPPED
.
2344 2345 2346 2347 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2344 def start_workspaces(params = {}, = {}) req = build_request(:start_workspaces, params) req.send_request() end |
#stop_workspaces(params = {}) ⇒ Types::StopWorkspacesResult
Stops the specified WorkSpaces.
You cannot stop a WorkSpace unless it has a running mode of AutoStop
and a state of AVAILABLE
, IMPAIRED
, UNHEALTHY
, or ERROR
.
2382 2383 2384 2385 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2382 def stop_workspaces(params = {}, = {}) req = build_request(:stop_workspaces, params) req.send_request() end |
#terminate_workspaces(params = {}) ⇒ Types::TerminateWorkspacesResult
Terminates the specified WorkSpaces.
Terminating a WorkSpace is a permanent action and cannot be undone. The user's data is destroyed. If you need to archive any user data, contact AWS Support before terminating the WorkSpace.
You can terminate a WorkSpace that is in any state except SUSPENDED
.
This operation is asynchronous and returns before the WorkSpaces have
been completely terminated. After a WorkSpace is terminated, the
TERMINATED
state is returned only briefly before the WorkSpace
directory metadata is cleaned up, so this state is rarely returned. To
confirm that a WorkSpace is terminated, check for the WorkSpace ID by
using DescribeWorkSpaces. If the WorkSpace ID isn't returned,
then the WorkSpace has been successfully terminated.
To delete empty directories, see Delete the Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector directory, you can always create a new one when you want to start using WorkSpaces again.
2451 2452 2453 2454 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2451 def terminate_workspaces(params = {}, = {}) req = build_request(:terminate_workspaces, params) req.send_request() end |
#update_connection_alias_permission(params = {}) ⇒ Struct
Shares or unshares a connection alias with one account by specifying whether that account has permission to associate the connection alias with a directory. If the association permission is granted, the connection alias is shared with that account. If the association permission is revoked, the connection alias is unshared with the account. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
CREATED
.
- To delete a connection alias that has been shared, the shared account must first disassociate the connection alias from any directories it has been associated with. Then you must unshare the connection alias from the account it has been shared with. You can delete a connection alias only after it is no longer shared with any accounts or associated with any directories.
2506 2507 2508 2509 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2506 def (params = {}, = {}) req = build_request(:update_connection_alias_permission, params) req.send_request() end |
#update_rules_of_ip_group(params = {}) ⇒ Struct
Replaces the current rules of the specified IP access control group with the specified rules.
2538 2539 2540 2541 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2538 def update_rules_of_ip_group(params = {}, = {}) req = build_request(:update_rules_of_ip_group, params) req.send_request() end |
#update_workspace_image_permission(params = {}) ⇒ Struct
Shares or unshares an image with one account in the same AWS Region by specifying whether that account has permission to copy the image. If the copy image permission is granted, the image is shared with that account. If the copy image permission is revoked, the image is unshared with the account.
After an image has been shared, the recipient account can copy the image to other AWS Regions as needed.
In the AWS GovCloud (US-West) Region, to copy images to and from other AWS Regions, contact AWS Support.
For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
- Sharing Bring Your Own License (BYOL) images across AWS accounts isn't supported at this time in the AWS GovCloud (US-West) Region. To share BYOL images across accounts in the AWS GovCloud (US-West) Region, contact AWS Support.
2604 2605 2606 2607 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2604 def (params = {}, = {}) req = build_request(:update_workspace_image_permission, params) req.send_request() end |