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.
-
#create_workspaces_pool(params = {}) ⇒ Types::CreateWorkspacesPoolResult
Creates a pool of 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.
-
#describe_workspaces_pool_sessions(params = {}) ⇒ Types::DescribeWorkspacesPoolSessionsResult
Retrieves a list that describes the streaming sessions for a specified pool.
-
#describe_workspaces_pools(params = {}) ⇒ Types::DescribeWorkspacesPoolsResult
Describes the specified WorkSpaces Pools.
-
#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_streaming_properties(params = {}) ⇒ Struct
Modifies the specified streaming properties.
-
#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 = {}) ⇒ Types::RegisterWorkspaceDirectoryResult
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.
-
#start_workspaces_pool(params = {}) ⇒ Struct
Starts the specified pool.
-
#stop_workspaces(params = {}) ⇒ Types::StopWorkspacesResult
Stops the specified WorkSpaces.
-
#stop_workspaces_pool(params = {}) ⇒ Struct
Stops the specified pool.
-
#terminate_workspaces(params = {}) ⇒ Types::TerminateWorkspacesResult
Terminates the specified WorkSpaces.
-
#terminate_workspaces_pool(params = {}) ⇒ Struct
Terminates the specified pool.
-
#terminate_workspaces_pool_session(params = {}) ⇒ Struct
Terminates the pool session.
-
#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.
-
#update_workspaces_pool(params = {}) ⇒ Types::UpdateWorkspacesPoolResult
Updates the specified pool.
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.
451 452 453 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 451 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.
491 492 493 494 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 491 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
.
537 538 539 540 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 537 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.
564 565 566 567 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 564 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.
603 604 605 606 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 603 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.
637 638 639 640 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 637 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.
706 707 708 709 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 706 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.
742 743 744 745 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 742 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.
782 783 784 785 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 782 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.
832 833 834 835 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 832 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.
896 897 898 899 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 896 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.
956 957 958 959 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 956 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.
989 990 991 992 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 989 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.
1062 1063 1064 1065 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1062 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.
1148 1149 1150 1151 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1148 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.
1209 1210 1211 1212 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1209 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.
Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?
1344 1345 1346 1347 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1344 def create_workspaces(params = {}, = {}) req = build_request(:create_workspaces, params) req.send_request() end |
#create_workspaces_pool(params = {}) ⇒ Types::CreateWorkspacesPoolResult
Creates a pool of WorkSpaces.
1434 1435 1436 1437 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1434 def create_workspaces_pool(params = {}, = {}) req = build_request(:create_workspaces_pool, params) req.send_request() end |
#delete_account_link_invitation(params = {}) ⇒ Types::DeleteAccountLinkInvitationResult
Deletes the account link invitation.
1470 1471 1472 1473 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1470 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.
1504 1505 1506 1507 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1504 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.
1531 1532 1533 1534 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1531 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.
1574 1575 1576 1577 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1574 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.
1599 1600 1601 1602 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1599 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.
1627 1628 1629 1630 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1627 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.
1655 1656 1657 1658 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1655 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.
1679 1680 1681 1682 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1679 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
1721 1722 1723 1724 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1721 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.
1768 1769 1770 1771 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1768 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.
1792 1793 1794 1795 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1792 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.
1830 1831 1832 1833 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1830 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.
1884 1885 1886 1887 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1884 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.
1953 1954 1955 1956 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1953 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.
1994 1995 1996 1997 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1994 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.
2074 2075 2076 2077 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2074 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.
2106 2107 2108 2109 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2106 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.
2150 2151 2152 2153 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2150 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.
2200 2201 2202 2203 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2200 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.
2258 2259 2260 2261 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2258 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.
2299 2300 2301 2302 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2299 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.
2344 2345 2346 2347 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2344 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.
2376 2377 2378 2379 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2376 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.
2417 2418 2419 2420 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2417 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.
2479 2480 2481 2482 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2479 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.
2595 2596 2597 2598 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2595 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.
2638 2639 2640 2641 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2638 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.
2698 2699 2700 2701 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2698 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.
2730 2731 2732 2733 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2730 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.
2836 2837 2838 2839 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2836 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.
2876 2877 2878 2879 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2876 def describe_workspaces_connection_status(params = {}, = {}) req = build_request(:describe_workspaces_connection_status, params) req.send_request() end |
#describe_workspaces_pool_sessions(params = {}) ⇒ Types::DescribeWorkspacesPoolSessionsResult
Retrieves a list that describes the streaming sessions for a specified pool.
2930 2931 2932 2933 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2930 def describe_workspaces_pool_sessions(params = {}, = {}) req = build_request(:describe_workspaces_pool_sessions, params) req.send_request() end |
#describe_workspaces_pools(params = {}) ⇒ Types::DescribeWorkspacesPoolsResult
Describes the specified WorkSpaces Pools.
3000 3001 3002 3003 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3000 def describe_workspaces_pools(params = {}, = {}) req = build_request(:describe_workspaces_pools, 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
.
3036 3037 3038 3039 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3036 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.
3063 3064 3065 3066 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3063 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.
3102 3103 3104 3105 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3102 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.
3137 3138 3139 3140 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3137 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.
3304 3305 3306 3307 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3304 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.
3401 3402 3403 3404 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3401 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.
3446 3447 3448 3449 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3446 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.
3499 3500 3501 3502 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3499 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.
3549 3550 3551 3552 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3549 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.
3581 3582 3583 3584 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3581 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.
3616 3617 3618 3619 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3616 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.
3645 3646 3647 3648 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3645 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.
3690 3691 3692 3693 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3690 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.
3728 3729 3730 3731 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3728 def (params = {}, = {}) req = build_request(:modify_selfservice_permissions, params) req.send_request() end |
#modify_streaming_properties(params = {}) ⇒ Struct
Modifies the specified streaming properties.
3769 3770 3771 3772 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3769 def modify_streaming_properties(params = {}, = {}) req = build_request(:modify_streaming_properties, 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.
3811 3812 3813 3814 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3811 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.
3845 3846 3847 3848 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3845 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.
3896 3897 3898 3899 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3896 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.
3928 3929 3930 3931 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3928 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.
3971 3972 3973 3974 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3971 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.
4020 4021 4022 4023 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4020 def rebuild_workspaces(params = {}, = {}) req = build_request(:rebuild_workspaces, params) req.send_request() end |
#register_workspace_directory(params = {}) ⇒ Types::RegisterWorkspaceDirectoryResult
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.
4141 4142 4143 4144 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4141 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.
4176 4177 4178 4179 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4176 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.
4212 4213 4214 4215 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4212 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.
4238 4239 4240 4241 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4238 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
or Manual
and a state of STOPPED
.
4276 4277 4278 4279 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4276 def start_workspaces(params = {}, = {}) req = build_request(:start_workspaces, params) req.send_request() end |
#start_workspaces_pool(params = {}) ⇒ Struct
Starts the specified pool.
You cannot start a pool unless it has a running mode of AutoStop
and
a state of STOPPED
.
4301 4302 4303 4304 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4301 def start_workspaces_pool(params = {}, = {}) req = build_request(:start_workspaces_pool, 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
or Manual
and a state of AVAILABLE
, IMPAIRED
, UNHEALTHY
, or
ERROR
.
4340 4341 4342 4343 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4340 def stop_workspaces(params = {}, = {}) req = build_request(:stop_workspaces, params) req.send_request() end |
#stop_workspaces_pool(params = {}) ⇒ Struct
Stops the specified pool.
You cannot stop a WorkSpace pool unless it has a running mode of
AutoStop
and a state of AVAILABLE
, IMPAIRED
, UNHEALTHY
, or
ERROR
.
4366 4367 4368 4369 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4366 def stop_workspaces_pool(params = {}, = {}) req = build_request(:stop_workspaces_pool, 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.
4435 4436 4437 4438 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4435 def terminate_workspaces(params = {}, = {}) req = build_request(:terminate_workspaces, params) req.send_request() end |
#terminate_workspaces_pool(params = {}) ⇒ Struct
Terminates the specified pool.
4457 4458 4459 4460 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4457 def terminate_workspaces_pool(params = {}, = {}) req = build_request(:terminate_workspaces_pool, params) req.send_request() end |
#terminate_workspaces_pool_session(params = {}) ⇒ Struct
Terminates the pool session.
4479 4480 4481 4482 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4479 def terminate_workspaces_pool_session(params = {}, = {}) req = build_request(:terminate_workspaces_pool_session, 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.
4514 4515 4516 4517 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4514 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.
4569 4570 4571 4572 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4569 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.
4601 4602 4603 4604 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4601 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.
4638 4639 4640 4641 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4638 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.
4704 4705 4706 4707 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4704 def (params = {}, = {}) req = build_request(:update_workspace_image_permission, params) req.send_request() end |
#update_workspaces_pool(params = {}) ⇒ Types::UpdateWorkspacesPoolResult
Updates the specified pool.
4785 4786 4787 4788 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4785 def update_workspaces_pool(params = {}, = {}) req = build_request(:update_workspaces_pool, params) req.send_request() end |