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.
429 430 431 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 429 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.
469 470 471 472 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 469 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
.
515 516 517 518 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 515 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.
542 543 544 545 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 542 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.
581 582 583 584 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 581 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.
615 616 617 618 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 615 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.
684 685 686 687 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 684 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.
720 721 722 723 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 720 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.
760 761 762 763 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 760 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.
810 811 812 813 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 810 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.
874 875 876 877 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 874 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.
934 935 936 937 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 934 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.
967 968 969 970 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 967 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.
1040 1041 1042 1043 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1040 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.
1126 1127 1128 1129 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1126 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.
1187 1188 1189 1190 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1187 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?
1322 1323 1324 1325 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1322 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.
1412 1413 1414 1415 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1412 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.
1448 1449 1450 1451 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1448 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.
1482 1483 1484 1485 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1482 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.
1509 1510 1511 1512 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1509 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.
1552 1553 1554 1555 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1552 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.
1577 1578 1579 1580 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1577 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.
1605 1606 1607 1608 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1605 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.
1633 1634 1635 1636 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1633 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.
1657 1658 1659 1660 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1657 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
1699 1700 1701 1702 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1699 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.
1746 1747 1748 1749 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1746 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.
1770 1771 1772 1773 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1770 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.
1808 1809 1810 1811 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1808 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.
1862 1863 1864 1865 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1862 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.
1931 1932 1933 1934 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1931 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.
1972 1973 1974 1975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1972 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.
2052 2053 2054 2055 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2052 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.
2084 2085 2086 2087 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2084 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.
2128 2129 2130 2131 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2128 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.
2178 2179 2180 2181 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2178 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.
2236 2237 2238 2239 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2236 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.
2277 2278 2279 2280 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2277 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.
2322 2323 2324 2325 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2322 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.
2354 2355 2356 2357 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2354 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.
2395 2396 2397 2398 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2395 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.
2457 2458 2459 2460 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2457 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.
2560 2561 2562 2563 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2560 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.
2603 2604 2605 2606 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2603 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.
2663 2664 2665 2666 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2663 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.
2695 2696 2697 2698 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2695 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.
2801 2802 2803 2804 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2801 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.
2841 2842 2843 2844 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2841 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.
2895 2896 2897 2898 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2895 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.
2965 2966 2967 2968 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2965 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
.
3001 3002 3003 3004 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3001 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.
3028 3029 3030 3031 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3028 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.
3067 3068 3069 3070 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3067 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.
3102 3103 3104 3105 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3102 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.
3269 3270 3271 3272 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3269 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.
3366 3367 3368 3369 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3366 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.
3411 3412 3413 3414 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3411 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.
3464 3465 3466 3467 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3464 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.
3514 3515 3516 3517 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3514 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.
3546 3547 3548 3549 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3546 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.
3581 3582 3583 3584 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3581 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.
3610 3611 3612 3613 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3610 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.
3655 3656 3657 3658 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3655 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.
3693 3694 3695 3696 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3693 def (params = {}, = {}) req = build_request(:modify_selfservice_permissions, params) req.send_request() end |
#modify_streaming_properties(params = {}) ⇒ Struct
Modifies the specified streaming properties.
3734 3735 3736 3737 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3734 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.
3776 3777 3778 3779 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3776 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.
3810 3811 3812 3813 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3810 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.
3861 3862 3863 3864 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3861 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.
3893 3894 3895 3896 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3893 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.
3936 3937 3938 3939 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3936 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.
3985 3986 3987 3988 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3985 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.
4095 4096 4097 4098 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4095 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.
4130 4131 4132 4133 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4130 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.
4166 4167 4168 4169 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4166 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.
4192 4193 4194 4195 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4192 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
.
4230 4231 4232 4233 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4230 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
.
4255 4256 4257 4258 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4255 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
and a state of AVAILABLE
, IMPAIRED
, UNHEALTHY
, or ERROR
.
4293 4294 4295 4296 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4293 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
.
4319 4320 4321 4322 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4319 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.
4388 4389 4390 4391 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4388 def terminate_workspaces(params = {}, = {}) req = build_request(:terminate_workspaces, params) req.send_request() end |
#terminate_workspaces_pool(params = {}) ⇒ Struct
Terminates the specified pool.
4410 4411 4412 4413 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4410 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.
4432 4433 4434 4435 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4432 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.
4467 4468 4469 4470 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4467 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.
4522 4523 4524 4525 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4522 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.
4554 4555 4556 4557 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4554 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.
4591 4592 4593 4594 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4591 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.
4657 4658 4659 4660 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4657 def (params = {}, = {}) req = build_request(:update_workspace_image_permission, params) req.send_request() end |
#update_workspaces_pool(params = {}) ⇒ Types::UpdateWorkspacesPoolResult
Updates the specified pool.
4738 4739 4740 4741 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 4738 def update_workspaces_pool(params = {}, = {}) req = build_request(:update_workspaces_pool, params) req.send_request() end |