Class: Aws::WorkSpaces::Client

Inherits:
Seahorse::Client::Base show all
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

#config, #handlers

API Operations collapse

Instance Method Summary collapse

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.

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::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

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

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

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

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :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 searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :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.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :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_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :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.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :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 or custom endpoints. This should be a valid 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.

  • :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.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

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

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

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

    @see https://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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :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. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :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.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::WorkSpaces::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::WorkSpaces::EndpointParameters

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.



375
376
377
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 375

def initialize(*args)
  super
end

Instance Method Details

#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.

Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

Examples:

Request syntax with placeholder values


resp = client.associate_connection_alias({
  alias_id: "ConnectionAliasId", # required
  resource_id: "NonEmptyString", # required
})

Response structure


resp.connection_identifier #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :alias_id (required, String) —

    The identifier of the connection alias.

  • :resource_id (required, String) —

    The identifier of the directory to associate the connection alias with.

Returns:

See Also:



422
423
424
425
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 422

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

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



449
450
451
452
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 449

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:



483
484
485
486
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 483

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

Examples:

Request syntax with placeholder values


resp = client.copy_workspace_image({
  name: "WorkspaceImageName", # required
  description: "WorkspaceImageDescription",
  source_image_id: "WorkspaceImageId", # required
  source_region: "Region", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.image_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the image.

  • :description (String) —

    A description of the image.

  • :source_image_id (required, String) —

    The identifier of the source image.

  • :source_region (required, String) —

    The identifier of the source Region.

  • :tags (Array<Types::Tag>) —

    The tags for the image.

Returns:

See Also:



552
553
554
555
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 552

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

Examples:

Request syntax with placeholder values


resp = client.create_connect_client_add_in({
  resource_id: "DirectoryId", # required
  name: "AddInName", # required
  url: "AddInUrl", # required
})

Response structure


resp.add_in_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The directory identifier for which to configure the client add-in.

  • :name (required, String) —

    The name of the client add-in.

  • :url (required, String) —

    The endpoint URL of the Amazon Connect client add-in.

Returns:

See Also:



592
593
594
595
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 592

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

Examples:

Request syntax with placeholder values


resp = client.create_connection_alias({
  connection_string: "ConnectionString", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.alias_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_string (required, String) —

    A connection string in the form of a fully qualified domain name (FQDN), such as www.example.com.

    After you create a connection string, it is always associated to your Amazon Web Services account. You cannot recreate the same connection string with a different account, even if you delete all instances of it from the original account. The connection string is globally reserved for your account.

  • :tags (Array<Types::Tag>) —

    The tags to associate with the connection alias.

Returns:

See Also:



642
643
644
645
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 642

def create_connection_alias(params = {}, options = {})
  req = build_request(:create_connection_alias, params)
  req.send_request(options)
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",
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

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.

  • :tags (Array<Types::Tag>) —

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

Returns:

See Also:



706
707
708
709
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 706

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

#create_standby_workspaces(params = {}) ⇒ Types::CreateStandbyWorkspacesResult

Creates a standby WorkSpace in a secondary Region.

Examples:

Request syntax with placeholder values


resp = client.create_standby_workspaces({
  primary_region: "Region", # required
  standby_workspaces: [ # required
    {
      primary_workspace_id: "WorkspaceId", # required
      volume_encryption_key: "VolumeEncryptionKey",
      directory_id: "DirectoryId", # required
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue",
        },
      ],
    },
  ],
})

Response structure


resp.failed_standby_requests #=> Array
resp.failed_standby_requests[0].standby_workspace_request.primary_workspace_id #=> String
resp.failed_standby_requests[0].standby_workspace_request.volume_encryption_key #=> String
resp.failed_standby_requests[0].standby_workspace_request.directory_id #=> String
resp.failed_standby_requests[0].standby_workspace_request.tags #=> Array
resp.failed_standby_requests[0].standby_workspace_request.tags[0].key #=> String
resp.failed_standby_requests[0].standby_workspace_request.tags[0].value #=> String
resp.failed_standby_requests[0].error_code #=> String
resp.failed_standby_requests[0].error_message #=> String
resp.pending_standby_requests #=> Array
resp.pending_standby_requests[0].user_name #=> String
resp.pending_standby_requests[0].directory_id #=> String
resp.pending_standby_requests[0].state #=> String, one of "PENDING", "AVAILABLE", "IMPAIRED", "UNHEALTHY", "REBOOTING", "STARTING", "REBUILDING", "RESTORING", "MAINTENANCE", "ADMIN_MAINTENANCE", "TERMINATING", "TERMINATED", "SUSPENDED", "UPDATING", "STOPPING", "STOPPED", "ERROR"
resp.pending_standby_requests[0].workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :primary_region (required, String) —

    The Region of the primary WorkSpace.

  • :standby_workspaces (required, Array<Types::StandbyWorkspace>) —

    Information about the standby WorkSpace to be created.

Returns:

See Also:



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

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

#create_tags(params = {}) ⇒ Struct

Creates the specified tags for the specified WorkSpaces resource.

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 WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.

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

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



797
798
799
800
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 797

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

* Only Windows 10, Windows Server 2016, and Windows Server 2019 WorkSpace images can be programmatically updated at this time.

  • 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.

Examples:

Request syntax with placeholder values


resp = client.create_updated_workspace_image({
  name: "WorkspaceImageName", # required
  description: "WorkspaceImageDescription", # required
  source_image_id: "WorkspaceImageId", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.image_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the new updated WorkSpace image.

  • :description (required, String) —

    A description of whether updates for the WorkSpace image are available.

  • :source_image_id (required, String) —

    The identifier of the source WorkSpace image.

  • :tags (Array<Types::Tag>) —

    The tags that you want to add to the new updated WorkSpace image.

    To add tags at the same time when you're creating the updated image, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.

Returns:

See Also:



870
871
872
873
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 870

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

Examples:

Request syntax with placeholder values


resp = client.create_workspace_bundle({
  bundle_name: "WorkspaceBundleName", # required
  bundle_description: "WorkspaceBundleDescription", # required
  image_id: "WorkspaceImageId", # required
  compute_type: { # required
    name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO, GRAPHICS_G4DN, GRAPHICSPRO_G4DN
  },
  user_storage: { # required
    capacity: "NonEmptyString",
  },
  root_storage: {
    capacity: "NonEmptyString",
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.workspace_bundle.bundle_id #=> String
resp.workspace_bundle.name #=> String
resp.workspace_bundle.owner #=> String
resp.workspace_bundle.description #=> String
resp.workspace_bundle.image_id #=> String
resp.workspace_bundle.root_storage.capacity #=> String
resp.workspace_bundle.user_storage.capacity #=> String
resp.workspace_bundle.compute_type.name #=> String, one of "VALUE", "STANDARD", "PERFORMANCE", "POWER", "GRAPHICS", "POWERPRO", "GRAPHICSPRO", "GRAPHICS_G4DN", "GRAPHICSPRO_G4DN"
resp.workspace_bundle.last_updated_time #=> Time
resp.workspace_bundle.creation_time #=> Time
resp.workspace_bundle.state #=> String, one of "AVAILABLE", "PENDING", "ERROR"
resp.workspace_bundle.bundle_type #=> String, one of "REGULAR", "STANDBY"

Parameters:

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

    ({})

Options Hash (params):

  • :bundle_name (required, String) —

    The name of the bundle.

  • :bundle_description (required, String) —

    The description of the bundle.

  • :image_id (required, String) —

    The identifier of the image that is used to create the bundle.

  • :compute_type (required, Types::ComputeType) —

    Describes the compute type of the bundle.

  • :user_storage (required, Types::UserStorage) —

    Describes the user volume for a WorkSpace bundle.

  • :root_storage (Types::RootStorage) —

    Describes the root volume for a WorkSpace bundle.

  • :tags (Array<Types::Tag>) —

    The tags associated with the bundle.

    To add tags at the same time when you're creating the bundle, you must create an IAM policy that grants your IAM user permissions to use workspaces:CreateTags.

Returns:

See Also:



956
957
958
959
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 956

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

#create_workspace_image(params = {}) ⇒ Types::CreateWorkspaceImageResult

Creates a new WorkSpace image from an existing WorkSpace.

Examples:

Request syntax with placeholder values


resp = client.create_workspace_image({
  name: "WorkspaceImageName", # required
  description: "WorkspaceImageDescription", # required
  workspace_id: "WorkspaceId", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Response structure


resp.image_id #=> String
resp.name #=> String
resp.description #=> String
resp.operating_system.type #=> String, one of "WINDOWS", "LINUX"
resp.state #=> String, one of "AVAILABLE", "PENDING", "ERROR"
resp.required_tenancy #=> String, one of "DEFAULT", "DEDICATED"
resp.created #=> Time
resp. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the new WorkSpace image.

  • :description (required, String) —

    The description of the new WorkSpace image.

  • :workspace_id (required, String) —

    The identifier of the source WorkSpace

  • :tags (Array<Types::Tag>) —

    The tags that you want to add to the new WorkSpace image. To add tags when you're creating the image, you must create an IAM policy that grants your IAM user permission to use workspaces:CreateTags.

Returns:

See Also:



1017
1018
1019
1020
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1017

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

The 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.

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, MANUAL
        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, GRAPHICS_G4DN, GRAPHICSPRO_G4DN
        protocols: ["PCOIP"], # accepts PCOIP, WSP
      },
      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", "MANUAL"
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", "GRAPHICS_G4DN", "GRAPHICSPRO_G4DN"
resp.failed_requests[0].workspace_request.workspace_properties.protocols #=> Array
resp.failed_requests[0].workspace_request.workspace_properties.protocols[0] #=> String, one of "PCOIP", "WSP"
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", "RESTORING", "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", "MANUAL"
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", "GRAPHICS_G4DN", "GRAPHICSPRO_G4DN"
resp.pending_requests[0].workspace_properties.protocols #=> Array
resp.pending_requests[0].workspace_properties.protocols[0] #=> String, one of "PCOIP", "WSP"
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"
resp.pending_requests[0].related_workspaces #=> Array
resp.pending_requests[0].related_workspaces[0].workspace_id #=> String
resp.pending_requests[0].related_workspaces[0].region #=> String
resp.pending_requests[0].related_workspaces[0].state #=> String, one of "PENDING", "AVAILABLE", "IMPAIRED", "UNHEALTHY", "REBOOTING", "STARTING", "REBUILDING", "RESTORING", "MAINTENANCE", "ADMIN_MAINTENANCE", "TERMINATING", "TERMINATED", "SUSPENDED", "UPDATING", "STOPPING", "STOPPED", "ERROR"
resp.pending_requests[0].related_workspaces[0].type #=> String, one of "PRIMARY", "STANDBY"

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:



1129
1130
1131
1132
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1129

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

Examples:

Request syntax with placeholder values


resp = client.delete_client_branding({
  resource_id: "DirectoryId", # required
  platforms: ["DeviceTypeWindows"], # required, accepts DeviceTypeWindows, DeviceTypeOsx, DeviceTypeAndroid, DeviceTypeIos, DeviceTypeLinux, DeviceTypeWeb
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The directory identifier of the WorkSpace for which you want to delete client branding.

  • :platforms (required, Array<String>) —

    The device type for which you want to delete client branding.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1163
1164
1165
1166
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1163

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

#delete_connect_client_add_in(params = {}) ⇒ Struct

Deletes a client-add-in for Amazon Connect that is configured within a directory.

Examples:

Request syntax with placeholder values


resp = client.delete_connect_client_add_in({
  add_in_id: "AmazonUuid", # required
  resource_id: "DirectoryId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :add_in_id (required, String) —

    The identifier of the client add-in to delete.

  • :resource_id (required, String) —

    The directory identifier for which the client add-in is configured.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

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

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.

Examples:

Request syntax with placeholder values


resp = client.delete_connection_alias({
  alias_id: "ConnectionAliasId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :alias_id (required, String) —

    The identifier of the connection alias to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1233
1234
1235
1236
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1233

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



1258
1259
1260
1261
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1258

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 WorkSpaces resource.

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 WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.

  • :tag_keys (required, Array<String>) —

    The tag keys.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1286
1287
1288
1289
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1286

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

Examples:

Request syntax with placeholder values


resp = client.delete_workspace_bundle({
  bundle_id: "BundleId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :bundle_id (String) —

    The identifier of the bundle.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def delete_workspace_bundle(params = {}, options = {})
  req = build_request(:delete_workspace_bundle, 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 and unshare the image if it is shared with other accounts.

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:



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

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

Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.

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.

Examples:

Request syntax with placeholder values


resp = client.deregister_workspace_directory({
  directory_id: "DirectoryId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory. If any WorkSpaces are registered to this directory, you must remove them before you deregister the directory, or you will receive an OperationNotSupportedException error.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1385
1386
1387
1388
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1385

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



1407
1408
1409
1410
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1407

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:



1445
1446
1447
1448
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1445

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

Only device types that have branding information configured will be shown in the response.

Examples:

Request syntax with placeholder values


resp = client.describe_client_branding({
  resource_id: "DirectoryId", # required
})

Response structure


resp.device_type_windows.logo_url #=> String
resp.device_type_windows.support_email #=> String
resp.device_type_windows.support_link #=> String
resp.device_type_windows.forgot_password_link #=> String
resp.device_type_windows. #=> Hash
resp.device_type_windows.["ClientLocale"] #=> String
resp.device_type_osx.logo_url #=> String
resp.device_type_osx.support_email #=> String
resp.device_type_osx.support_link #=> String
resp.device_type_osx.forgot_password_link #=> String
resp.device_type_osx. #=> Hash
resp.device_type_osx.["ClientLocale"] #=> String
resp.device_type_android.logo_url #=> String
resp.device_type_android.support_email #=> String
resp.device_type_android.support_link #=> String
resp.device_type_android.forgot_password_link #=> String
resp.device_type_android. #=> Hash
resp.device_type_android.["ClientLocale"] #=> String
resp.device_type_ios.logo_url #=> String
resp.device_type_ios.logo_2x_url #=> String
resp.device_type_ios.logo_3x_url #=> String
resp.device_type_ios.support_email #=> String
resp.device_type_ios.support_link #=> String
resp.device_type_ios.forgot_password_link #=> String
resp.device_type_ios. #=> Hash
resp.device_type_ios.["ClientLocale"] #=> String
resp.device_type_linux.logo_url #=> String
resp.device_type_linux.support_email #=> String
resp.device_type_linux.support_link #=> String
resp.device_type_linux.forgot_password_link #=> String
resp.device_type_linux. #=> Hash
resp.device_type_linux.["ClientLocale"] #=> String
resp.device_type_web.logo_url #=> String
resp.device_type_web.support_email #=> String
resp.device_type_web.support_link #=> String
resp.device_type_web.forgot_password_link #=> String
resp.device_type_web. #=> Hash
resp.device_type_web.["ClientLocale"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The directory identifier of the WorkSpace for which you want to view client branding information.

Returns:

See Also:



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

def describe_client_branding(params = {}, options = {})
  req = build_request(:describe_client_branding, 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"
resp.client_properties_list[0].client_properties.log_upload_enabled #=> String, one of "ENABLED", "DISABLED"

Parameters:

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

    ({})

Options Hash (params):

  • :resource_ids (required, Array<String>) —

    The resource identifier, in the form of directory IDs.

Returns:

See Also:



1557
1558
1559
1560
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1557

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

#describe_connect_client_add_ins(params = {}) ⇒ Types::DescribeConnectClientAddInsResult

Retrieves a list of Amazon Connect client add-ins that have been created.

Examples:

Request syntax with placeholder values


resp = client.describe_connect_client_add_ins({
  resource_id: "DirectoryId", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.add_ins #=> Array
resp.add_ins[0].add_in_id #=> String
resp.add_ins[0].resource_id #=> String
resp.add_ins[0].name #=> String
resp.add_ins[0].url #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The directory identifier for which the client add-in is configured.

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



1601
1602
1603
1604
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1601

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

Examples:

Request syntax with placeholder values


resp = client.describe_connection_alias_permissions({
  alias_id: "ConnectionAliasId", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.alias_id #=> String
resp.connection_alias_permissions #=> Array
resp.connection_alias_permissions[0]. #=> String
resp.connection_alias_permissions[0].allow_association #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :alias_id (required, String) —

    The identifier of the connection alias.

  • :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 results to return.

Returns:

See Also:



1651
1652
1653
1654
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1651

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

Examples:

Request syntax with placeholder values


resp = client.describe_connection_aliases({
  alias_ids: ["ConnectionAliasId"],
  resource_id: "NonEmptyString",
  limit: 1,
  next_token: "PaginationToken",
})

Response structure


resp.connection_aliases #=> Array
resp.connection_aliases[0].connection_string #=> String
resp.connection_aliases[0].alias_id #=> String
resp.connection_aliases[0].state #=> String, one of "CREATING", "CREATED", "DELETING"
resp.connection_aliases[0]. #=> String
resp.connection_aliases[0].associations #=> Array
resp.connection_aliases[0].associations[0].association_status #=> String, one of "NOT_ASSOCIATED", "ASSOCIATED_WITH_OWNER_ACCOUNT", "ASSOCIATED_WITH_SHARED_ACCOUNT", "PENDING_ASSOCIATION", "PENDING_DISASSOCIATION"
resp.connection_aliases[0].associations[0]. #=> String
resp.connection_aliases[0].associations[0].resource_id #=> String
resp.connection_aliases[0].associations[0].connection_identifier #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :alias_ids (Array<String>) —

    The identifiers of the connection aliases to describe.

  • :resource_id (String) —

    The identifier of the directory associated with the connection alias.

  • :limit (Integer) —

    The maximum number of connection aliases 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:



1709
1710
1711
1712
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1709

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



1754
1755
1756
1757
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1754

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 WorkSpaces resource.

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 WorkSpaces resource. The supported resource types are WorkSpaces, registered directories, images, custom bundles, IP access control groups, and connection aliases.

Returns:

See Also:



1786
1787
1788
1789
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1786

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.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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].image_id #=> 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", "GRAPHICS_G4DN", "GRAPHICSPRO_G4DN"
resp.bundles[0].last_updated_time #=> Time
resp.bundles[0].creation_time #=> Time
resp.bundles[0].state #=> String, one of "AVAILABLE", "PENDING", "ERROR"
resp.bundles[0].bundle_type #=> String, one of "REGULAR", "STANDBY"
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.

    To describe the bundles provided by Amazon Web Services, specify AMAZON. To describe the bundles that belong to your account, don't specify a value.

  • :next_token (String) —

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

Returns:

See Also:



1848
1849
1850
1851
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1848

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 directories that are registered with Amazon WorkSpaces.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_workspace_directories({
  directory_ids: ["DirectoryId"],
  limit: 1,
  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].workspace_creation_properties.enable_maintenance_mode #=> Boolean
resp.directories[0].ip_group_ids #=> Array
resp.directories[0].ip_group_ids[0] #=> String
resp.directories[0].workspace_access_properties.device_type_windows #=> String, one of "ALLOW", "DENY"
resp.directories[0].workspace_access_properties.device_type_osx #=> String, one of "ALLOW", "DENY"
resp.directories[0].workspace_access_properties.device_type_web #=> String, one of "ALLOW", "DENY"
resp.directories[0].workspace_access_properties.device_type_ios #=> String, one of "ALLOW", "DENY"
resp.directories[0].workspace_access_properties.device_type_android #=> String, one of "ALLOW", "DENY"
resp.directories[0].workspace_access_properties.device_type_chrome_os #=> String, one of "ALLOW", "DENY"
resp.directories[0].workspace_access_properties.device_type_zero_client #=> String, one of "ALLOW", "DENY"
resp.directories[0].workspace_access_properties.device_type_linux #=> String, one of "ALLOW", "DENY"
resp.directories[0].tenancy #=> String, one of "DEDICATED", "SHARED"
resp.directories[0].selfservice_permissions.restart_workspace #=> String, one of "ENABLED", "DISABLED"
resp.directories[0].selfservice_permissions.increase_volume_size #=> String, one of "ENABLED", "DISABLED"
resp.directories[0].selfservice_permissions.change_compute_type #=> String, one of "ENABLED", "DISABLED"
resp.directories[0].selfservice_permissions.switch_running_mode #=> String, one of "ENABLED", "DISABLED"
resp.directories[0].selfservice_permissions.rebuild_workspace #=> String, one of "ENABLED", "DISABLED"
resp.directories[0].saml_properties.status #=> String, one of "DISABLED", "ENABLED", "ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK"
resp.directories[0].saml_properties.user_access_url #=> String
resp.directories[0].saml_properties.relay_state_parameter_name #=> String
resp.directories[0].certificate_based_auth_properties.status #=> String, one of "DISABLED", "ENABLED"
resp.directories[0].certificate_based_auth_properties.certificate_authority_arn #=> 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.

  • :limit (Integer) —

    The maximum number of directories 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:



1931
1932
1933
1934
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1931

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

Examples:

Request syntax with placeholder values


resp = client.describe_workspace_image_permissions({
  image_id: "WorkspaceImageId", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.image_id #=> String
resp.image_permissions #=> Array
resp.image_permissions[0]. #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :image_id (required, 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:



1974
1975
1976
1977
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 1974

def describe_workspace_image_permissions(params = {}, options = {})
  req = build_request(:describe_workspace_image_permissions, 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"],
  image_type: "OWNED", # accepts OWNED, SHARED
  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.images[0].created #=> Time
resp.images[0]. #=> String
resp.images[0].updates.update_available #=> Boolean
resp.images[0].updates.description #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :image_ids (Array<String>) —

    The identifier of the image.

  • :image_type (String) —

    The type (owned or shared) 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:



2031
2032
2033
2034
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2031

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

#describe_workspace_snapshots(params = {}) ⇒ Types::DescribeWorkspaceSnapshotsResult

Describes the snapshots for the specified WorkSpace.

Examples:

Request syntax with placeholder values


resp = client.describe_workspace_snapshots({
  workspace_id: "WorkspaceId", # required
})

Response structure


resp.rebuild_snapshots #=> Array
resp.rebuild_snapshots[0].snapshot_time #=> Time
resp.restore_snapshots #=> Array
resp.restore_snapshots[0].snapshot_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The identifier of the WorkSpace.

Returns:

See Also:



2063
2064
2065
2066
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2063

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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", "RESTORING", "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", "MANUAL"
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", "GRAPHICS_G4DN", "GRAPHICSPRO_G4DN"
resp.workspaces[0].workspace_properties.protocols #=> Array
resp.workspaces[0].workspace_properties.protocols[0] #=> String, one of "PCOIP", "WSP"
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.workspaces[0].related_workspaces #=> Array
resp.workspaces[0].related_workspaces[0].workspace_id #=> String
resp.workspaces[0].related_workspaces[0].region #=> String
resp.workspaces[0].related_workspaces[0].state #=> String, one of "PENDING", "AVAILABLE", "IMPAIRED", "UNHEALTHY", "REBOOTING", "STARTING", "REBUILDING", "RESTORING", "MAINTENANCE", "ADMIN_MAINTENANCE", "TERMINATING", "TERMINATED", "SUSPENDED", "UPDATING", "STOPPING", "STOPPED", "ERROR"
resp.workspaces[0].related_workspaces[0].type #=> String, one of "PRIMARY", "STANDBY"
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:



2157
2158
2159
2160
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2157

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:



2197
2198
2199
2200
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2197

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

Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is CREATED.

Examples:

Request syntax with placeholder values


resp = client.disassociate_connection_alias({
  alias_id: "ConnectionAliasId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :alias_id (required, String) —

    The identifier of the connection alias to disassociate.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2233
2234
2235
2236
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2233

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



2260
2261
2262
2263
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2260

def disassociate_ip_groups(params = {}, options = {})
  req = build_request(:disassociate_ip_groups, params)
  req.send_request(options)
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 must specify at least one platform type when importing client branding.

  • 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 and SupportLink 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.

Examples:

Request syntax with placeholder values


resp = client.import_client_branding({
  resource_id: "DirectoryId", # required
  device_type_windows: {
    logo: "data",
    support_email: "ClientEmail",
    support_link: "ClientUrl",
    forgot_password_link: "ClientUrl",
    login_message: {
      "ClientLocale" => "ClientLoginMessage",
    },
  },
  device_type_osx: {
    logo: "data",
    support_email: "ClientEmail",
    support_link: "ClientUrl",
    forgot_password_link: "ClientUrl",
    login_message: {
      "ClientLocale" => "ClientLoginMessage",
    },
  },
  device_type_android: {
    logo: "data",
    support_email: "ClientEmail",
    support_link: "ClientUrl",
    forgot_password_link: "ClientUrl",
    login_message: {
      "ClientLocale" => "ClientLoginMessage",
    },
  },
  device_type_ios: {
    logo: "data",
    logo_2x: "data",
    logo_3x: "data",
    support_email: "ClientEmail",
    support_link: "ClientUrl",
    forgot_password_link: "ClientUrl",
    login_message: {
      "ClientLocale" => "ClientLoginMessage",
    },
  },
  device_type_linux: {
    logo: "data",
    support_email: "ClientEmail",
    support_link: "ClientUrl",
    forgot_password_link: "ClientUrl",
    login_message: {
      "ClientLocale" => "ClientLoginMessage",
    },
  },
  device_type_web: {
    logo: "data",
    support_email: "ClientEmail",
    support_link: "ClientUrl",
    forgot_password_link: "ClientUrl",
    login_message: {
      "ClientLocale" => "ClientLoginMessage",
    },
  },
})

Response structure


resp.device_type_windows.logo_url #=> String
resp.device_type_windows.support_email #=> String
resp.device_type_windows.support_link #=> String
resp.device_type_windows.forgot_password_link #=> String
resp.device_type_windows. #=> Hash
resp.device_type_windows.["ClientLocale"] #=> String
resp.device_type_osx.logo_url #=> String
resp.device_type_osx.support_email #=> String
resp.device_type_osx.support_link #=> String
resp.device_type_osx.forgot_password_link #=> String
resp.device_type_osx. #=> Hash
resp.device_type_osx.["ClientLocale"] #=> String
resp.device_type_android.logo_url #=> String
resp.device_type_android.support_email #=> String
resp.device_type_android.support_link #=> String
resp.device_type_android.forgot_password_link #=> String
resp.device_type_android. #=> Hash
resp.device_type_android.["ClientLocale"] #=> String
resp.device_type_ios.logo_url #=> String
resp.device_type_ios.logo_2x_url #=> String
resp.device_type_ios.logo_3x_url #=> String
resp.device_type_ios.support_email #=> String
resp.device_type_ios.support_link #=> String
resp.device_type_ios.forgot_password_link #=> String
resp.device_type_ios. #=> Hash
resp.device_type_ios.["ClientLocale"] #=> String
resp.device_type_linux.logo_url #=> String
resp.device_type_linux.support_email #=> String
resp.device_type_linux.support_link #=> String
resp.device_type_linux.forgot_password_link #=> String
resp.device_type_linux. #=> Hash
resp.device_type_linux.["ClientLocale"] #=> String
resp.device_type_web.logo_url #=> String
resp.device_type_web.support_email #=> String
resp.device_type_web.support_link #=> String
resp.device_type_web.forgot_password_link #=> String
resp.device_type_web. #=> Hash
resp.device_type_web.["ClientLocale"] #=> String

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



2427
2428
2429
2430
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2427

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

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

Imports the specified Windows 10 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.

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, BYOL_GRAPHICS_G4DN, BYOL_REGULAR_WSP, BYOL_REGULAR_BYOP, BYOL_GRAPHICS_G4DN_BYOP
  image_name: "WorkspaceImageName", # required
  image_description: "WorkspaceImageDescription", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  applications: ["Microsoft_Office_2016"], # accepts Microsoft_Office_2016, Microsoft_Office_2019
})

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, depending on which protocol you want to use for your BYOL Workspace image, either PCoIP, WorkSpaces Streaming Protocol (WSP), or bring your own protocol (BYOP). To use WSP, specify a value that ends in _WSP. To use PCoIP, specify a value that does not end in _WSP. To use BYOP, specify a value that ends in _BYOP.

    For non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro), specify BYOL_REGULAR, BYOL_REGULAR_WSP, or BYOL_REGULAR_BYOP, depending on the protocol.

    The BYOL_REGULAR_BYOP and BYOL_GRAPHICS_G4DN_BYOP values are only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use these values. For more information, see Amazon WorkSpaces Core.

  • :image_name (required, String) —

    The name of the WorkSpace image.

  • :image_description (required, String) —

    The description of the WorkSpace image.

  • :tags (Array<Types::Tag>) —

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

  • :applications (Array<String>) —

    If specified, the version of Microsoft Office to subscribe to. Valid only for Windows 10 BYOL images. For more information about subscribing to Office for BYOL images, see Bring Your Own Windows Desktop Licenses.

    Although this parameter is an array, only one item is allowed at this time.

Returns:

See Also:



2520
2521
2522
2523
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2520

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

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.

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:



2573
2574
2575
2576
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2573

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

Examples:

Request syntax with placeholder values


resp = client.migrate_workspace({
  source_workspace_id: "WorkspaceId", # required
  bundle_id: "BundleId", # required
})

Response structure


resp.source_workspace_id #=> String
resp.target_workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :source_workspace_id (required, String) —

    The identifier of the WorkSpace to migrate from.

  • :bundle_id (required, String) —

    The identifier of the target bundle type to migrate the WorkSpace to.

Returns:

See Also:



2623
2624
2625
2626
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2623

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



2655
2656
2657
2658
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2655

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

#modify_certificate_based_auth_properties(params = {}) ⇒ Struct

Modifies the properties of the certificate-based authentication you want to use with your WorkSpaces.

Examples:

Request syntax with placeholder values


resp = client.modify_certificate_based_auth_properties({
  resource_id: "DirectoryId", # required
  certificate_based_auth_properties: {
    status: "DISABLED", # accepts DISABLED, ENABLED
    certificate_authority_arn: "CertificateAuthorityArn",
  },
  properties_to_delete: ["CERTIFICATE_BASED_AUTH_PROPERTIES_CERTIFICATE_AUTHORITY_ARN"], # accepts CERTIFICATE_BASED_AUTH_PROPERTIES_CERTIFICATE_AUTHORITY_ARN
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The resource identifiers, in the form of directory IDs.

  • :certificate_based_auth_properties (Types::CertificateBasedAuthProperties) —

    The properties of the certificate-based authentication.

  • :properties_to_delete (Array<String>) —

    The properties of the certificate-based authentication you want to delete.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2690
2691
2692
2693
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2690

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

#modify_client_properties(params = {}) ⇒ Struct

Modifies the properties of the specified Amazon WorkSpaces clients.

Examples:

Request syntax with placeholder values


resp = client.modify_client_properties({
  resource_id: "NonEmptyString", # required
  client_properties: { # required
    reconnect_enabled: "ENABLED", # accepts ENABLED, DISABLED
    log_upload_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 (required, Types::ClientProperties) —

    Information about the Amazon WorkSpaces client.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2719
2720
2721
2722
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2719

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

Examples:

Request syntax with placeholder values


resp = client.modify_saml_properties({
  resource_id: "DirectoryId", # required
  saml_properties: {
    status: "DISABLED", # accepts DISABLED, ENABLED, ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK
    user_access_url: "SamlUserAccessUrl",
    relay_state_parameter_name: "NonEmptyString",
  },
  properties_to_delete: ["SAML_PROPERTIES_USER_ACCESS_URL"], # accepts SAML_PROPERTIES_USER_ACCESS_URL, SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The directory identifier for which you want to configure SAML properties.

  • :saml_properties (Types::SamlProperties) —

    The properties for configuring SAML 2.0 authentication.

  • :properties_to_delete (Array<String>) —

    The SAML properties to delete as part of your request.

    Specify one of the following options:

    • SAML_PROPERTIES_USER_ACCESS_URL to delete the user access URL.

    • SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME to delete the relay state parameter name.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2764
2765
2766
2767
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2764

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

Examples:

Request syntax with placeholder values


resp = client.modify_selfservice_permissions({
  resource_id: "DirectoryId", # required
  selfservice_permissions: { # required
    restart_workspace: "ENABLED", # accepts ENABLED, DISABLED
    increase_volume_size: "ENABLED", # accepts ENABLED, DISABLED
    change_compute_type: "ENABLED", # accepts ENABLED, DISABLED
    switch_running_mode: "ENABLED", # accepts ENABLED, DISABLED
    rebuild_workspace: "ENABLED", # accepts ENABLED, DISABLED
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The identifier of the directory.

  • :selfservice_permissions (required, Types::SelfservicePermissions) —

    The permissions to enable or disable self-service capabilities.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2802
2803
2804
2805
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2802

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

Examples:

Request syntax with placeholder values


resp = client.modify_workspace_access_properties({
  resource_id: "DirectoryId", # required
  workspace_access_properties: { # required
    device_type_windows: "ALLOW", # accepts ALLOW, DENY
    device_type_osx: "ALLOW", # accepts ALLOW, DENY
    device_type_web: "ALLOW", # accepts ALLOW, DENY
    device_type_ios: "ALLOW", # accepts ALLOW, DENY
    device_type_android: "ALLOW", # accepts ALLOW, DENY
    device_type_chrome_os: "ALLOW", # accepts ALLOW, DENY
    device_type_zero_client: "ALLOW", # accepts ALLOW, DENY
    device_type_linux: "ALLOW", # accepts ALLOW, DENY
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The identifier of the directory.

  • :workspace_access_properties (required, Types::WorkspaceAccessProperties) —

    The device types and operating systems to enable or disable for access.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2844
2845
2846
2847
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2844

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

#modify_workspace_creation_properties(params = {}) ⇒ Struct

Modify the default properties used to create WorkSpaces.

Examples:

Request syntax with placeholder values


resp = client.modify_workspace_creation_properties({
  resource_id: "DirectoryId", # required
  workspace_creation_properties: { # required
    enable_work_docs: false,
    enable_internet_access: false,
    default_ou: "DefaultOu",
    custom_security_group_id: "SecurityGroupId",
    user_enabled_as_local_administrator: false,
    enable_maintenance_mode: false,
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The identifier of the directory.

  • :workspace_creation_properties (required, Types::WorkspaceCreationProperties) —

    The default properties for creating WorkSpaces.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2877
2878
2879
2880
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2877

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

The 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.

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, MANUAL
    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, GRAPHICS_G4DN, GRAPHICSPRO_G4DN
    protocols: ["PCOIP"], # accepts PCOIP, WSP
  },
})

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:



2923
2924
2925
2926
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2923

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, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot 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:



2955
2956
2957
2958
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2955

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:



2996
2997
2998
2999
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 2996

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, 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.

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:



3045
3046
3047
3048
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3045

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

#register_workspace_directory(params = {}) ⇒ Struct

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.

Examples:

Request syntax with placeholder values


resp = client.register_workspace_directory({
  directory_id: "DirectoryId", # required
  subnet_ids: ["SubnetId"],
  enable_work_docs: false, # required
  enable_self_service: false,
  tenancy: "DEDICATED", # accepts DEDICATED, SHARED
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :directory_id (required, String) —

    The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.

  • :subnet_ids (Array<String>) —

    The identifiers of the subnets for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.

  • :enable_work_docs (required, Boolean) —

    Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.

  • :enable_self_service (Boolean) —

    Indicates whether self-service capabilities are enabled or disabled.

  • :tenancy (String) —

    Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.

  • :tags (Array<Types::Tag>) —

    The tags associated with the directory.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3123
3124
3125
3126
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3123

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

Examples:

Request syntax with placeholder values


resp = client.restore_workspace({
  workspace_id: "WorkspaceId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The identifier of the WorkSpace.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3159
3160
3161
3162
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3159

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



3185
3186
3187
3188
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3185

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:



3223
3224
3225
3226
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3223

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:



3261
3262
3263
3264
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3261

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 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.

Simple AD and AD Connector are made available to you free of charge to use with WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector directory for 30 consecutive days, this directory will be automatically deregistered for use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing terms.

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.

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:



3330
3331
3332
3333
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3330

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

Examples:

Request syntax with placeholder values


resp = client.update_connect_client_add_in({
  add_in_id: "AmazonUuid", # required
  resource_id: "DirectoryId", # required
  name: "AddInName",
  url: "AddInUrl",
})

Parameters:

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

    ({})

Options Hash (params):

  • :add_in_id (required, String) —

    The identifier of the client add-in to update.

  • :resource_id (required, String) —

    The directory identifier for which the client add-in is configured.

  • :name (String) —

    The name of the client add-in.

  • :url (String) —

    The endpoint URL of the Amazon Connect client add-in.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3365
3366
3367
3368
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3365

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

* Before performing this operation, call DescribeConnectionAliases to make sure that the current state of the connection alias is 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.

Examples:

Request syntax with placeholder values


resp = client.update_connection_alias_permission({
  alias_id: "ConnectionAliasId", # required
  connection_alias_permission: { # required
    shared_account_id: "AwsAccount", # required
    allow_association: false, # required
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :alias_id (required, String) —

    The identifier of the connection alias that you want to update permissions for.

  • :connection_alias_permission (required, Types::ConnectionAliasPermission) —

    Indicates whether to share or unshare the connection alias with the specified Amazon Web Services account.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3420
3421
3422
3423
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3420

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



3452
3453
3454
3455
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3452

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

Examples:

Request syntax with placeholder values


resp = client.update_workspace_bundle({
  bundle_id: "BundleId",
  image_id: "WorkspaceImageId",
})

Parameters:

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

    ({})

Options Hash (params):

  • :bundle_id (String) —

    The identifier of the bundle.

  • :image_id (String) —

    The identifier of the image.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3489
3490
3491
3492
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3489

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

* To delete an image that has been shared, you must unshare the image before you delete it.

  • 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.

Examples:

Request syntax with placeholder values


resp = client.update_workspace_image_permission({
  image_id: "WorkspaceImageId", # required
  allow_copy_image: false, # required
  shared_account_id: "AwsAccount", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :image_id (required, String) —

    The identifier of the image.

  • :allow_copy_image (required, Boolean) —

    The permission to copy the image. This permission can be revoked only after an image has been shared.

  • :shared_account_id (required, String) —

    The identifier of the Amazon Web Services account to share or unshare the image with.

    Before sharing the image, confirm that you are sharing to the correct Amazon Web Services account ID.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3555
3556
3557
3558
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/client.rb', line 3555

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