You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::WorkSpaces::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#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(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



152
153
154
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 152

def initialize(*args)
  super
end

Instance Method Details

#create_tags(params = {}) ⇒ Struct

Creates tags for the specified WorkSpace.

Examples:

Request syntax with placeholder values


resp = client.create_tags({
  resource_id: "NonEmptyString", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_id (required, String)

    The ID of the resource.

  • :tags (required, Array<Types::Tag>)

    The tags. Each resource can have a maximum of 50 tags.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



184
185
186
187
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 184

def create_tags(params = {}, options = {})
  req = build_request(:create_tags, params)
  req.send_request(options)
end

#create_workspaces(params = {}) ⇒ Types::CreateWorkspacesResult

Creates one or more WorkSpaces.

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

Examples:

Request syntax with placeholder values


resp = client.create_workspaces({
  workspaces: [ # required
    {
      directory_id: "DirectoryId", # required
      user_name: "UserName", # required
      bundle_id: "BundleId", # required
      volume_encryption_key: "VolumeEncryptionKey",
      user_volume_encryption_enabled: false,
      root_volume_encryption_enabled: false,
      workspace_properties: {
        running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
        running_mode_auto_stop_timeout_in_minutes: 1,
        root_volume_size_gib: 1,
        user_volume_size_gib: 1,
        compute_type_name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS
      },
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue",
        },
      ],
    },
  ],
})

Response structure


resp.failed_requests #=> Array
resp.failed_requests[0].workspace_request.directory_id #=> String
resp.failed_requests[0].workspace_request.user_name #=> String
resp.failed_requests[0].workspace_request.bundle_id #=> String
resp.failed_requests[0].workspace_request.volume_encryption_key #=> String
resp.failed_requests[0].workspace_request.user_volume_encryption_enabled #=> Boolean
resp.failed_requests[0].workspace_request.root_volume_encryption_enabled #=> Boolean
resp.failed_requests[0].workspace_request.workspace_properties.running_mode #=> String, one of "AUTO_STOP", "ALWAYS_ON"
resp.failed_requests[0].workspace_request.workspace_properties.running_mode_auto_stop_timeout_in_minutes #=> Integer
resp.failed_requests[0].workspace_request.workspace_properties.root_volume_size_gib #=> Integer
resp.failed_requests[0].workspace_request.workspace_properties.user_volume_size_gib #=> Integer
resp.failed_requests[0].workspace_request.workspace_properties.compute_type_name #=> String, one of "VALUE", "STANDARD", "PERFORMANCE", "POWER", "GRAPHICS"
resp.failed_requests[0].workspace_request.tags #=> Array
resp.failed_requests[0].workspace_request.tags[0].key #=> String
resp.failed_requests[0].workspace_request.tags[0].value #=> String
resp.failed_requests[0].error_code #=> String
resp.failed_requests[0].error_message #=> String
resp.pending_requests #=> Array
resp.pending_requests[0].workspace_id #=> String
resp.pending_requests[0].directory_id #=> String
resp.pending_requests[0].user_name #=> String
resp.pending_requests[0].ip_address #=> String
resp.pending_requests[0].state #=> String, one of "PENDING", "AVAILABLE", "IMPAIRED", "UNHEALTHY", "REBOOTING", "STARTING", "REBUILDING", "MAINTENANCE", "TERMINATING", "TERMINATED", "SUSPENDED", "UPDATING", "STOPPING", "STOPPED", "ERROR"
resp.pending_requests[0].bundle_id #=> String
resp.pending_requests[0].subnet_id #=> String
resp.pending_requests[0].error_message #=> String
resp.pending_requests[0].error_code #=> String
resp.pending_requests[0].computer_name #=> String
resp.pending_requests[0].volume_encryption_key #=> String
resp.pending_requests[0].user_volume_encryption_enabled #=> Boolean
resp.pending_requests[0].root_volume_encryption_enabled #=> Boolean
resp.pending_requests[0].workspace_properties.running_mode #=> String, one of "AUTO_STOP", "ALWAYS_ON"
resp.pending_requests[0].workspace_properties.running_mode_auto_stop_timeout_in_minutes #=> Integer
resp.pending_requests[0].workspace_properties.root_volume_size_gib #=> Integer
resp.pending_requests[0].workspace_properties.user_volume_size_gib #=> Integer
resp.pending_requests[0].workspace_properties.compute_type_name #=> String, one of "VALUE", "STANDARD", "PERFORMANCE", "POWER", "GRAPHICS"
resp.pending_requests[0].modification_states #=> Array
resp.pending_requests[0].modification_states[0].resource #=> String, one of "ROOT_VOLUME", "USER_VOLUME", "COMPUTE_TYPE"
resp.pending_requests[0].modification_states[0].state #=> String, one of "UPDATE_INITIATED", "UPDATE_IN_PROGRESS"

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

