Class: Aws::WorkSpaces::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::WorkSpaces::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-workspaces/client.rb
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#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.
-
#create_ip_group(params = {}) ⇒ Types::CreateIpGroupResult
Creates an IP access control group.
-
#create_tags(params = {}) ⇒ Struct
Creates the specified tags for the specified WorkSpace.
-
#create_workspaces(params = {}) ⇒ Types::CreateWorkspacesResult
Creates one or more WorkSpaces.
-
#delete_ip_group(params = {}) ⇒ Struct
Deletes the specified IP access control group.
-
#delete_tags(params = {}) ⇒ Struct
Deletes the specified tags from the specified WorkSpace.
-
#delete_workspace_image(params = {}) ⇒ Struct
Deletes the specified image from your account.
-
#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_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 WorkSpace.
-
#describe_workspace_bundles(params = {}) ⇒ Types::DescribeWorkspaceBundlesResult
Retrieves a list that describes the available WorkSpace bundles.
-
#describe_workspace_directories(params = {}) ⇒ Types::DescribeWorkspaceDirectoriesResult
Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.
-
#describe_workspace_images(params = {}) ⇒ Types::DescribeWorkspaceImagesResult
Retrieves a list that describes one or more specified images, if the image identifiers are provided.
-
#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_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 7 or 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).
-
#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 client.
-
#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.
-
#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_rules_of_ip_group(params = {}) ⇒ Struct
Replaces the current rules of the specified IP access control group with the specified rules.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
212 213 214 |
# File 'lib/aws-sdk-workspaces/client.rb', line 212 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1522 1523 1524 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1522 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1525 1526 1527 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1525 def errors_module Errors end |
Instance Method Details
#associate_ip_groups(params = {}) ⇒ Struct
Associates the specified IP access control group with the specified directory.
240 241 242 243 |
# File 'lib/aws-sdk-workspaces/client.rb', line 240 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.
274 275 276 277 |
# File 'lib/aws-sdk-workspaces/client.rb', line 274 def (params = {}, = {}) req = build_request(:authorize_ip_rules, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1500 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-workspaces' context[:gem_version] = '1.11.0' Seahorse::Client::Request.new(handlers, context) 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.
329 330 331 332 |
# File 'lib/aws-sdk-workspaces/client.rb', line 329 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 WorkSpace.
361 362 363 364 |
# File 'lib/aws-sdk-workspaces/client.rb', line 361 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.
453 454 455 456 |
# File 'lib/aws-sdk-workspaces/client.rb', line 453 def create_workspaces(params = {}, = {}) req = build_request(:create_workspaces, 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.
478 479 480 481 |
# File 'lib/aws-sdk-workspaces/client.rb', line 478 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 WorkSpace.
505 506 507 508 |
# File 'lib/aws-sdk-workspaces/client.rb', line 505 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.
528 529 530 531 |
# File 'lib/aws-sdk-workspaces/client.rb', line 528 def delete_workspace_image(params = {}, = {}) req = build_request(:delete_workspace_image, 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.
550 551 552 553 |
# File 'lib/aws-sdk-workspaces/client.rb', line 550 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.
588 589 590 591 |
# File 'lib/aws-sdk-workspaces/client.rb', line 588 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.
619 620 621 622 |
# File 'lib/aws-sdk-workspaces/client.rb', line 619 def describe_client_properties(params = {}, = {}) req = build_request(:describe_client_properties, params) req.send_request() end |
#describe_ip_groups(params = {}) ⇒ Types::DescribeIpGroupsResult
Describes one or more of your IP access control groups.
664 665 666 667 |
# File 'lib/aws-sdk-workspaces/client.rb', line 664 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 WorkSpace.
695 696 697 698 |
# File 'lib/aws-sdk-workspaces/client.rb', line 695 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.
749 750 751 752 |
# File 'lib/aws-sdk-workspaces/client.rb', line 749 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 AWS Directory Service directories that are registered with Amazon WorkSpaces.
806 807 808 809 |
# File 'lib/aws-sdk-workspaces/client.rb', line 806 def describe_workspace_directories(params = {}, = {}) req = build_request(:describe_workspace_directories, 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.
855 856 857 858 |
# File 'lib/aws-sdk-workspaces/client.rb', line 855 def describe_workspace_images(params = {}, = {}) req = build_request(:describe_workspace_images, 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.
940 941 942 943 |
# File 'lib/aws-sdk-workspaces/client.rb', line 940 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.
980 981 982 983 |
# File 'lib/aws-sdk-workspaces/client.rb', line 980 def describe_workspaces_connection_status(params = {}, = {}) req = build_request(:describe_workspaces_connection_status, params) req.send_request() end |
#disassociate_ip_groups(params = {}) ⇒ Struct
Disassociates the specified IP access control group from the specified directory.
1007 1008 1009 1010 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1007 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 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image.
1050 1051 1052 1053 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1050 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).
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.
1099 1100 1101 1102 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1099 def list_available_management_cidr_ranges(params = {}, = {}) req = build_request(:list_available_management_cidr_ranges, params) req.send_request() end |
#modify_account(params = {}) ⇒ Struct
Modifies the configuration of bring your own license (BYOL) for the specified account.
1131 1132 1133 1134 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1131 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 client.
1159 1160 1161 1162 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1159 def modify_client_properties(params = {}, = {}) req = build_request(:modify_client_properties, params) req.send_request() end |
#modify_workspace_properties(params = {}) ⇒ Struct
Modifies the specified WorkSpace properties.
1191 1192 1193 1194 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1191 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, or rebuild. An AutoStop WorkSpace in this state is not stopped. Users can log into a WorkSpace in the `ADMIN_MAINTENANCE` state.
1223 1224 1225 1226 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1223 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.
1264 1265 1266 1267 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1264 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`, or `UNHEALTHY`.
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.
[1]: docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html
1313 1314 1315 1316 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1313 def rebuild_workspaces(params = {}, = {}) req = build_request(:rebuild_workspaces, params) req.send_request() end |
#revoke_ip_rules(params = {}) ⇒ Struct
Removes one or more rules from the specified IP access control group.
1339 1340 1341 1342 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1339 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`.
1377 1378 1379 1380 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1377 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`.
1415 1416 1417 1418 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1415 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 Amazon Web Services 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.
1459 1460 1461 1462 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1459 def terminate_workspaces(params = {}, = {}) req = build_request(:terminate_workspaces, 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.
1491 1492 1493 1494 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1491 def update_rules_of_ip_group(params = {}, = {}) req = build_request(:update_rules_of_ip_group, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1515 1516 1517 |
# File 'lib/aws-sdk-workspaces/client.rb', line 1515 def waiter_names [] end |