ExAws.Workspaces.Core
Amazon WorkSpaces
Amazon WorkSpaces Service
This is the Amazon WorkSpaces API Reference. This guide provides detailed information about Amazon WorkSpaces operations, data types, parameters, and errors.
Summary↑
Types ↑
subnet_ids :: [subnet_id]
directory_id :: binary
create_workspaces_request :: [{:workspaces, workspace_request_list}]
workspace :: [bundle_id: bundle_id, directory_id: directory_id, error_code: workspace_error_code, error_message: description, ip_address: ip_address, state: workspace_state, subnet_id: subnet_id, user_name: user_name, workspace_id: workspace_id]
workspace_directory_state :: binary
rebuild_workspaces_result :: [{:failed_requests, failed_rebuild_workspace_requests}]
resource_limit_exceeded_exception :: [{:message, exception_message}]
registration_code :: binary
failed_create_workspace_request :: [error_code: error_type, error_message: description, workspace_request: workspace_request]
workspace_bundle :: [bundle_id: bundle_id, compute_type: compute_type, description: description, name: non_empty_string, owner: bundle_owner, user_storage: user_storage]
reboot_workspaces_result :: [{:failed_requests, failed_reboot_workspace_requests}]
arn :: binary
compute :: binary
default_workspace_creation_properties :: [custom_security_group_id: security_group_id, default_ou: default_ou, enable_internet_access: boolean_object, enable_work_docs: boolean_object, user_enabled_as_local_administrator: boolean_object]
limit :: integer
boolean_object :: boolean
bundle_id :: binary
describe_workspaces_request :: [bundle_id: bundle_id, directory_id: directory_id, limit: limit, next_token: pagination_token, user_name: user_name, workspace_ids: workspace_id_list]
invalid_parameter_values_exception :: [{:message, exception_message}]
terminate_workspaces_result :: [{:failed_requests, failed_terminate_workspace_requests}]
description :: binary
reboot_request :: [{:workspace_id, workspace_id}]
non_empty_string :: binary
bundle_id_list :: [bundle_id]
rebuild_workspaces_request :: [{:rebuild_workspace_requests, rebuild_workspace_requests}]
describe_workspace_directories_request :: [directory_ids: directory_id_list, next_token: pagination_token]
default_ou :: binary
workspace_error_code :: binary
alias :: binary
describe_workspace_directories_result :: [directories: directory_list, next_token: pagination_token]
security_group_id :: binary
compute_type :: [{:name, compute}]
workspace_directory :: [alias: alias, customer_user_name: user_name, directory_id: directory_id, directory_name: directory_name, directory_type: workspace_directory_type, dns_ip_addresses: dns_ip_addresses, iam_role_id: arn, registration_code: registration_code, state: workspace_directory_state, subnet_ids: subnet_ids, workspace_creation_properties: default_workspace_creation_properties, workspace_security_group_id: security_group_id]
workspace_request :: [bundle_id: bundle_id, directory_id: directory_id, user_name: user_name]
directory_name :: binary
subnet_id :: binary
rebuild_request :: [{:workspace_id, workspace_id}]
workspace_directory_type :: binary
ip_address :: binary
error_type :: binary
user_name :: binary
bundle_owner :: binary
describe_workspaces_result :: [next_token: pagination_token, workspaces: workspace_list]
workspace_list :: [workspace]
pagination_token :: binary
create_workspaces_result :: [failed_requests: failed_create_workspace_requests, pending_requests: workspace_list]
exception_message :: binary
reboot_workspaces_request :: [{:reboot_workspace_requests, reboot_workspace_requests}]
describe_workspace_bundles_request :: [bundle_ids: bundle_id_list, next_token: pagination_token, owner: bundle_owner]
describe_workspace_bundles_result :: [bundles: bundle_list, next_token: pagination_token]
terminate_request :: [{:workspace_id, workspace_id}]
user_storage :: [{:capacity, non_empty_string}]
failed_workspace_change_request :: [error_code: error_type, error_message: description, workspace_id: workspace_id]
workspace_id :: binary
terminate_workspaces_request :: [{:terminate_workspace_requests, terminate_workspace_requests}]
workspace_state :: binary
Functions
Specs:
- create_workspaces(client :: ExAws.Workspaces.t, input :: create_workspaces_request) :: ExAws.Request.JSON.response_t
CreateWorkspaces
Creates one or more WorkSpaces.
Note: This operation is asynchronous and returns before the WorkSpaces are created.
Specs:
- create_workspaces!(client :: ExAws.Workspaces.t, input :: create_workspaces_request) :: ExAws.Request.JSON.success_t | no_return
Same as create_workspaces/2
but raise on error.
Specs:
- describe_workspace_bundles(client :: ExAws.Workspaces.t, input :: describe_workspace_bundles_request) :: ExAws.Request.JSON.response_t
DescribeWorkspaceBundles
Obtains information about the WorkSpace bundles that are available to your account in the specified region.
You can filter the results with either the BundleIds
parameter, or the
Owner
parameter, but not both.
This operation supports pagination with the use of the NextToken
request
and response parameters. If more results are available, the NextToken
response member contains a token that you pass in the next call to this
operation to retrieve the next set of items.
Specs:
- describe_workspace_bundles!(client :: ExAws.Workspaces.t, input :: describe_workspace_bundles_request) :: ExAws.Request.JSON.success_t | no_return
Same as describe_workspace_bundles/2
but raise on error.
Specs:
- describe_workspace_directories(client :: ExAws.Workspaces.t, input :: describe_workspace_directories_request) :: ExAws.Request.JSON.response_t
DescribeWorkspaceDirectories
Retrieves information about the AWS Directory Service directories in the region that are registered with Amazon WorkSpaces and are available to your account.
This operation supports pagination with the use of the NextToken
request
and response parameters. If more results are available, the NextToken
response member contains a token that you pass in the next call to this
operation to retrieve the next set of items.
Specs:
- describe_workspace_directories!(client :: ExAws.Workspaces.t, input :: describe_workspace_directories_request) :: ExAws.Request.JSON.success_t | no_return
Same as describe_workspace_directories/2
but raise on error.
Specs:
- describe_workspaces(client :: ExAws.Workspaces.t, input :: describe_workspaces_request) :: ExAws.Request.JSON.response_t
DescribeWorkspaces
Obtains information about the specified WorkSpaces.
Only one of the filter parameters, such as BundleId
, DirectoryId
, or
WorkspaceIds
, can be specified at a time.
This operation supports pagination with the use of the NextToken
request
and response parameters. If more results are available, the NextToken
response member contains a token that you pass in the next call to this
operation to retrieve the next set of items.
Specs:
- describe_workspaces!(client :: ExAws.Workspaces.t, input :: describe_workspaces_request) :: ExAws.Request.JSON.success_t | no_return
Same as describe_workspaces/2
but raise on error.
Specs:
- reboot_workspaces(client :: ExAws.Workspaces.t, input :: reboot_workspaces_request) :: ExAws.Request.JSON.response_t
RebootWorkspaces
Reboots the specified WorkSpaces.
To be able to reboot a WorkSpace, the WorkSpace must have a State of
AVAILABLE
, IMPAIRED
, or INOPERABLE
.
Note: This operation is asynchronous and will return before the WorkSpaces have rebooted.
Specs:
- reboot_workspaces!(client :: ExAws.Workspaces.t, input :: reboot_workspaces_request) :: ExAws.Request.JSON.success_t | no_return
Same as reboot_workspaces/2
but raise on error.
Specs:
- rebuild_workspaces(client :: ExAws.Workspaces.t, input :: rebuild_workspaces_request) :: ExAws.Request.JSON.response_t
RebuildWorkspaces
Rebuilds the specified WorkSpaces.
Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. Rebuilding a WorkSpace causes the following to occur:
The system is restored to the image of the bundle that the WorkSpace is created from. Any applications that have been installed, or system settings that have been made since the WorkSpace was created will be lost.
- The data drive (D drive) is re-created from the last automatic snapshot taken of the data drive. The current contents of the data drive are overwritten. Automatic snapshots of the data drive are taken every 12 hours, so the snapshot can be as much as 12 hours old.
To be able to rebuild a WorkSpace, the WorkSpace must have a State of
AVAILABLE
or ERROR
.
Note: This operation is asynchronous and will return before the WorkSpaces have been completely rebuilt.
Specs:
- rebuild_workspaces!(client :: ExAws.Workspaces.t, input :: rebuild_workspaces_request) :: ExAws.Request.JSON.success_t | no_return
Same as rebuild_workspaces/2
but raise on error.
Specs:
- terminate_workspaces(client :: ExAws.Workspaces.t, input :: terminate_workspaces_request) :: ExAws.Request.JSON.response_t
TerminateWorkspaces
Terminates the specified WorkSpaces.
Terminating a WorkSpace is a permanent action and cannot be undone. The user’s data is not maintained and will be destroyed. If you need to archive any user data, contact Amazon Web Services before terminating the WorkSpace.
You can terminate a WorkSpace that is in any state except SUSPENDED
.
Note: This operation is asynchronous and will return before the WorkSpaces have been completely terminated.
Specs:
- terminate_workspaces!(client :: ExAws.Workspaces.t, input :: terminate_workspaces_request) :: ExAws.Request.JSON.success_t | no_return
Same as terminate_workspaces/2
but raise on error.