Class: Aws::WorkSpaces::Client

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider)

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::SharedCredentials` - Used for loading credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` to enable retries and extended timeouts.

  • :region (required, String)

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is search for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :client_side_monitoring (Boolean) — default: false

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: ""

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_port (Integer) — default: 31000

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :disable_host_prefix_injection (Boolean) — default: false

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String)

    The client endpoint is normally constructed from the ‘:region` option. You should only configure an `:endpoint` when connecting to test endpoints. This should be avalid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false

    When set to ‘true`, endpoint discovery will be enabled for operations when available. Defaults to `false`.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default

    The log formatter.

  • :log_level (Symbol) — default: :info

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger)

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :profile (String) — default: "default"

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

  • :retry_jitter (Symbol) — default: :none

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials.

  • :retry_max_delay (Integer) — default: 0

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When ‘:simple_json` is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :validate_params (Boolean) — default: true

    When ‘true`, request parameters are validated before sending the request.



212
213
214
# File 'lib/aws-sdk-workspaces/client.rb', line 212

def initialize(*args)
  super
end

Class Attribute Details

.identifierObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



1522
1523
1524
# File 'lib/aws-sdk-workspaces/client.rb', line 1522

def identifier
  @identifier
end

Class Method Details

.errors_moduleObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



1525
1526
1527
# File 'lib/aws-sdk-workspaces/client.rb', line 1525

def errors_module
  Errors
end

Instance Method Details

#associate_ip_groups(params = {}) ⇒ Struct

Associates the specified IP access control group with the specified directory.

Examples:

Request syntax with placeholder values


