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
-
#accept_account_link_invitation(params = {}) ⇒ Types::AcceptAccountLinkInvitationResult
Accepts the account link invitation.
-
#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.
-
#associate_workspace_application(params = {}) ⇒ Types::AssociateWorkspaceApplicationResult
Associates the specified application to the specified WorkSpace.
-
#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_account_link_invitation(params = {}) ⇒ Types::CreateAccountLinkInvitationResult
Creates the account link invitation.
-
#create_connect_client_add_in(params = {}) ⇒ Types::CreateConnectClientAddInResult
Creates a client-add-in for Amazon Connect within a directory.
-
#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_standby_workspaces(params = {}) ⇒ Types::CreateStandbyWorkspacesResult
Creates a standby WorkSpace in a secondary Region.
-
#create_tags(params = {}) ⇒ Struct
Creates the specified tags for the specified WorkSpaces resource.
-
#create_updated_workspace_image(params = {}) ⇒ Types::CreateUpdatedWorkspaceImageResult
Creates a new updated WorkSpace image based on the specified source image.
-
#create_workspace_bundle(params = {}) ⇒ Types::CreateWorkspaceBundleResult
Creates the specified WorkSpace bundle.
-
#create_workspace_image(params = {}) ⇒ Types::CreateWorkspaceImageResult
Creates a new WorkSpace image from an existing WorkSpace.
-
#create_workspaces(params = {}) ⇒ Types::CreateWorkspacesResult
Creates one or more WorkSpaces.
-
#delete_account_link_invitation(params = {}) ⇒ Types::DeleteAccountLinkInvitationResult
Deletes the account link invitation.
-
#delete_client_branding(params = {}) ⇒ Struct
Deletes customized client branding.
-
#delete_connect_client_add_in(params = {}) ⇒ Struct
Deletes a client-add-in for Amazon Connect that is configured within a directory.
-
#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_bundle(params = {}) ⇒ Struct
Deletes the specified WorkSpace bundle.
-
#delete_workspace_image(params = {}) ⇒ Struct
Deletes the specified image from your account.
-
#deploy_workspace_applications(params = {}) ⇒ Types::DeployWorkspaceApplicationsResult
Deploys associated applications to the specified WorkSpace.
-
#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_application_associations(params = {}) ⇒ Types::DescribeApplicationAssociationsResult
Describes the associations between the application and the specified associated resources.
-
#describe_applications(params = {}) ⇒ Types::DescribeApplicationsResult
Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.
-
#describe_bundle_associations(params = {}) ⇒ Types::DescribeBundleAssociationsResult
Describes the associations between the applications and the specified bundle.
-
#describe_client_branding(params = {}) ⇒ Types::DescribeClientBrandingResult
Describes the specified client branding.
-
#describe_client_properties(params = {}) ⇒ Types::DescribeClientPropertiesResult
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
-
#describe_connect_client_add_ins(params = {}) ⇒ Types::DescribeConnectClientAddInsResult
Retrieves a list of Amazon Connect client add-ins that have been created.
-
#describe_connection_alias_permissions(params = {}) ⇒ Types::DescribeConnectionAliasPermissionsResult
Describes the permissions that the owner of a connection alias has granted to another Amazon Web Services 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_image_associations(params = {}) ⇒ Types::DescribeImageAssociationsResult
Describes the associations between the applications and the specified image.
-
#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_associations(params = {}) ⇒ Types::DescribeWorkspaceAssociationsResult
Describes the associations betweens applications and 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 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 Amazon Web Services 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.
-
#disassociate_workspace_application(params = {}) ⇒ Types::DisassociateWorkspaceApplicationResult
Disassociates the specified application from a WorkSpace.
-
#get_account_link(params = {}) ⇒ Types::GetAccountLinkResult
Retrieves account link information.
-
#import_client_branding(params = {}) ⇒ Types::ImportClientBrandingResult
Imports client branding.
-
#import_workspace_image(params = {}) ⇒ Types::ImportWorkspaceImageResult
Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces.
-
#list_account_links(params = {}) ⇒ Types::ListAccountLinksResult
Lists all account links.
-
#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_certificate_based_auth_properties(params = {}) ⇒ Struct
Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
-
#modify_client_properties(params = {}) ⇒ Struct
Modifies the properties of the specified Amazon WorkSpaces clients.
-
#modify_saml_properties(params = {}) ⇒ Struct
Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
-
#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.
-
#reject_account_link_invitation(params = {}) ⇒ Types::RejectAccountLinkInvitationResult
Rejects the account link invitation.
-
#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_connect_client_add_in(params = {}) ⇒ Struct
Updates a Amazon Connect client add-in.
-
#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_bundle(params = {}) ⇒ Struct
Updates a WorkSpace bundle with a new image.
-
#update_workspace_image_permission(params = {}) ⇒ Struct
Shares or unshares an image with one account in the same Amazon Web Services 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.
419 420 421 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 419 def initialize(*args) super end |
Instance Method Details
#accept_account_link_invitation(params = {}) ⇒ Types::AcceptAccountLinkInvitationResult
Accepts the account link invitation.
There's currently no unlinking capability after you accept the account linking invitation.
459 460 461 462 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 459 def accept_account_link_invitation(params = {}, = {}) req = build_request(:accept_account_link_invitation, params) req.send_request() end |
#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
.
505 506 507 508 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 505 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.
532 533 534 535 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 532 def associate_ip_groups(params = {}, = {}) req = build_request(:associate_ip_groups, params) req.send_request() end |
#associate_workspace_application(params = {}) ⇒ Types::AssociateWorkspaceApplicationResult
Associates the specified application to the specified WorkSpace.
571 572 573 574 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 571 def associate_workspace_application(params = {}, = {}) req = build_request(:associate_workspace_application, 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.
605 606 607 608 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 605 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 China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
Before copying a shared image, be sure to verify that it has been shared from the correct Amazon Web Services account. To determine if an image has been shared and to see the ID of the Amazon Web Services account that owns an image, use the DescribeWorkSpaceImages and DescribeWorkspaceImagePermissions API operations.
674 675 676 677 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 674 def copy_workspace_image(params = {}, = {}) req = build_request(:copy_workspace_image, params) req.send_request() end |
#create_account_link_invitation(params = {}) ⇒ Types::CreateAccountLinkInvitationResult
Creates the account link invitation.
710 711 712 713 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 710 def create_account_link_invitation(params = {}, = {}) req = build_request(:create_account_link_invitation, params) req.send_request() end |
#create_connect_client_add_in(params = {}) ⇒ Types::CreateConnectClientAddInResult
Creates a client-add-in for Amazon Connect within a directory. You can create only one Amazon Connect client add-in within a directory.
This client add-in allows WorkSpaces users to seamlessly connect to Amazon Connect.
750 751 752 753 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 750 def create_connect_client_add_in(params = {}, = {}) req = build_request(:create_connect_client_add_in, 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.
800 801 802 803 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 800 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.
864 865 866 867 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 864 def create_ip_group(params = {}, = {}) req = build_request(:create_ip_group, params) req.send_request() end |
#create_standby_workspaces(params = {}) ⇒ Types::CreateStandbyWorkspacesResult
Creates a standby WorkSpace in a secondary Region.
924 925 926 927 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 924 def create_standby_workspaces(params = {}, = {}) req = build_request(:create_standby_workspaces, params) req.send_request() end |
#create_tags(params = {}) ⇒ Struct
Creates the specified tags for the specified WorkSpaces resource.
957 958 959 960 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 957 def (params = {}, = {}) req = build_request(:create_tags, params) req.send_request() end |
#create_updated_workspace_image(params = {}) ⇒ Types::CreateUpdatedWorkspaceImageResult
Creates a new updated WorkSpace image based on the specified source image. The new updated WorkSpace image has the latest drivers and other updates required by the Amazon WorkSpaces components.
To determine which WorkSpace images need to be updated with the latest Amazon WorkSpaces requirements, use DescribeWorkspaceImages.
Microsoft Windows updates and other application updates are not included in the update process.
The source WorkSpace image is not deleted. You can delete the source image after you've verified your new updated image and created a new bundle.
1030 1031 1032 1033 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1030 def create_updated_workspace_image(params = {}, = {}) req = build_request(:create_updated_workspace_image, params) req.send_request() end |
#create_workspace_bundle(params = {}) ⇒ Types::CreateWorkspaceBundleResult
Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see Create a Custom WorkSpaces Image and Bundle.
1116 1117 1118 1119 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1116 def create_workspace_bundle(params = {}, = {}) req = build_request(:create_workspace_bundle, params) req.send_request() end |
#create_workspace_image(params = {}) ⇒ Types::CreateWorkspaceImageResult
Creates a new WorkSpace image from an existing WorkSpace.
1177 1178 1179 1180 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1177 def create_workspace_image(params = {}, = {}) req = build_request(:create_workspace_image, 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.
MANUAL
running mode value is only supported by Amazon
WorkSpaces Core. Contact your account team to be allow-listed to use
this value. For more information, see Amazon WorkSpaces Core.
You don't need to specify the
PCOIP
protocol for Linux bundles becauseWSP
is the default protocol for those bundles.User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core.
1307 1308 1309 1310 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1307 def create_workspaces(params = {}, = {}) req = build_request(:create_workspaces, params) req.send_request() end |
#delete_account_link_invitation(params = {}) ⇒ Types::DeleteAccountLinkInvitationResult
Deletes the account link invitation.
1343 1344 1345 1346 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1343 def delete_account_link_invitation(params = {}, = {}) req = build_request(:delete_account_link_invitation, params) req.send_request() end |
#delete_client_branding(params = {}) ⇒ Struct
Deletes customized client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you delete your customized client branding, your login portal reverts to the default client branding.
1377 1378 1379 1380 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1377 def delete_client_branding(params = {}, = {}) req = build_request(:delete_client_branding, params) req.send_request() end |
#delete_connect_client_add_in(params = {}) ⇒ Struct
Deletes a client-add-in for Amazon Connect that is configured within a directory.
1404 1405 1406 1407 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1404 def delete_connect_client_add_in(params = {}, = {}) req = build_request(:delete_connect_client_add_in, 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.
1447 1448 1449 1450 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1447 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.
1472 1473 1474 1475 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1472 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.
1500 1501 1502 1503 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1500 def (params = {}, = {}) req = build_request(:delete_tags, params) req.send_request() end |
#delete_workspace_bundle(params = {}) ⇒ Struct
Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see Delete a Custom WorkSpaces Bundle or Image.
1528 1529 1530 1531 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1528 def delete_workspace_bundle(params = {}, = {}) req = build_request(:delete_workspace_bundle, 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.
1552 1553 1554 1555 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1552 def delete_workspace_image(params = {}, = {}) req = build_request(:delete_workspace_image, params) req.send_request() end |
#deploy_workspace_applications(params = {}) ⇒ Types::DeployWorkspaceApplicationsResult
Deploys associated applications to the specified WorkSpace
1594 1595 1596 1597 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1594 def deploy_workspace_applications(params = {}, = {}) req = build_request(:deploy_workspace_applications, 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.
1641 1642 1643 1644 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1641 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.
1665 1666 1667 1668 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1665 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.
1703 1704 1705 1706 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1703 def describe_account_modifications(params = {}, = {}) req = build_request(:describe_account_modifications, params) req.send_request() end |
#describe_application_associations(params = {}) ⇒ Types::DescribeApplicationAssociationsResult
Describes the associations between the application and the specified associated resources.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1757 1758 1759 1760 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1757 def describe_application_associations(params = {}, = {}) req = build_request(:describe_application_associations, params) req.send_request() end |
#describe_applications(params = {}) ⇒ Types::DescribeApplicationsResult
Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1826 1827 1828 1829 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1826 def describe_applications(params = {}, = {}) req = build_request(:describe_applications, params) req.send_request() end |
#describe_bundle_associations(params = {}) ⇒ Types::DescribeBundleAssociationsResult
Describes the associations between the applications and the specified bundle.
1867 1868 1869 1870 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1867 def describe_bundle_associations(params = {}, = {}) req = build_request(:describe_bundle_associations, params) req.send_request() end |
#describe_client_branding(params = {}) ⇒ Types::DescribeClientBrandingResult
Describes the specified client branding. Client branding allows you to customize the log in page of various device types for your users. You can add your company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
1947 1948 1949 1950 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1947 def describe_client_branding(params = {}, = {}) req = build_request(:describe_client_branding, params) req.send_request() end |
#describe_client_properties(params = {}) ⇒ Types::DescribeClientPropertiesResult
Retrieves a list that describes one or more specified Amazon WorkSpaces clients.
1979 1980 1981 1982 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1979 def describe_client_properties(params = {}, = {}) req = build_request(:describe_client_properties, params) req.send_request() end |
#describe_connect_client_add_ins(params = {}) ⇒ Types::DescribeConnectClientAddInsResult
Retrieves a list of Amazon Connect client add-ins that have been created.
2023 2024 2025 2026 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2023 def describe_connect_client_add_ins(params = {}, = {}) req = build_request(:describe_connect_client_add_ins, 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 Amazon Web Services account for the specified connection alias. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
2073 2074 2075 2076 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2073 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.
2131 2132 2133 2134 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2131 def describe_connection_aliases(params = {}, = {}) req = build_request(:describe_connection_aliases, params) req.send_request() end |
#describe_image_associations(params = {}) ⇒ Types::DescribeImageAssociationsResult
Describes the associations between the applications and the specified image.
2172 2173 2174 2175 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2172 def describe_image_associations(params = {}, = {}) req = build_request(:describe_image_associations, params) req.send_request() end |
#describe_ip_groups(params = {}) ⇒ Types::DescribeIpGroupsResult
Describes one or more of your IP access control groups.
2217 2218 2219 2220 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2217 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.
2249 2250 2251 2252 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2249 def (params = {}, = {}) req = build_request(:describe_tags, params) req.send_request() end |
#describe_workspace_associations(params = {}) ⇒ Types::DescribeWorkspaceAssociationsResult
Describes the associations betweens applications and the specified WorkSpace.
2290 2291 2292 2293 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2290 def describe_workspace_associations(params = {}, = {}) req = build_request(:describe_workspace_associations, 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.
2352 2353 2354 2355 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2352 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.
2435 2436 2437 2438 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2435 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 Amazon Web Services accounts for an image.
2478 2479 2480 2481 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2478 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.
2538 2539 2540 2541 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2538 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.
2570 2571 2572 2573 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2570 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.
2676 2677 2678 2679 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2676 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.
2716 2717 2718 2719 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2716 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 Regions. For more information, see Cross-Region Redirection for Amazon WorkSpaces.
CREATED
.
2752 2753 2754 2755 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2752 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.
2779 2780 2781 2782 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2779 def disassociate_ip_groups(params = {}, = {}) req = build_request(:disassociate_ip_groups, params) req.send_request() end |
#disassociate_workspace_application(params = {}) ⇒ Types::DisassociateWorkspaceApplicationResult
Disassociates the specified application from a WorkSpace.
2818 2819 2820 2821 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2818 def disassociate_workspace_application(params = {}, = {}) req = build_request(:disassociate_workspace_application, params) req.send_request() end |
#get_account_link(params = {}) ⇒ Types::GetAccountLinkResult
Retrieves account link information.
2853 2854 2855 2856 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2853 def get_account_link(params = {}, = {}) req = build_request(:get_account_link, params) req.send_request() end |
#import_client_branding(params = {}) ⇒ Types::ImportClientBrandingResult
Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.
After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience
You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.
In each platform type, the
SupportEmail
andSupportLink
parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.Imported data can take up to a minute to appear in the WorkSpaces client.
3020 3021 3022 3023 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3020 def import_client_branding(params = {}, = {}) req = build_request(:import_client_branding, params) req.send_request() end |
#import_workspace_image(params = {}) ⇒ Types::ImportWorkspaceImageResult
Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces. The image must be an already licensed Amazon EC2 image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see Bring Your Own Windows Desktop Licenses.
3115 3116 3117 3118 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3115 def import_workspace_image(params = {}, = {}) req = build_request(:import_workspace_image, params) req.send_request() end |
#list_account_links(params = {}) ⇒ Types::ListAccountLinksResult
Lists all account links.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3160 3161 3162 3163 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3160 def list_account_links(params = {}, = {}) req = build_request(:list_account_links, 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 Amazon Web Services 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.
3213 3214 3215 3216 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3213 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.
3263 3264 3265 3266 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3263 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.
3295 3296 3297 3298 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3295 def modify_account(params = {}, = {}) req = build_request(:modify_account, params) req.send_request() end |
#modify_certificate_based_auth_properties(params = {}) ⇒ Struct
Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.
3330 3331 3332 3333 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3330 def modify_certificate_based_auth_properties(params = {}, = {}) req = build_request(:modify_certificate_based_auth_properties, params) req.send_request() end |
#modify_client_properties(params = {}) ⇒ Struct
Modifies the properties of the specified Amazon WorkSpaces clients.
3359 3360 3361 3362 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3359 def modify_client_properties(params = {}, = {}) req = build_request(:modify_client_properties, params) req.send_request() end |
#modify_saml_properties(params = {}) ⇒ Struct
Modifies multiple properties related to SAML 2.0 authentication, including the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.
3404 3405 3406 3407 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3404 def modify_saml_properties(params = {}, = {}) req = build_request(:modify_saml_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.
3442 3443 3444 3445 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3442 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.
3484 3485 3486 3487 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3484 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.
3517 3518 3519 3520 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3517 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.
MANUAL
running mode value is only supported by Amazon WorkSpaces
Core. Contact your account team to be allow-listed to use this value.
For more information, see Amazon WorkSpaces Core.
3568 3569 3570 3571 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3568 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.
3600 3601 3602 3603 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3600 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
,
UNHEALTHY
, or REBOOTING
. Reboot a WorkSpace in the REBOOTING
state only if your WorkSpace has been stuck in the REBOOTING
state
for over 20 minutes.
This operation is asynchronous and returns before the WorkSpaces have rebooted.
3643 3644 3645 3646 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3643 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.
3692 3693 3694 3695 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3692 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.
3770 3771 3772 3773 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3770 def register_workspace_directory(params = {}, = {}) req = build_request(:register_workspace_directory, params) req.send_request() end |
#reject_account_link_invitation(params = {}) ⇒ Types::RejectAccountLinkInvitationResult
Rejects the account link invitation.
3805 3806 3807 3808 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3805 def reject_account_link_invitation(params = {}, = {}) req = build_request(:reject_account_link_invitation, 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.
3841 3842 3843 3844 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3841 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.
3867 3868 3869 3870 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3867 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
.
3905 3906 3907 3908 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3905 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
.
3943 3944 3945 3946 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3943 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 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.
4012 4013 4014 4015 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4012 def terminate_workspaces(params = {}, = {}) req = build_request(:terminate_workspaces, params) req.send_request() end |
#update_connect_client_add_in(params = {}) ⇒ Struct
Updates a Amazon Connect client add-in. Use this action to update the name and endpoint URL of a Amazon Connect client add-in.
4047 4048 4049 4050 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4047 def update_connect_client_add_in(params = {}, = {}) req = build_request(:update_connect_client_add_in, 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.
4102 4103 4104 4105 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4102 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.
4134 4135 4136 4137 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4134 def update_rules_of_ip_group(params = {}, = {}) req = build_request(:update_rules_of_ip_group, params) req.send_request() end |
#update_workspace_bundle(params = {}) ⇒ Struct
Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see Update a Custom WorkSpaces Bundle.
Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.
4171 4172 4173 4174 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4171 def update_workspace_bundle(params = {}, = {}) req = build_request(:update_workspace_bundle, params) req.send_request() end |
#update_workspace_image_permission(params = {}) ⇒ Struct
Shares or unshares an image with one account in the same Amazon Web Services 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 Regions as needed.
In the China (Ningxia) Region, you can copy images only within the same Region.
In Amazon Web Services GovCloud (US), to copy images to and from other Regions, contact Amazon Web Services Support.
For more information about sharing images, see Share or Unshare a Custom WorkSpaces Image.
- Sharing Bring Your Own License (BYOL) images across Amazon Web Services accounts isn't supported at this time in Amazon Web Services GovCloud (US). To share BYOL images across accounts in Amazon Web Services GovCloud (US), contact Amazon Web Services Support.
4237 4238 4239 4240 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4237 def (params = {}, = {}) req = build_request(:update_workspace_image_permission, params) req.send_request() end |