See Also:



276
277
278
279
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 276

def create_workspaces(params = {}, options = {})
  req = build_request(:create_workspaces, params)
  req.send_request(options)
end

#delete_tags(params = {}) ⇒ Struct

Deletes the specified tags from a WorkSpace.

Examples:

Request syntax with placeholder values


resp = client.delete_tags({
  resource_id: "NonEmptyString", # required
  tag_keys: ["NonEmptyString"], # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_id (required, String)

    The ID of the resource.

  • :tag_keys (required, Array<String>)

    The tag keys.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



302
303
304
305
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 302

def delete_tags(params = {}, options = {})
  req = build_request(:delete_tags, params)
  req.send_request(options)
end

#describe_tags(params = {}) ⇒ Types::DescribeTagsResult

Describes the tags for the specified WorkSpace.

Examples:

Request syntax with placeholder values


resp = client.describe_tags({
  resource_id: "NonEmptyString", # required
})

Response structure


resp.tag_list #=> Array
resp.tag_list[0].key #=> String
resp.tag_list[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :resource_id (required, String)

    The ID of the resource.

Returns:

See Also:



332
333
334
335
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 332

def describe_tags(params = {}, options = {})
  req = build_request(:describe_tags, params)
  req.send_request(options)
end

#describe_workspace_bundles(params = {}) ⇒ Types::DescribeWorkspaceBundlesResult

Describes the available WorkSpace bundles.

You can filter the results using either bundle ID or owner, but not both.

Examples:

Request syntax with placeholder values


resp = client.describe_workspace_bundles({
  bundle_ids: ["BundleId"],
  owner: "BundleOwner",
  next_token: "PaginationToken",
})

Response structure


resp.bundles #=> Array
resp.bundles[0].bundle_id #=> String
resp.bundles[0].name #=> String
resp.bundles[0].owner #=> String
resp.bundles[0].description #=> String
resp.bundles[0].root_storage.capacity #=> String
resp.bundles[0].user_storage.capacity #=> String
resp.bundles[0].compute_type.name #=> String, one of "VALUE", "STANDARD", "PERFORMANCE", "POWER", "GRAPHICS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :bundle_ids (Array<String>)

    The IDs of the bundles. This parameter cannot be combined with any other filter.

  • :owner (String)

    The owner of the bundles. This parameter cannot be combined with any other filter.

    Specify AMAZON to describe the bundles provided by AWS or null to describe the bundles that belong to your account.

  • :next_token (String)

    The token for the next set of results. (You received this token from a previous call.)

Returns:

See Also:



386
387
388
389
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 386

def describe_workspace_bundles(params = {}, options = {})
  req = build_request(:describe_workspace_bundles, params)
  req.send_request(options)
end

#describe_workspace_directories(params = {}) ⇒ Types::DescribeWorkspaceDirectoriesResult

Describes the available AWS Directory Service directories that are registered with Amazon WorkSpaces.

Examples:

Request syntax with placeholder values


resp = client.describe_workspace_directories({
  directory_ids: ["DirectoryId"],
  next_token: "PaginationToken",
})

Response structure


resp.directories #=> Array
resp.directories[0].directory_id #=> String
resp.directories[0].alias #=> String
resp.directories[0].directory_name #=> String
resp.directories[0].registration_code #=> String
resp.directories[0].subnet_ids #=> Array
resp.directories[0].subnet_ids[0] #=> String
resp.directories[0].dns_ip_addresses #=> Array
resp.directories[0].dns_ip_addresses[0] #=> String
resp.directories[0].customer_user_name #=> String
resp.directories[0].iam_role_id #=> String
resp.directories[0].directory_type #=> String, one of "SIMPLE_AD", "AD_CONNECTOR"
resp.directories[0].workspace_security_group_id #=> String
resp.directories[0].state #=> String, one of "REGISTERING", "REGISTERED", "DEREGISTERING", "DEREGISTERED", "ERROR"
resp.directories[0].workspace_creation_properties.enable_work_docs #=> Boolean
resp.directories[0].workspace_creation_properties.enable_internet_access #=> Boolean
resp.directories[0].workspace_creation_properties.default_ou #=> String
resp.directories[0].workspace_creation_properties.custom_security_group_id #=> String
resp.directories[0].workspace_creation_properties.user_enabled_as_local_administrator #=> Boolean
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :directory_ids (Array<String>)

    The identifiers of the directories. If the value is null, all directories are retrieved.

  • :next_token (String)

    The token for the next set of results. (You received this token from a previous call.)

Returns:

See Also:



441
442
443
444
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 441

def describe_workspace_directories(params = {}, options = {})
  req = build_request(:describe_workspace_directories, params)
  req.send_request(options)
end

#describe_workspaces(params = {}) ⇒ Types::DescribeWorkspacesResult

Describes the specified WorkSpaces.

You can filter the results using bundle ID, directory ID, or owner, but you can specify only one filter at a time.

Examples:

Request syntax with placeholder values


resp = client.describe_workspaces({
  workspace_ids: ["WorkspaceId"],
  directory_id: "DirectoryId",
  user_name: "UserName",
  bundle_id: "BundleId",
  limit: 1,
  next_token: "PaginationToken",
})

Response structure


resp.workspaces #=> Array
resp.workspaces[0].workspace_id #=> String
resp.workspaces[0].directory_id #=> String
resp.workspaces[0].user_name #=> String
resp.workspaces[0].ip_address #=> String
resp.workspaces[0].state #=> String, one of "PENDING", "AVAILABLE", "IMPAIRED", "UNHEALTHY", "REBOOTING", "STARTING", "REBUILDING", "MAINTENANCE", "TERMINATING", "TERMINATED", "SUSPENDED", "UPDATING", "STOPPING", "STOPPED", "ERROR"
resp.workspaces[0].bundle_id #=> String
resp.workspaces[0].subnet_id #=> String
resp.workspaces[0].error_message #=> String
resp.workspaces[0].error_code #=> String
resp.workspaces[0].computer_name #=> String
resp.workspaces[0].volume_encryption_key #=> String
resp.workspaces[0].user_volume_encryption_enabled #=> Boolean
resp.workspaces[0].root_volume_encryption_enabled #=> Boolean
resp.workspaces[0].workspace_properties.running_mode #=> String, one of "AUTO_STOP", "ALWAYS_ON"
resp.workspaces[0].workspace_properties.running_mode_auto_stop_timeout_in_minutes #=> Integer
resp.workspaces[0].workspace_properties.root_volume_size_gib #=> Integer
resp.workspaces[0].workspace_properties.user_volume_size_gib #=> Integer
resp.workspaces[0].workspace_properties.compute_type_name #=> String, one of "VALUE", "STANDARD", "PERFORMANCE", "POWER", "GRAPHICS"
resp.workspaces[0].modification_states #=> Array
resp.workspaces[0].modification_states[0].resource #=> String, one of "ROOT_VOLUME", "USER_VOLUME", "COMPUTE_TYPE"
resp.workspaces[0].modification_states[0].state #=> String, one of "UPDATE_INITIATED", "UPDATE_IN_PROGRESS"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :workspace_ids (Array<String>)

    The IDs of the WorkSpaces. This parameter cannot be combined with any other filter.

    Because the CreateWorkspaces operation is asynchronous, the identifier it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.

  • :directory_id (String)

    The ID of the directory. In addition, you can optionally specify a specific directory user (see UserName). This parameter cannot be combined with any other filter.

  • :user_name (String)

    The name of the directory user. You must specify this parameter with DirectoryId.

  • :bundle_id (String)

    The ID of the bundle. All WorkSpaces that are created from this bundle are retrieved. This parameter cannot be combined with any other filter.

  • :limit (Integer)

    The maximum number of items to return.

  • :next_token (String)

    The token for the next set of results. (You received this token from a previous call.)

Returns:

See Also:



526
527
528
529
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 526

def describe_workspaces(params = {}, options = {})
  req = build_request(:describe_workspaces, params)
  req.send_request(options)
end

#describe_workspaces_connection_status(params = {}) ⇒ Types::DescribeWorkspacesConnectionStatusResult

Describes the connection status of the specified WorkSpaces.

Examples:

Request syntax with placeholder values


resp = client.describe_workspaces_connection_status({
  workspace_ids: ["WorkspaceId"],
  next_token: "PaginationToken",
})

Response structure


resp.workspaces_connection_status #=> Array
resp.workspaces_connection_status[0].workspace_id #=> String
resp.workspaces_connection_status[0].connection_state #=> String, one of "CONNECTED", "DISCONNECTED", "UNKNOWN"
resp.workspaces_connection_status[0].connection_state_check_timestamp #=> Time
resp.workspaces_connection_status[0].last_known_user_connection_timestamp #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :workspace_ids (Array<String>)

    The identifiers of the WorkSpaces.

  • :next_token (String)

    The token for the next set of results. (You received this token from a previous call.)

Returns:

See Also:



565
566
567
568
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 565

def describe_workspaces_connection_status(params = {}, options = {})
  req = build_request(:describe_workspaces_connection_status, params)
  req.send_request(options)
end

#modify_workspace_properties(params = {}) ⇒ Struct

Modifies the specified WorkSpace properties.

Examples:

Request syntax with placeholder values


resp = client.modify_workspace_properties({
  workspace_id: "WorkspaceId", # required
  workspace_properties: { # required
    running_mode: "AUTO_STOP", # accepts AUTO_STOP, ALWAYS_ON
    running_mode_auto_stop_timeout_in_minutes: 1,
    root_volume_size_gib: 1,
    user_volume_size_gib: 1,
    compute_type_name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS
  },
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :workspace_id (required, String)

    The ID of the WorkSpace.

  • :workspace_properties (required, Types::WorkspaceProperties)

    The properties of the WorkSpace.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



597
598
599
600
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 597

def modify_workspace_properties(params = {}, options = {})
  req = build_request(:modify_workspace_properties, params)
  req.send_request(options)
end

#reboot_workspaces(params = {}) ⇒ Types::RebootWorkspacesResult

Reboots the specified WorkSpaces.

You cannot reboot a WorkSpace unless its state is AVAILABLE, IMPAIRED, or INOPERABLE.

This operation is asynchronous and returns before the WorkSpaces have rebooted.

Examples:

Request syntax with placeholder values


resp = client.reboot_workspaces({
  reboot_workspace_requests: [ # required
    {
      workspace_id: "WorkspaceId", # required
    },
  ],
})

Response structure


resp.failed_requests #=> Array
resp.failed_requests[0].workspace_id #=> String
resp.failed_requests[0].error_code #=> String
resp.failed_requests[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

See Also:



638
639
640
641
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 638

def reboot_workspaces(params = {}, options = {})
  req = build_request(:reboot_workspaces, params)
  req.send_request(options)
end

#rebuild_workspaces(params = {}) ⇒ Types::RebuildWorkspacesResult

Rebuilds the specified WorkSpaces.

You cannot rebuild a WorkSpace unless its state is AVAILABLE or ERROR.

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.

Examples:

Request syntax with placeholder values


resp = client.rebuild_workspaces({
  rebuild_workspace_requests: [ # required
    {
      workspace_id: "WorkspaceId", # required
    },
  ],
})

Response structure


resp.failed_requests #=> Array
resp.failed_requests[0].workspace_id #=> String
resp.failed_requests[0].error_code #=> String
resp.failed_requests[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

See Also:



687
688
689
690
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 687

def rebuild_workspaces(params = {}, options = {})
  req = build_request(:rebuild_workspaces, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.start_workspaces({
  start_workspace_requests: [ # required
    {
      workspace_id: "WorkspaceId",
    },
  ],
})

Response structure


resp.failed_requests #=> Array
resp.failed_requests[0].workspace_id #=> String
resp.failed_requests[0].error_code #=> String
resp.failed_requests[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :start_workspace_requests (required, Array<Types::StartRequest>)

    The WorkSpaces to start.

Returns:

See Also:



725
726
727
728
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 725

def start_workspaces(params = {}, options = {})
  req = build_request(:start_workspaces, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.stop_workspaces({
  stop_workspace_requests: [ # required
    {
      workspace_id: "WorkspaceId",
    },
  ],
})

Response structure


resp.failed_requests #=> Array
resp.failed_requests[0].workspace_id #=> String
resp.failed_requests[0].error_code #=> String
resp.failed_requests[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :stop_workspace_requests (required, Array<Types::StopRequest>)

    The WorkSpaces to stop.

Returns:

See Also:



763
764
765
766
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 763

def stop_workspaces(params = {}, options = {})
  req = build_request(:stop_workspaces, params)
  req.send_request(options)
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 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.

Examples:

Request syntax with placeholder values


resp = client.terminate_workspaces({
  terminate_workspace_requests: [ # required
    {
      workspace_id: "WorkspaceId", # required
    },
  ],
})

Response structure


resp.failed_requests #=> Array
resp.failed_requests[0].workspace_id #=> String
resp.failed_requests[0].error_code #=> String
resp.failed_requests[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

Returns:

See Also:



807
808
809
810
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 807

def terminate_workspaces(params = {}, options = {})
  req = build_request(:terminate_workspaces, params)
  req.send_request(options)
end