resp = client.associate_ip_groups({
  directory_id: "DirectoryId", # required
  group_ids: ["IpGroupId"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :directory_id (required, String)

    The identifier of the directory.

  • :group_ids (required, Array<String>)

    The identifiers of one or more IP access control groups.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



240
241
242
243
# File 'lib/aws-sdk-workspaces/client.rb', line 240

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

Examples:

Request syntax with placeholder values


resp = client.authorize_ip_rules({
  group_id: "IpGroupId", # required
  user_rules: [ # required
    {
      ip_rule: "IpRule",
      rule_desc: "IpRuleDesc",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :group_id (required, String)

    The identifier of the group.

  • :user_rules (required, Array<Types::IpRuleItem>)

    The rules to add to the group.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



274
275
276
277
# File 'lib/aws-sdk-workspaces/client.rb', line 274

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

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
# File 'lib/aws-sdk-workspaces/client.rb', line 1500

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-workspaces'
  context[:gem_version] = '1.11.0'
  Seahorse::Client::Request.new(handlers, context)
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.

Examples:

Request syntax with placeholder values


resp = client.create_ip_group({
  group_name: "IpGroupName", # required
  group_desc: "IpGroupDesc",
  user_rules: [
    {
      ip_rule: "IpRule",
      rule_desc: "IpRuleDesc",
    },
  ],
})

Response structure


resp.group_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :group_name (required, String)

    The name of the group.

  • :group_desc (String)

    The description of the group.

  • :user_rules (Array<Types::IpRuleItem>)

    The rules to add to the group.

Returns:

See Also:



329
330
331
332
# File 'lib/aws-sdk-workspaces/client.rb', line 329

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

#create_tags(params = {}) ⇒ Struct

Creates the specified 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 identifier of the WorkSpace. To find this ID, use DescribeWorkspaces.

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

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



361
362
363
364
# File 'lib/aws-sdk-workspaces/client.rb', line 361

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, POWERPRO, GRAPHICSPRO
      },
      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", "POWERPRO", "GRAPHICSPRO"
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", "ADMIN_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", "POWERPRO", "GRAPHICSPRO"
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):

  • :workspaces (required, Array<Types::WorkspaceRequest>)

    The WorkSpaces to create. You can specify up to 25 WorkSpaces.

Returns:

See Also:



453
454
455
456
# File 'lib/aws-sdk-workspaces/client.rb', line 453

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

Examples:

Request syntax with placeholder values


resp = client.delete_ip_group({
  group_id: "IpGroupId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :group_id (required, String)

    The identifier of the IP access control group.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



478
479
480
481
# File 'lib/aws-sdk-workspaces/client.rb', line 478

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

#delete_tags(params = {}) ⇒ Struct

Deletes the specified tags from the specified 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 identifier of the WorkSpace. To find this ID, use DescribeWorkspaces.

  • :tag_keys (required, Array<String>)

    The tag keys.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



505
506
507
508
# File 'lib/aws-sdk-workspaces/client.rb', line 505

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

Examples:

Request syntax with placeholder values


resp = client.delete_workspace_image({
  image_id: "WorkspaceImageId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :image_id (required, String)

    The identifier of the image.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



528
529
530
531
# File 'lib/aws-sdk-workspaces/client.rb', line 528

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

#describe_account(params = {}) ⇒ Types::DescribeAccountResult

Retrieves a list that describes the configuration of bring your own license (BYOL) for the specified account.

Examples:

Response structure


resp.dedicated_tenancy_support #=> String, one of "ENABLED", "DISABLED"
resp.dedicated_tenancy_management_cidr_range #=> String

Parameters:

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

    ({})

Returns:

See Also:



550
551
552
553
# File 'lib/aws-sdk-workspaces/client.rb', line 550

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

Examples:

Request syntax with placeholder values


resp = client.({
  next_token: "PaginationToken",
})

Response structure


resp. #=> Array
resp.[0].modification_state #=> String, one of "PENDING", "COMPLETED", "FAILED"
resp.[0].dedicated_tenancy_support #=> String, one of "ENABLED", "DISABLED"
resp.[0].dedicated_tenancy_management_cidr_range #=> String
resp.[0].start_time #=> Time
resp.[0].error_code #=> String
resp.[0].error_message #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String)

    If you received a ‘NextToken` from a previous call that was paginated, provide this token to receive the next set of results.

Returns:

See Also:



588
589
590
591
# File 'lib/aws-sdk-workspaces/client.rb', line 588

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

#describe_client_properties(params = {}) ⇒ Types::DescribeClientPropertiesResult

Retrieves a list that describes one or more specified Amazon WorkSpaces clients.

Examples:

Request syntax with placeholder values


resp = client.describe_client_properties({
  resource_ids: ["NonEmptyString"], # required
})

Response structure


resp.client_properties_list #=> Array
resp.client_properties_list[0].resource_id #=> String
resp.client_properties_list[0].client_properties.reconnect_enabled #=> String, one of "ENABLED", "DISABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :resource_ids (required, Array<String>)

    The resource identifiers, in the form of directory IDs.

Returns:

See Also:



619
620
621
622
# File 'lib/aws-sdk-workspaces/client.rb', line 619

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

#describe_ip_groups(params = {}) ⇒ Types::DescribeIpGroupsResult

Describes one or more of your IP access control groups.

Examples:

Request syntax with placeholder values


resp = client.describe_ip_groups({
  group_ids: ["IpGroupId"],
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.result #=> Array
resp.result[0].group_id #=> String
resp.result[0].group_name #=> String
resp.result[0].group_desc #=> String
resp.result[0].user_rules #=> Array
resp.result[0].user_rules[0].ip_rule #=> String
resp.result[0].user_rules[0].rule_desc #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :group_ids (Array<String>)

    The identifiers of one or more IP access control groups.

  • :next_token (String)

    If you received a ‘NextToken` from a previous call that was paginated, provide this token to receive the next set of results.

  • :max_results (Integer)

    The maximum number of items to return.

Returns:

See Also:



664
665
666
667
# File 'lib/aws-sdk-workspaces/client.rb', line 664

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

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

Describes the specified 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 identifier of the WorkSpace. To find this ID, use DescribeWorkspaces.

Returns:

See Also:



695
696
697
698
# File 'lib/aws-sdk-workspaces/client.rb', line 695

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

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", "POWERPRO", "GRAPHICSPRO"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :bundle_ids (Array<String>)

    The identifiers of the bundles. You cannot combine this parameter with any other filter.

  • :owner (String)

    The owner of the bundles. You cannot combine this parameter 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:



749
750
751
752
# File 'lib/aws-sdk-workspaces/client.rb', line 749

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.directories[0].ip_group_ids #=> Array
resp.directories[0].ip_group_ids[0] #=> String
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)

    If you received a ‘NextToken` from a previous call that was paginated, provide this token to receive the next set of results.

Returns:

See Also:



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

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

Examples:

Request syntax with placeholder values


resp = client.describe_workspace_images({
  image_ids: ["WorkspaceImageId"],
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.images #=> Array
resp.images[0].image_id #=> String
resp.images[0].name #=> String
resp.images[0].description #=> String
resp.images[0].operating_system.type #=> String, one of "WINDOWS", "LINUX"
resp.images[0].state #=> String, one of "AVAILABLE", "PENDING", "ERROR"
resp.images[0].required_tenancy #=> String, one of "DEFAULT", "DEDICATED"
resp.images[0].error_code #=> String
resp.images[0].error_message #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :image_ids (Array<String>)

    The identifier of the image.

  • :next_token (String)

    If you received a ‘NextToken` from a previous call that was paginated, provide this token to receive the next set of results.

  • :max_results (Integer)

    The maximum number of items to return.

Returns:

See Also:



855
856
857
858
# File 'lib/aws-sdk-workspaces/client.rb', line 855

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

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", "ADMIN_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", "POWERPRO", "GRAPHICSPRO"
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 identifiers of the WorkSpaces. You cannot combine this parameter 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 identifier of the directory. In addition, you can optionally specify a specific directory user (see ‘UserName`). You cannot combine this parameter with any other filter.

  • :user_name (String)

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

  • :bundle_id (String)

    The identifier of the bundle. All WorkSpaces that are created from this bundle are retrieved. You cannot combine this parameter with any other filter.

  • :limit (Integer)

    The maximum number of items to return.

  • :next_token (String)

    If you received a ‘NextToken` from a previous call that was paginated, provide this token to receive the next set of results.

Returns:

See Also:



940
941
942
943
# File 'lib/aws-sdk-workspaces/client.rb', line 940

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. You can specify up to 25 WorkSpaces.

  • :next_token (String)

    If you received a ‘NextToken` from a previous call that was paginated, provide this token to receive the next set of results.

Returns:

See Also:



980
981
982
983
# File 'lib/aws-sdk-workspaces/client.rb', line 980

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

#disassociate_ip_groups(params = {}) ⇒ Struct

Disassociates the specified IP access control group from the specified directory.

Examples:

Request syntax with placeholder values


resp = client.disassociate_ip_groups({
  directory_id: "DirectoryId", # required
  group_ids: ["IpGroupId"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :directory_id (required, String)

    The identifier of the directory.

  • :group_ids (required, Array<String>)

    The identifiers of one or more IP access control groups.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1007
1008
1009
1010
# File 'lib/aws-sdk-workspaces/client.rb', line 1007

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

#import_workspace_image(params = {}) ⇒ Types::ImportWorkspaceImageResult

Imports the specified Windows 7 or Windows 10 bring your own license (BYOL) image into Amazon WorkSpaces. The image must be an already licensed EC2 image that is in your AWS account, and you must own the image.

Examples:

Request syntax with placeholder values


resp = client.import_workspace_image({
  ec2_image_id: "Ec2ImageId", # required
  ingestion_process: "BYOL_REGULAR", # required, accepts BYOL_REGULAR, BYOL_GRAPHICS, BYOL_GRAPHICSPRO
  image_name: "WorkspaceImageName", # required
  image_description: "WorkspaceImageDescription", # required
})

Response structure


resp.image_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :ec2_image_id (required, String)

    The identifier of the EC2 image.

  • :ingestion_process (required, String)

    The ingestion process to be used when importing the image.

  • :image_name (required, String)

    The name of the WorkSpace image.

  • :image_description (required, String)

    The description of the WorkSpace image.

Returns:

See Also:



1050
1051
1052
1053
# File 'lib/aws-sdk-workspaces/client.rb', line 1050

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

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.

Examples:

Request syntax with placeholder values


resp = client.list_available_management_cidr_ranges({
  management_cidr_range_constraint: "ManagementCidrRangeConstraint", # required
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.management_cidr_ranges #=> Array
resp.management_cidr_ranges[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :management_cidr_range_constraint (required, String)

    The IP address range to search. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block).

  • :max_results (Integer)

    The maximum number of items to return.

  • :next_token (String)

    If you received a ‘NextToken` from a previous call that was paginated, provide this token to receive the next set of results.

Returns:

See Also:



1099
1100
1101
1102
# File 'lib/aws-sdk-workspaces/client.rb', line 1099

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

#modify_account(params = {}) ⇒ Struct

Modifies the configuration of bring your own license (BYOL) for the specified account.

Examples:

Request syntax with placeholder values


resp = client.({
  dedicated_tenancy_support: "ENABLED", # accepts ENABLED
  dedicated_tenancy_management_cidr_range: "DedicatedTenancyManagementCidrRange",
})

Parameters:

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

    ({})

Options Hash (params):

  • :dedicated_tenancy_support (String)

    The status of BYOL.

  • :dedicated_tenancy_management_cidr_range (String)

    The IP address range, specified as an IPv4 CIDR block, for the management network interface. Specify an IP address range that is compatible with your network and in CIDR notation (that is, specify the range as an IPv4 CIDR block). The CIDR block size must be /16 (for example, 203.0.113.25/16). It must also be specified as available by the ‘ListAvailableManagementCidrRanges` operation.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1131
1132
1133
1134
# File 'lib/aws-sdk-workspaces/client.rb', line 1131

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

#modify_client_properties(params = {}) ⇒ Struct

Modifies the properties of the specified Amazon WorkSpaces client.

Examples:

Request syntax with placeholder values


resp = client.modify_client_properties({
  resource_id: "NonEmptyString", # required
  client_properties: {
    reconnect_enabled: "ENABLED", # accepts ENABLED, DISABLED
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String)

    The resource identifiers, in the form of directory IDs.

  • :client_properties (Types::ClientProperties)

    Information about the Amazon WorkSpaces client.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1159
1160
1161
1162
# File 'lib/aws-sdk-workspaces/client.rb', line 1159

def modify_client_properties(params = {}, options = {})
  req = build_request(:modify_client_properties, 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, POWERPRO, GRAPHICSPRO
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String)

    The identifier of the WorkSpace.

  • :workspace_properties (required, Types::WorkspaceProperties)

    The properties of the WorkSpace.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1191
1192
1193
1194
# File 'lib/aws-sdk-workspaces/client.rb', line 1191

def modify_workspace_properties(params = {}, options = {})
  req = build_request(:modify_workspace_properties, params)
  req.send_request(options)
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, or rebuild. An AutoStop WorkSpace in this state is not stopped. Users can log into a WorkSpace in the `ADMIN_MAINTENANCE` state.

Examples:

Request syntax with placeholder values


resp = client.modify_workspace_state({
  workspace_id: "WorkspaceId", # required
  workspace_state: "AVAILABLE", # required, accepts AVAILABLE, ADMIN_MAINTENANCE
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String)

    The identifier of the WorkSpace.

  • :workspace_state (required, String)

    The WorkSpace state.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1223
1224
1225
1226
# File 'lib/aws-sdk-workspaces/client.rb', line 1223

def modify_workspace_state(params = {}, options = {})
  req = build_request(:modify_workspace_state, 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` or `UNHEALTHY`.

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):

  • :reboot_workspace_requests (required, Array<Types::RebootRequest>)

    The WorkSpaces to reboot. You can specify up to 25 WorkSpaces.

Returns:

See Also:



1264
1265
1266
1267
# File 'lib/aws-sdk-workspaces/client.rb', line 1264

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

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

Rebuilds the specified WorkSpace.

You cannot rebuild a WorkSpace unless its state is ‘AVAILABLE`, `ERROR`, or `UNHEALTHY`.

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.

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html

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):

  • :rebuild_workspace_requests (required, Array<Types::RebuildRequest>)

    The WorkSpace to rebuild. You can specify a single WorkSpace.

Returns:

See Also:



1313
1314
1315
1316
# File 'lib/aws-sdk-workspaces/client.rb', line 1313

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

#revoke_ip_rules(params = {}) ⇒ Struct

Removes one or more rules from the specified IP access control group.

Examples:

Request syntax with placeholder values


resp = client.revoke_ip_rules({
  group_id: "IpGroupId", # required
  user_rules: ["IpRule"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :group_id (required, String)

    The identifier of the group.

  • :user_rules (required, Array<String>)

    The rules to remove from the group.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1339
1340
1341
1342
# File 'lib/aws-sdk-workspaces/client.rb', line 1339

def revoke_ip_rules(params = {}, options = {})
  req = build_request(:revoke_ip_rules, 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. You can specify up to 25 WorkSpaces.

Returns:

See Also:



1377
1378
1379
1380
# File 'lib/aws-sdk-workspaces/client.rb', line 1377

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. You can specify up to 25 WorkSpaces.

Returns:

See Also:



1415
1416
1417
1418
# File 'lib/aws-sdk-workspaces/client.rb', line 1415

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):

  • :terminate_workspace_requests (required, Array<Types::TerminateRequest>)

    The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.

Returns:

See Also:



1459
1460
1461
1462
# File 'lib/aws-sdk-workspaces/client.rb', line 1459

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

#update_rules_of_ip_group(params = {}) ⇒ Struct

Replaces the current rules of the specified IP access control group with the specified rules.

Examples:

Request syntax with placeholder values


resp = client.update_rules_of_ip_group({
  group_id: "IpGroupId", # required
  user_rules: [ # required
    {
      ip_rule: "IpRule",
      rule_desc: "IpRuleDesc",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :group_id (required, String)

    The identifier of the group.

  • :user_rules (required, Array<Types::IpRuleItem>)

    One or more rules.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



1491
1492
1493
1494
# File 'lib/aws-sdk-workspaces/client.rb', line 1491

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

#waiter_namesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated.


1515
1516
1517
# File 'lib/aws-sdk-workspaces/client.rb', line 1515

def waiter_names
  []
end