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.

Source

Summary

create_workspaces!(client, input)

Same as create_workspaces/2 but raise on error

create_workspaces(client, input)

CreateWorkspaces

describe_workspace_bundles!(client, input)

Same as describe_workspace_bundles/2 but raise on error

describe_workspace_bundles(client, input)

DescribeWorkspaceBundles

describe_workspace_directories!(client, input)

Same as describe_workspace_directories/2 but raise on error

describe_workspace_directories(client, input)

DescribeWorkspaceDirectories

describe_workspaces!(client, input)

Same as describe_workspaces/2 but raise on error

describe_workspaces(client, input)

DescribeWorkspaces

reboot_workspaces!(client, input)

Same as reboot_workspaces/2 but raise on error

reboot_workspaces(client, input)

RebootWorkspaces

rebuild_workspaces!(client, input)

Same as rebuild_workspaces/2 but raise on error

rebuild_workspaces(client, input)

RebuildWorkspaces

terminate_workspaces!(client, input)

Same as terminate_workspaces/2 but raise on error

terminate_workspaces(client, input)

TerminateWorkspaces

Types

directory_id :: binary

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]

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]

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]

description :: binary

reboot_request :: [{:workspace_id, workspace_id}]

non_empty_string :: binary

rebuild_workspaces_request :: [{:rebuild_workspace_requests, rebuild_workspace_requests}]

default_ou :: binary

alias :: binary

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}]

ip_address :: binary

error_type :: binary

user_name :: binary

bundle_owner :: binary

pagination_token :: binary

exception_message :: binary

reboot_workspaces_request :: [{:reboot_workspace_requests, reboot_workspace_requests}]

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

create_workspaces(client, input)

Specs:

CreateWorkspaces

Creates one or more WorkSpaces.

Note: This operation is asynchronous and returns before the WorkSpaces are created.

Source
create_workspaces!(client, input)

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.

Source
describe_workspace_bundles(client, input)

Specs:

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.

Source
describe_workspace_bundles!(client, input)

Specs:

Same as describe_workspace_bundles/2 but raise on error.

Source
describe_workspace_directories(client, input)

Specs:

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.

Source
describe_workspace_directories!(client, input)

Specs:

Same as describe_workspace_directories/2 but raise on error.

Source
describe_workspaces(client, input)

Specs:

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.

Source
describe_workspaces!(client, input)

Specs:

Same as describe_workspaces/2 but raise on error.

Source
reboot_workspaces(client, input)

Specs:

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.

Source
reboot_workspaces!(client, input)

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.

Source
rebuild_workspaces(client, input)

Specs:

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.

Source
rebuild_workspaces!(client, input)

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.

Source
terminate_workspaces(client, input)

Specs:

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.

Source
terminate_workspaces!(client, input)

Specs:

Same as terminate_workspaces/2 but raise on error.

Source