Class: Aws::WorkSpaces::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

See #initialize for a full list of supported configuration options.

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

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

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

    • ENV, ENV, ENV, and ENV

    • ‘~/.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::InstanceProfileCredentials` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV 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:

  • :access_key_id (String)
  • :account_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.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

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

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.

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

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

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

  • :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_open_timeout (Float) — default: 15 —

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

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

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :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_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



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

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

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



4823
4824
4825
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4823

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

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



4826
4827
4828
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4826

def errors_module
  Errors
end

Instance Method Details

Accepts the account link invitation.

There’s currently no unlinking capability after you accept the account linking invitation.

Examples:

Request syntax with placeholder values


resp = client.({
  link_id: "LinkId", # required
  client_token: "ClientToken",
})

Response structure


resp.. #=> String
resp.. #=> String, one of "LINKED", "LINKING_FAILED", "LINK_NOT_FOUND", "PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT", "REJECTED"
resp.. #=> String
resp.. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :link_id (required, String) —

    The identifier of the account link.

  • :client_token (String) —

    A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

Returns:

See Also:



491
492
493
494
 
# File 'lib/aws-sdk-workspaces/client.rb', line 491

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

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

<note markdown=“1”> Before performing this operation, call [ DescribeConnectionAliases] to make sure that the current state of the connection alias is ‘CREATED`.

</note>

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html [2]: docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html

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:



537
538
539
540
 
# File 'lib/aws-sdk-workspaces/client.rb', line 537

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:



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

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

#associate_workspace_application(params = {}) ⇒ Types::AssociateWorkspaceApplicationResult

Associates the specified application to the specified WorkSpace.

Examples:

Request syntax with placeholder values


resp = client.associate_workspace_application({
  workspace_id: "WorkspaceId", # required
  application_id: "WorkSpaceApplicationId", # required
})

Response structure


resp.association.associated_resource_id #=> String
resp.association.associated_resource_type #=> String, one of "APPLICATION"
resp.association.created #=> Time
resp.association.last_updated_time #=> Time
resp.association.state #=> String, one of "PENDING_INSTALL", "PENDING_INSTALL_DEPLOYMENT", "PENDING_UNINSTALL", "PENDING_UNINSTALL_DEPLOYMENT", "INSTALLING", "UNINSTALLING", "ERROR", "COMPLETED", "REMOVED"
resp.association.state_reason.error_code #=> String, one of "ValidationError.InsufficientDiskSpace", "ValidationError.InsufficientMemory", "ValidationError.UnsupportedOperatingSystem", "DeploymentError.InternalServerError", "DeploymentError.WorkspaceUnreachable"
resp.association.state_reason.error_message #=> String
resp.association.workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The identifier of the WorkSpace.

  • :application_id (required, String) —

    The identifier of the application.

Returns:

See Also:



603
604
605
606
 
# File 'lib/aws-sdk-workspaces/client.rb', line 603

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



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

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

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

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

Parameters:

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


4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4796

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

API operations.

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/copy-custom-image.html [2]: docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html [3]: docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImagePermissions.html

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:



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

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

#create_account_link_invitation(params = {}) ⇒ Types::CreateAccountLinkInvitationResult

Creates the account link invitation.

Examples:

Request syntax with placeholder values


resp = client.({
  target_account_id: "AwsAccount", # required
  client_token: "ClientToken",
})

Response structure


resp.. #=> String
resp.. #=> String, one of "LINKED", "LINKING_FAILED", "LINK_NOT_FOUND", "PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT", "REJECTED"
resp.. #=> String
resp.. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :target_account_id (required, String) —

    The identifier of the target account.

  • :client_token (String) —

    A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

Returns:

See Also:



742
743
744
745
 
# File 'lib/aws-sdk-workspaces/client.rb', line 742

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



782
783
784
785
 
# File 'lib/aws-sdk-workspaces/client.rb', line 782

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

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html

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:



832
833
834
835
 
# File 'lib/aws-sdk-workspaces/client.rb', line 832

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:



896
897
898
899
 
# File 'lib/aws-sdk-workspaces/client.rb', line 896

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",
        },
      ],
      data_replication: "NO_REPLICATION", # accepts NO_REPLICATION, PRIMARY_AS_SOURCE
    },
  ],
})

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].standby_workspace_request.data_replication #=> String, one of "NO_REPLICATION", "PRIMARY_AS_SOURCE"
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:



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

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:



989
990
991
992
 
# File 'lib/aws-sdk-workspaces/client.rb', line 989

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

<note markdown=“1”> * 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.

</note>

[1]: docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html

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.

    <note markdown=“1”> 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`.

    </note>

Returns:

See Also:



1062
1063
1064
1065
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1062

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

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/create-custom-bundle.html

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", # required
  },
  root_storage: {
    capacity: "NonEmptyString", # required
  },
  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.

    <note markdown=“1”> 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`.

    </note>

Returns:

See Also:



1148
1149
1150
1151
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1148

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:



1209
1210
1211
1212
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1209

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.

<note markdown=“1”> * 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][1].

  • You don’t need to specify the ‘PCOIP` protocol for Linux bundles because `DCV` (formerly WSP) is the default protocol for those bundles.

  • User-decoupled WorkSpaces are only supported by Amazon WorkSpaces Core.

  • Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see [ Can I switch between hourly and monthly billing?]

</note>

[1]: aws.amazon.com/workspaces/core/ [2]: aws.amazon.com/workspaces-family/workspaces/faqs/#:~:text=Can%20I%20switch%20between%20hourly%20and%20monthly%20billing%20on%20WorkSpaces%20Personal%3F

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
        operating_system_name: "AMAZON_LINUX_2", # accepts AMAZON_LINUX_2, UBUNTU_18_04, UBUNTU_20_04, UBUNTU_22_04, UNKNOWN, WINDOWS_10, WINDOWS_11, WINDOWS_7, WINDOWS_SERVER_2016, WINDOWS_SERVER_2019, WINDOWS_SERVER_2022, RHEL_8
      },
      tags: [
        {
          key: "TagKey", # required
          value: "TagValue",
        },
      ],
      workspace_name: "WorkspaceName",
    },
  ],
})

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.workspace_properties.operating_system_name #=> String, one of "AMAZON_LINUX_2", "UBUNTU_18_04", "UBUNTU_20_04", "UBUNTU_22_04", "UNKNOWN", "WINDOWS_10", "WINDOWS_11", "WINDOWS_7", "WINDOWS_SERVER_2016", "WINDOWS_SERVER_2019", "WINDOWS_SERVER_2022", "RHEL_8"
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].workspace_request.workspace_name #=> 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_name #=> String
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].workspace_properties.operating_system_name #=> String, one of "AMAZON_LINUX_2", "UBUNTU_18_04", "UBUNTU_20_04", "UBUNTU_22_04", "UNKNOWN", "WINDOWS_10", "WINDOWS_11", "WINDOWS_7", "WINDOWS_SERVER_2016", "WINDOWS_SERVER_2019", "WINDOWS_SERVER_2022", "RHEL_8"
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"
resp.pending_requests[0].data_replication_settings.data_replication #=> String, one of "NO_REPLICATION", "PRIMARY_AS_SOURCE"
resp.pending_requests[0].data_replication_settings.recovery_snapshot_time #=> Time
resp.pending_requests[0].standby_workspaces_properties #=> Array
resp.pending_requests[0].standby_workspaces_properties[0].standby_workspace_id #=> String
resp.pending_requests[0].standby_workspaces_properties[0].data_replication #=> String, one of "NO_REPLICATION", "PRIMARY_AS_SOURCE"
resp.pending_requests[0].standby_workspaces_properties[0].recovery_snapshot_time #=> Time

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:



1345
1346
1347
1348
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1345

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

#create_workspaces_pool(params = {}) ⇒ Types::CreateWorkspacesPoolResult

Creates a pool of WorkSpaces.

Examples:

Request syntax with placeholder values


resp = client.create_workspaces_pool({
  pool_name: "WorkspacesPoolName", # required
  description: "UpdateDescription", # required
  bundle_id: "BundleId", # required
  directory_id: "DirectoryId", # required
  capacity: { # required
    desired_user_sessions: 1, # required
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  application_settings: {
    status: "DISABLED", # required, accepts DISABLED, ENABLED
    settings_group: "SettingsGroup",
  },
  timeout_settings: {
    disconnect_timeout_in_seconds: 1,
    idle_disconnect_timeout_in_seconds: 1,
    max_user_duration_in_seconds: 1,
  },
})

Response structure


resp.workspaces_pool.pool_id #=> String
resp.workspaces_pool.pool_arn #=> String
resp.workspaces_pool.capacity_status.available_user_sessions #=> Integer
resp.workspaces_pool.capacity_status.desired_user_sessions #=> Integer
resp.workspaces_pool.capacity_status.actual_user_sessions #=> Integer
resp.workspaces_pool.capacity_status.active_user_sessions #=> Integer
resp.workspaces_pool.pool_name #=> String
resp.workspaces_pool.description #=> String
resp.workspaces_pool.state #=> String, one of "CREATING", "DELETING", "RUNNING", "STARTING", "STOPPED", "STOPPING", "UPDATING"
resp.workspaces_pool.created_at #=> Time
resp.workspaces_pool.bundle_id #=> String
resp.workspaces_pool.directory_id #=> String
resp.workspaces_pool.errors #=> Array
resp.workspaces_pool.errors[0].error_code #=> String, one of "IAM_SERVICE_ROLE_IS_MISSING", "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION", "NETWORK_INTERFACE_LIMIT_EXCEEDED", "INTERNAL_SERVICE_ERROR", "MACHINE_ROLE_IS_MISSING", "STS_DISABLED_IN_REGION", "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION", "SUBNET_NOT_FOUND", "IMAGE_NOT_FOUND", "INVALID_SUBNET_CONFIGURATION", "SECURITY_GROUPS_NOT_FOUND", "IGW_NOT_ATTACHED", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION", "WORKSPACES_POOL_STOPPED", "WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE", "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND", "DOMAIN_JOIN_ERROR_ACCESS_DENIED", "DOMAIN_JOIN_ERROR_LOGON_FAILURE", "DOMAIN_JOIN_ERROR_INVALID_PARAMETER", "DOMAIN_JOIN_ERROR_MORE_DATA", "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN", "DOMAIN_JOIN_ERROR_NOT_SUPPORTED", "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME", "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED", "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED", "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED", "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR", "DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING", "DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE", "DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID", "DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND", "DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND", "DOMAIN_JOIN_ERROR_SECRET_INVALID", "BUNDLE_NOT_FOUND", "DIRECTORY_NOT_FOUND", "INSUFFICIENT_PERMISSIONS_ERROR", "DEFAULT_OU_IS_MISSING"
resp.workspaces_pool.errors[0].error_message #=> String
resp.workspaces_pool.application_settings.status #=> String, one of "DISABLED", "ENABLED"
resp.workspaces_pool.application_settings.settings_group #=> String
resp.workspaces_pool.application_settings.s3_bucket_name #=> String
resp.workspaces_pool.timeout_settings.disconnect_timeout_in_seconds #=> Integer
resp.workspaces_pool.timeout_settings.idle_disconnect_timeout_in_seconds #=> Integer
resp.workspaces_pool.timeout_settings.max_user_duration_in_seconds #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :pool_name (required, String) —

    The name of the pool.

  • :description (required, String) —

    The pool description.

  • :bundle_id (required, String) —

    The identifier of the bundle for the pool.

  • :directory_id (required, String) —

    The identifier of the directory for the pool.

  • :capacity (required, Types::Capacity) —

    The user capacity of the pool.

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

    The tags for the pool.

  • :application_settings (Types::ApplicationSettingsRequest) —

    Indicates the application settings of the pool.

  • :timeout_settings (Types::TimeoutSettings) —

    Indicates the timeout settings of the pool.

Returns:

See Also:



1435
1436
1437
1438
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1435

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

#delete_account_link_invitation(params = {}) ⇒ Types::DeleteAccountLinkInvitationResult

Deletes the account link invitation.

Examples:

Request syntax with placeholder values


resp = client.({
  link_id: "LinkId", # required
  client_token: "ClientToken",
})

Response structure


resp.. #=> String
resp.. #=> String, one of "LINKED", "LINKING_FAILED", "LINK_NOT_FOUND", "PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT", "REJECTED"
resp.. #=> String
resp.. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :link_id (required, String) —

    The identifier of the account link.

  • :client_token (String) —

    A string of up to 64 ASCII characters that Amazon EFS uses to ensure idempotent creation.

Returns:

See Also:



1471
1472
1473
1474
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1471

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



1505
1506
1507
1508
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1505

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:



1532
1533
1534
1535
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1532

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

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html [2]: docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html#cross-region-redirection-security-considerations

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:



1575
1576
1577
1578
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1575

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:



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

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:



1628
1629
1630
1631
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1628

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

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/delete_bundle.html

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:



1656
1657
1658
1659
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1656

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:



1680
1681
1682
1683
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1680

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

#deploy_workspace_applications(params = {}) ⇒ Types::DeployWorkspaceApplicationsResult

Deploys associated applications to the specified WorkSpace

Examples:

Request syntax with placeholder values


resp = client.deploy_workspace_applications({
  workspace_id: "WorkspaceId", # required
  force: false,
})

Response structure


resp.deployment.associations #=> Array
resp.deployment.associations[0].associated_resource_id #=> String
resp.deployment.associations[0].associated_resource_type #=> String, one of "APPLICATION"
resp.deployment.associations[0].created #=> Time
resp.deployment.associations[0].last_updated_time #=> Time
resp.deployment.associations[0].state #=> String, one of "PENDING_INSTALL", "PENDING_INSTALL_DEPLOYMENT", "PENDING_UNINSTALL", "PENDING_UNINSTALL_DEPLOYMENT", "INSTALLING", "UNINSTALLING", "ERROR", "COMPLETED", "REMOVED"
resp.deployment.associations[0].state_reason.error_code #=> String, one of "ValidationError.InsufficientDiskSpace", "ValidationError.InsufficientMemory", "ValidationError.UnsupportedOperatingSystem", "DeploymentError.InternalServerError", "DeploymentError.WorkspaceUnreachable"
resp.deployment.associations[0].state_reason.error_message #=> String
resp.deployment.associations[0].workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The identifier of the WorkSpace.

  • :force (Boolean) —

    Indicates whether the force flag is applied for the specified WorkSpace. When the force flag is enabled, it allows previously failed deployments to be retried.

Returns:

See Also:



1722
1723
1724
1725
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1722

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

<note markdown=“1”> 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.

</note>

[1]: aws.amazon.com/directoryservice/pricing/ [2]: docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html

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:



1769
1770
1771
1772
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1769

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
resp. #=> String, one of "SOURCE_ACCOUNT", "TARGET_ACCOUNT"

Parameters:

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

    ({})

Returns:

See Also:



1793
1794
1795
1796
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1793

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:



1831
1832
1833
1834
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1831

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

#describe_application_associations(params = {}) ⇒ Types::DescribeApplicationAssociationsResult

Describes the associations between the application and the specified associated resources.

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_application_associations({
  max_results: 1,
  next_token: "PaginationToken",
  application_id: "WorkSpaceApplicationId", # required
  associated_resource_types: ["WORKSPACE"], # required, accepts WORKSPACE, BUNDLE, IMAGE
})

Response structure


resp.associations #=> Array
resp.associations[0].application_id #=> String
resp.associations[0].associated_resource_id #=> String
resp.associations[0].associated_resource_type #=> String, one of "WORKSPACE", "BUNDLE", "IMAGE"
resp.associations[0].created #=> Time
resp.associations[0].last_updated_time #=> Time
resp.associations[0].state #=> String, one of "PENDING_INSTALL", "PENDING_INSTALL_DEPLOYMENT", "PENDING_UNINSTALL", "PENDING_UNINSTALL_DEPLOYMENT", "INSTALLING", "UNINSTALLING", "ERROR", "COMPLETED", "REMOVED"
resp.associations[0].state_reason.error_code #=> String, one of "ValidationError.InsufficientDiskSpace", "ValidationError.InsufficientMemory", "ValidationError.UnsupportedOperatingSystem", "DeploymentError.InternalServerError", "DeploymentError.WorkspaceUnreachable"
resp.associations[0].state_reason.error_message #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of associations 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.

  • :application_id (required, String) —

    The identifier of the specified application.

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

    The resource type of the associated resources.

Returns:

See Also:



1885
1886
1887
1888
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1885

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

#describe_applications(params = {}) ⇒ Types::DescribeApplicationsResult

Describes the specified applications by filtering based on their compute types, license availability, operating systems, and owners.

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_applications({
  application_ids: ["WorkSpaceApplicationId"],
  compute_type_names: ["VALUE"], # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO, GRAPHICS_G4DN, GRAPHICSPRO_G4DN
  license_type: "LICENSED", # accepts LICENSED, UNLICENSED
  operating_system_names: ["AMAZON_LINUX_2"], # accepts AMAZON_LINUX_2, UBUNTU_18_04, UBUNTU_20_04, UBUNTU_22_04, UNKNOWN, WINDOWS_10, WINDOWS_11, WINDOWS_7, WINDOWS_SERVER_2016, WINDOWS_SERVER_2019, WINDOWS_SERVER_2022, RHEL_8
  owner: "WorkSpaceApplicationOwner",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.applications #=> Array
resp.applications[0].application_id #=> String
resp.applications[0].created #=> Time
resp.applications[0].description #=> String
resp.applications[0].license_type #=> String, one of "LICENSED", "UNLICENSED"
resp.applications[0].name #=> String
resp.applications[0].owner #=> String
resp.applications[0].state #=> String, one of "PENDING", "ERROR", "AVAILABLE", "UNINSTALL_ONLY"
resp.applications[0].supported_compute_type_names #=> Array
resp.applications[0].supported_compute_type_names[0] #=> String, one of "VALUE", "STANDARD", "PERFORMANCE", "POWER", "GRAPHICS", "POWERPRO", "GRAPHICSPRO", "GRAPHICS_G4DN", "GRAPHICSPRO_G4DN"
resp.applications[0].supported_operating_system_names #=> Array
resp.applications[0].supported_operating_system_names[0] #=> String, one of "AMAZON_LINUX_2", "UBUNTU_18_04", "UBUNTU_20_04", "UBUNTU_22_04", "UNKNOWN", "WINDOWS_10", "WINDOWS_11", "WINDOWS_7", "WINDOWS_SERVER_2016", "WINDOWS_SERVER_2019", "WINDOWS_SERVER_2022", "RHEL_8"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :application_ids (Array<String>) —

    The identifiers of one or more applications.

  • :compute_type_names (Array<String>) —

    The compute types supported by the applications.

  • :license_type (String) —

    The license availability for the applications.

  • :operating_system_names (Array<String>) —

    The operating systems supported by the applications.

  • :owner (String) —

    The owner of the applications.

  • :max_results (Integer) —

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



1954
1955
1956
1957
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1954

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

#describe_bundle_associations(params = {}) ⇒ Types::DescribeBundleAssociationsResult

Describes the associations between the applications and the specified bundle.

Examples:

Request syntax with placeholder values


resp = client.describe_bundle_associations({
  bundle_id: "BundleId", # required
  associated_resource_types: ["APPLICATION"], # required, accepts APPLICATION
})

Response structure


resp.associations #=> Array
resp.associations[0].associated_resource_id #=> String
resp.associations[0].associated_resource_type #=> String, one of "APPLICATION"
resp.associations[0].bundle_id #=> String
resp.associations[0].created #=> Time
resp.associations[0].last_updated_time #=> Time
resp.associations[0].state #=> String, one of "PENDING_INSTALL", "PENDING_INSTALL_DEPLOYMENT", "PENDING_UNINSTALL", "PENDING_UNINSTALL_DEPLOYMENT", "INSTALLING", "UNINSTALLING", "ERROR", "COMPLETED", "REMOVED"
resp.associations[0].state_reason.error_code #=> String, one of "ValidationError.InsufficientDiskSpace", "ValidationError.InsufficientMemory", "ValidationError.UnsupportedOperatingSystem", "DeploymentError.InternalServerError", "DeploymentError.WorkspaceUnreachable"
resp.associations[0].state_reason.error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :bundle_id (required, String) —

    The identifier of the bundle.

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

    The resource types of the associated resource.

Returns:

See Also:



1995
1996
1997
1998
 
# File 'lib/aws-sdk-workspaces/client.rb', line 1995

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

<note markdown=“1”> Only device types that have branding information configured will be shown in the response.

</note>

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:



2075
2076
2077
2078
 
# File 'lib/aws-sdk-workspaces/client.rb', line 2075

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:



2107
2108
2109
2110
 
# File 'lib/aws-sdk-workspaces/client.rb', line 2107

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:



2151
2152
2153
2154
 
# File 'lib/aws-sdk-workspaces/client.rb', line 2151

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

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html

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:



2201
2202
2203
2204
 
# File 'lib/aws-sdk-workspaces/client.rb', line 2201

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

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html

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:



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

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

#describe_image_associations(params = {}) ⇒ Types::DescribeImageAssociationsResult

Describes the associations between the applications and the specified image.

Examples:

Request syntax with placeholder values


resp = client.describe_image_associations({
  image_id: "WorkspaceImageId", # required
  associated_resource_types: ["APPLICATION"], # required, accepts APPLICATION
})

Response structure


resp.associations #=> Array
resp.associations[0].associated_resource_id #=> String
resp.associations[0].associated_resource_type #=> String, one of "APPLICATION"
resp.associations[0].created #=> Time
resp.associations[0].last_updated_time #=> Time
resp.associations[0].image_id #=> String
resp.associations[0].state #=> String, one of "PENDING_INSTALL", "PENDING_INSTALL_DEPLOYMENT", "PENDING_UNINSTALL", "PENDING_UNINSTALL_DEPLOYMENT", "INSTALLING", "UNINSTALLING", "ERROR", "COMPLETED", "REMOVED"
resp.associations[0].state_reason.error_code #=> String, one of "ValidationError.InsufficientDiskSpace", "ValidationError.InsufficientMemory", "ValidationError.UnsupportedOperatingSystem", "DeploymentError.InternalServerError", "DeploymentError.WorkspaceUnreachable"
resp.associations[0].state_reason.error_message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :image_id (required, String) —

    The identifier of the image.

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

    The resource types of the associated resource.

Returns:

See Also:



2300
2301
2302
2303
 
# File 'lib/aws-sdk-workspaces/client.rb', line 2300

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



2345
2346
2347
2348
 
# File 'lib/aws-sdk-workspaces/client.rb', line 2345

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:



2377
2378
2379
2380
 
# File 'lib/aws-sdk-workspaces/client.rb', line 2377

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

#describe_workspace_associations(params = {}) ⇒ Types::DescribeWorkspaceAssociationsResult

Describes the associations betweens applications and the specified WorkSpace.

Examples:

Request syntax with placeholder values


resp = client.describe_workspace_associations({
  workspace_id: "WorkspaceId", # required
  associated_resource_types: ["APPLICATION"], # required, accepts APPLICATION
})

Response structure


resp.associations #=> Array
resp.associations[0].associated_resource_id #=> String
resp.associations[0].associated_resource_type #=> String, one of "APPLICATION"
resp.associations[0].created #=> Time
resp.associations[0].last_updated_time #=> Time
resp.associations[0].state #=> String, one of "PENDING_INSTALL", "PENDING_INSTALL_DEPLOYMENT", "PENDING_UNINSTALL", "PENDING_UNINSTALL_DEPLOYMENT", "INSTALLING", "UNINSTALLING", "ERROR", "COMPLETED", "REMOVED"
resp.associations[0].state_reason.error_code #=> String, one of "ValidationError.InsufficientDiskSpace", "ValidationError.InsufficientMemory", "ValidationError.UnsupportedOperatingSystem", "DeploymentError.InternalServerError", "DeploymentError.WorkspaceUnreachable"
resp.associations[0].state_reason.error_message #=> String
resp.associations[0].workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The identifier of the WorkSpace.

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

    The resource types of the associated resources.

Returns:

See Also:



2418
2419
2420
2421
 
# File 'lib/aws-sdk-workspaces/client.rb', line 2418

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



2480
2481
2482
2483
 
# File 'lib/aws-sdk-workspaces/client.rb', line 2480

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"],
  workspace_directory_names: ["WorkspaceDirectoryName"],
  limit: 1,
  next_token: "PaginationToken",
  filters: [
    {
      name: "USER_IDENTITY_TYPE", # required, accepts USER_IDENTITY_TYPE, WORKSPACE_TYPE
      values: ["DescribeWorkspaceDirectoriesFilterValue"], # required
    },
  ],
})

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", "CUSTOMER_MANAGED", "AWS_IAM_IDENTITY_CENTER"
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].workspace_creation_properties.instance_iam_role_arn #=> String
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.directories[0].microsoft_entra_config.tenant_id #=> String
resp.directories[0].microsoft_entra_config.application_config_secret_arn #=> String
resp.directories[0].workspace_directory_name #=> String
resp.directories[0].workspace_directory_description #=> String
resp.directories[0].user_identity_type #=> String, one of "CUSTOMER_MANAGED", "AWS_DIRECTORY_SERVICE", "AWS_IAM_IDENTITY_CENTER"
resp.directories[0].workspace_type #=> String, one of "PERSONAL", "POOLS"
resp.directories[0].idc_config.instance_arn #=> String
resp.directories[0].idc_config.application_arn #=> String
resp.directories[0].active_directory_config.domain_name #=> String
resp.directories[0].active_directory_config. #=> String
resp.directories[0].streaming_properties.streaming_experience_preferred_protocol #=> String, one of "TCP", "UDP"
resp.directories[0].streaming_properties. #=> Array
resp.directories[0].streaming_properties.[0].action #=> String, one of "CLIPBOARD_COPY_FROM_LOCAL_DEVICE", "CLIPBOARD_COPY_TO_LOCAL_DEVICE", "PRINTING_TO_LOCAL_DEVICE", "SMART_CARD"
resp.directories[0].streaming_properties.[0].permission #=> String, one of "ENABLED", "DISABLED"
resp.directories[0].streaming_properties.[0].maximum_length #=> Integer
resp.directories[0].streaming_properties.storage_connectors #=> Array
resp.directories[0].streaming_properties.storage_connectors[0].connector_type #=> String, one of "HOME_FOLDER"
resp.directories[0].streaming_properties.storage_connectors[0].status #=> String, one of "ENABLED", "DISABLED"
resp.directories[0].error_message #=> 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.

  • :workspace_directory_names (Array<String>) —

    The names of the WorkSpace directories.

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

  • :filters (Array<Types::DescribeWorkspaceDirectoriesFilter>) —

    The filter condition for the WorkSpaces.

Returns:

See Also:



2596
2597
2598
2599
 
# File 'lib/aws-sdk-workspaces/client.rb', line 2596

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:



2639
2640
2641
2642
 
# File 'lib/aws-sdk-workspaces/client.rb', line 2639

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.images[0].error_details #=> Array
resp.images[0].error_details[0].error_code #=> String, one of "OutdatedPowershellVersion", "OfficeInstalled", "PCoIPAgentInstalled", "WindowsUpdatesEnabled", "AutoMountDisabled", "WorkspacesBYOLAccountNotFound", "WorkspacesBYOLAccountDisabled", "DHCPDisabled", "DiskFreeSpace", "AdditionalDrivesAttached", "OSNotSupported", "DomainJoined", "AzureDomainJoined", "FirewallEnabled", "VMWareToolsInstalled", "DiskSizeExceeded", "IncompatiblePartitioning", "PendingReboot", "AutoLogonEnabled", "RealTimeUniversalDisabled", "MultipleBootPartition", "Requires64BitOS", "ZeroRearmCount", "InPlaceUpgrade", "AntiVirusInstalled", "UEFINotSupported", "UnknownError", "AppXPackagesInstalled", "ReservedStorageInUse"
resp.images[0].error_details[0].error_message #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :image_ids (Array<String>) —

    The identifier of the image.

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



2699
2700
2701
2702
 
# File 'lib/aws-sdk-workspaces/client.rb', line 2699

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:



2731
2732
2733
2734
 
# File 'lib/aws-sdk-workspaces/client.rb', line 2731

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",
  workspace_name: "WorkspaceName",
})

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_name #=> String
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].workspace_properties.operating_system_name #=> String, one of "AMAZON_LINUX_2", "UBUNTU_18_04", "UBUNTU_20_04", "UBUNTU_22_04", "UNKNOWN", "WINDOWS_10", "WINDOWS_11", "WINDOWS_7", "WINDOWS_SERVER_2016", "WINDOWS_SERVER_2019", "WINDOWS_SERVER_2022", "RHEL_8"
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.workspaces[0].data_replication_settings.data_replication #=> String, one of "NO_REPLICATION", "PRIMARY_AS_SOURCE"
resp.workspaces[0].data_replication_settings.recovery_snapshot_time #=> Time
resp.workspaces[0].standby_workspaces_properties #=> Array
resp.workspaces[0].standby_workspaces_properties[0].standby_workspace_id #=> String
resp.workspaces[0].standby_workspaces_properties[0].data_replication #=> String, one of "NO_REPLICATION", "PRIMARY_AS_SOURCE"
resp.workspaces[0].standby_workspaces_properties[0].recovery_snapshot_time #=> Time
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.

  • :workspace_name (String) —

    The name of the user-decoupled WorkSpace.

Returns:

See Also:



2837
2838
2839
2840
 
# File 'lib/aws-sdk-workspaces/client.rb', line 2837

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:



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

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

#describe_workspaces_pool_sessions(params = {}) ⇒ Types::DescribeWorkspacesPoolSessionsResult

Retrieves a list that describes the streaming sessions for a specified pool.

Examples:

Request syntax with placeholder values


resp = client.describe_workspaces_pool_sessions({
  pool_id: "WorkspacesPoolId", # required
  user_id: "WorkspacesPoolUserId",
  limit: 1,
  next_token: "PaginationToken",
})

Response structure


resp.sessions #=> Array
resp.sessions[0].authentication_type #=> String, one of "SAML"
resp.sessions[0].connection_state #=> String, one of "CONNECTED", "NOT_CONNECTED"
resp.sessions[0].session_id #=> String
resp.sessions[0].instance_id #=> String
resp.sessions[0].pool_id #=> String
resp.sessions[0].expiration_time #=> Time
resp.sessions[0].network_access_configuration.eni_private_ip_address #=> String
resp.sessions[0].network_access_configuration.eni_id #=> String
resp.sessions[0].start_time #=> Time
resp.sessions[0].user_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :pool_id (required, String) —

    The identifier of the pool.

  • :user_id (String) —

    The identifier of the user.

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



2931
2932
2933
2934
 
# File 'lib/aws-sdk-workspaces/client.rb', line 2931

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

#describe_workspaces_pools(params = {}) ⇒ Types::DescribeWorkspacesPoolsResult

Describes the specified WorkSpaces Pools.

Examples:

Request syntax with placeholder values


resp = client.describe_workspaces_pools({
  pool_ids: ["WorkspacesPoolId"],
  filters: [
    {
      name: "PoolName", # required, accepts PoolName
      values: ["DescribeWorkspacesPoolsFilterValue"], # required
      operator: "EQUALS", # required, accepts EQUALS, NOTEQUALS, CONTAINS, NOTCONTAINS
    },
  ],
  limit: 1,
  next_token: "PaginationToken",
})

Response structure


resp.workspaces_pools #=> Array
resp.workspaces_pools[0].pool_id #=> String
resp.workspaces_pools[0].pool_arn #=> String
resp.workspaces_pools[0].capacity_status.available_user_sessions #=> Integer
resp.workspaces_pools[0].capacity_status.desired_user_sessions #=> Integer
resp.workspaces_pools[0].capacity_status.actual_user_sessions #=> Integer
resp.workspaces_pools[0].capacity_status.active_user_sessions #=> Integer
resp.workspaces_pools[0].pool_name #=> String
resp.workspaces_pools[0].description #=> String
resp.workspaces_pools[0].state #=> String, one of "CREATING", "DELETING", "RUNNING", "STARTING", "STOPPED", "STOPPING", "UPDATING"
resp.workspaces_pools[0].created_at #=> Time
resp.workspaces_pools[0].bundle_id #=> String
resp.workspaces_pools[0].directory_id #=> String
resp.workspaces_pools[0].errors #=> Array
resp.workspaces_pools[0].errors[0].error_code #=> String, one of "IAM_SERVICE_ROLE_IS_MISSING", "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION", "NETWORK_INTERFACE_LIMIT_EXCEEDED", "INTERNAL_SERVICE_ERROR", "MACHINE_ROLE_IS_MISSING", "STS_DISABLED_IN_REGION", "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION", "SUBNET_NOT_FOUND", "IMAGE_NOT_FOUND", "INVALID_SUBNET_CONFIGURATION", "SECURITY_GROUPS_NOT_FOUND", "IGW_NOT_ATTACHED", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION", "WORKSPACES_POOL_STOPPED", "WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE", "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND", "DOMAIN_JOIN_ERROR_ACCESS_DENIED", "DOMAIN_JOIN_ERROR_LOGON_FAILURE", "DOMAIN_JOIN_ERROR_INVALID_PARAMETER", "DOMAIN_JOIN_ERROR_MORE_DATA", "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN", "DOMAIN_JOIN_ERROR_NOT_SUPPORTED", "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME", "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED", "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED", "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED", "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR", "DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING", "DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE", "DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID", "DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND", "DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND", "DOMAIN_JOIN_ERROR_SECRET_INVALID", "BUNDLE_NOT_FOUND", "DIRECTORY_NOT_FOUND", "INSUFFICIENT_PERMISSIONS_ERROR", "DEFAULT_OU_IS_MISSING"
resp.workspaces_pools[0].errors[0].error_message #=> String
resp.workspaces_pools[0].application_settings.status #=> String, one of "DISABLED", "ENABLED"
resp.workspaces_pools[0].application_settings.settings_group #=> String
resp.workspaces_pools[0].application_settings.s3_bucket_name #=> String
resp.workspaces_pools[0].timeout_settings.disconnect_timeout_in_seconds #=> Integer
resp.workspaces_pools[0].timeout_settings.idle_disconnect_timeout_in_seconds #=> Integer
resp.workspaces_pools[0].timeout_settings.max_user_duration_in_seconds #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :pool_ids (Array<String>) —

    The identifier of the WorkSpaces Pools.

  • :filters (Array<Types::DescribeWorkspacesPoolsFilter>) —

    The filter conditions for the WorkSpaces Pool to return.

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



3001
3002
3003
3004
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3001

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

<note markdown=“1”> Before performing this operation, call [ DescribeConnectionAliases] to make sure that the current state of the connection alias is ‘CREATED`.

</note>

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html [2]: docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html

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:



3037
3038
3039
3040
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3037

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:



3064
3065
3066
3067
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3064

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

#disassociate_workspace_application(params = {}) ⇒ Types::DisassociateWorkspaceApplicationResult

Disassociates the specified application from a WorkSpace.

Examples:

Request syntax with placeholder values


resp = client.disassociate_workspace_application({
  workspace_id: "WorkspaceId", # required
  application_id: "WorkSpaceApplicationId", # required
})

Response structure


resp.association.associated_resource_id #=> String
resp.association.associated_resource_type #=> String, one of "APPLICATION"
resp.association.created #=> Time
resp.association.last_updated_time #=> Time
resp.association.state #=> String, one of "PENDING_INSTALL", "PENDING_INSTALL_DEPLOYMENT", "PENDING_UNINSTALL", "PENDING_UNINSTALL_DEPLOYMENT", "INSTALLING", "UNINSTALLING", "ERROR", "COMPLETED", "REMOVED"
resp.association.state_reason.error_code #=> String, one of "ValidationError.InsufficientDiskSpace", "ValidationError.InsufficientMemory", "ValidationError.UnsupportedOperatingSystem", "DeploymentError.InternalServerError", "DeploymentError.WorkspaceUnreachable"
resp.association.state_reason.error_message #=> String
resp.association.workspace_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The identifier of the WorkSpace.

  • :application_id (required, String) —

    The identifier of the application.

Returns:

See Also:



3103
3104
3105
3106
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3103

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

#get_account_link(params = {}) ⇒ Types::GetAccountLinkResult

Retrieves account link information.

Examples:

Request syntax with placeholder values


resp = client.({
  link_id: "LinkId",
  linked_account_id: "AwsAccount",
})

Response structure


resp.. #=> String
resp.. #=> String, one of "LINKED", "LINKING_FAILED", "LINK_NOT_FOUND", "PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT", "REJECTED"
resp.. #=> String
resp.. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :link_id (String) —

    The identifier of the account to link.

  • :linked_account_id (String) —

    The identifier of the account link

Returns:

See Also:



3138
3139
3140
3141
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3138

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

<note markdown=“1”> * 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.

</note>

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:



3305
3306
3307
3308
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3305

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 or 11 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].

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html

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_GRAPHICS_G4DN_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, DCV, or bring your own protocol (BYOP). To use WSP, specify a value that ends in ‘_DCV`. To use PCoIP, specify a value that does not end in `_DCV`. 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_DCV`, or `BYOL_REGULAR_BYOP`, depending on the protocol.

    <note markdown=“1”> 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].

    </note>

    [1]: aws.amazon.com/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 and 11 BYOL images. For more information about subscribing to Office for BYOL images, see [ Bring Your Own Windows Desktop Licenses].

    <note markdown=“1”> * Although this parameter is an array, only one item is allowed at

    this time.

    • During the image import process, non-GPU DCV (formerly WSP) WorkSpaces with Windows 11 support only ‘Microsoft_Office_2019`. GPU DCV (formerly WSP) WorkSpaces with Windows 11 do not support Office installation.

    </note>

    [1]: docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html

Returns:

See Also:



3403
3404
3405
3406
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3403

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

#list_account_links(params = {}) ⇒ Types::ListAccountLinksResult

Lists all account links.

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

Examples:

Request syntax with placeholder values


resp = client.({
  link_status_filter: ["LINKED"], # accepts LINKED, LINKING_FAILED, LINK_NOT_FOUND, PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT, REJECTED
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp. #=> Array
resp.[0]. #=> String
resp.[0]. #=> String, one of "LINKED", "LINKING_FAILED", "LINK_NOT_FOUND", "PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT", "REJECTED"
resp.[0]. #=> String
resp.[0]. #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :link_status_filter (Array<String>) —

    Filters the account based on their link status.

  • :next_token (String) —

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

  • :max_results (Integer) —

    The maximum number of accounts to return.

Returns:

See Also:



3448
3449
3450
3451
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3448

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



3501
3502
3503
3504
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3501

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

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

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:



3551
3552
3553
3554
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3551

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:



3583
3584
3585
3586
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3583

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:



3618
3619
3620
3621
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3618

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:



3647
3648
3649
3650
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3647

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:



3692
3693
3694
3695
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3692

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

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/enable-user-self-service-workspace-management.html

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:



3730
3731
3732
3733
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3730

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

#modify_streaming_properties(params = {}) ⇒ Struct

Modifies the specified streaming properties.

Examples:

Request syntax with placeholder values


resp = client.modify_streaming_properties({
  resource_id: "DirectoryId", # required
  streaming_properties: {
    streaming_experience_preferred_protocol: "TCP", # accepts TCP, UDP
    user_settings: [
      {
        action: "CLIPBOARD_COPY_FROM_LOCAL_DEVICE", # required, accepts CLIPBOARD_COPY_FROM_LOCAL_DEVICE, CLIPBOARD_COPY_TO_LOCAL_DEVICE, PRINTING_TO_LOCAL_DEVICE, SMART_CARD
        permission: "ENABLED", # required, accepts ENABLED, DISABLED
        maximum_length: 1,
      },
    ],
    storage_connectors: [
      {
        connector_type: "HOME_FOLDER", # required, accepts HOME_FOLDER
        status: "ENABLED", # required, accepts ENABLED, DISABLED
      },
    ],
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_id (required, String) —

    The identifier of the resource.

  • :streaming_properties (Types::StreamingProperties) —

    The streaming properties to configure.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3771
3772
3773
3774
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3771

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

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html#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:



3813
3814
3815
3816
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3813

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,
    instance_iam_role_arn: "ARN",
  },
})

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:



3847
3848
3849
3850
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3847

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

<note markdown=“1”> 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].

</note>

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/modify-workspaces.html [2]: aws.amazon.com/workspaces/core/

Examples:

Request syntax with placeholder values


resp = client.modify_workspace_properties({
  workspace_id: "WorkspaceId", # required
  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
    operating_system_name: "AMAZON_LINUX_2", # accepts AMAZON_LINUX_2, UBUNTU_18_04, UBUNTU_20_04, UBUNTU_22_04, UNKNOWN, WINDOWS_10, WINDOWS_11, WINDOWS_7, WINDOWS_SERVER_2016, WINDOWS_SERVER_2019, WINDOWS_SERVER_2022, RHEL_8
  },
  data_replication: "NO_REPLICATION", # accepts NO_REPLICATION, PRIMARY_AS_SOURCE
})

Parameters:

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

    ({})

Options Hash (params):

  • :workspace_id (required, String) —

    The identifier of the WorkSpace.

  • :workspace_properties (Types::WorkspaceProperties) —

    The properties of the WorkSpace.

  • :data_replication (String) —

    Indicates the data replication status.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3898
3899
3900
3901
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3898

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:



3930
3931
3932
3933
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3930

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`, `UNHEALTHY`, or `REBOOTING`. Reboot a WorkSpace in the `REBOOTING` state only if your WorkSpace has been stuck in the `REBOOTING` state for over 20 minutes.

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:



3973
3974
3975
3976
 
# File 'lib/aws-sdk-workspaces/client.rb', line 3973

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.

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

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

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

Returns:

See Also:



4022
4023
4024
4025
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4022

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

#register_workspace_directory(params = {}) ⇒ Types::RegisterWorkspaceDirectoryResult

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

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/workspaces-access-control.html#create-default-role

Examples:

Request syntax with placeholder values


resp = client.register_workspace_directory({
  directory_id: "DirectoryId",
  subnet_ids: ["SubnetId"],
  enable_work_docs: false,
  enable_self_service: false,
  tenancy: "DEDICATED", # accepts DEDICATED, SHARED
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
  workspace_directory_name: "WorkspaceDirectoryName",
  workspace_directory_description: "WorkspaceDirectoryDescription",
  user_identity_type: "CUSTOMER_MANAGED", # accepts CUSTOMER_MANAGED, AWS_DIRECTORY_SERVICE, AWS_IAM_IDENTITY_CENTER
  idc_instance_arn: "ARN",
  microsoft_entra_config: {
    tenant_id: "MicrosoftEntraConfigTenantId",
    application_config_secret_arn: "SecretsManagerArn",
  },
  workspace_type: "PERSONAL", # accepts PERSONAL, POOLS
  active_directory_config: {
    domain_name: "DomainName", # required
    service_account_secret_arn: "SecretsManagerArn", # required
  },
})

Response structure


resp.directory_id #=> String
resp.state #=> String, one of "REGISTERING", "REGISTERED", "DEREGISTERING", "DEREGISTERED", "ERROR"

Parameters:

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

    ({})

Options Hash (params):

  • :directory_id (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 (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].

    [1]: docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html

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

    The tags associated with the directory.

  • :workspace_directory_name (String) —

    The name of the directory to register.

  • :workspace_directory_description (String) —

    Description of the directory to register.

  • :user_identity_type (String) —

    The type of identity management the user is using.

  • :idc_instance_arn (String) —

    The Amazon Resource Name (ARN) of the identity center instance.

  • :microsoft_entra_config (Types::MicrosoftEntraConfig) —

    The details about Microsoft Entra config.

  • :workspace_type (String) —

    Indicates whether the directory’s WorkSpace type is personal or pools.

  • :active_directory_config (Types::ActiveDirectoryConfig) —

    The active directory config of the directory.

Returns:

See Also:



4143
4144
4145
4146
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4143

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

#reject_account_link_invitation(params = {}) ⇒ Types::RejectAccountLinkInvitationResult

Rejects the account link invitation.

Examples:

Request syntax with placeholder values


resp = client.({
  link_id: "LinkId", # required
  client_token: "ClientToken",
})

Response structure


resp.. #=> String
resp.. #=> String, one of "LINKED", "LINKING_FAILED", "LINK_NOT_FOUND", "PENDING_ACCEPTANCE_BY_TARGET_ACCOUNT", "REJECTED"
resp.. #=> String
resp.. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :link_id (required, String) —

    The identifier of the account link

  • :client_token (String) —

    The client token of the account link invitation to reject.

Returns:

See Also:



4178
4179
4180
4181
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4178

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

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

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:



4214
4215
4216
4217
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4214

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:



4240
4241
4242
4243
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4240

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` or `Manual` 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:



4278
4279
4280
4281
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4278

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

#start_workspaces_pool(params = {}) ⇒ Struct

Starts the specified pool.

You cannot start a pool unless it has a running mode of ‘AutoStop` and a state of `STOPPED`.

Examples:

Request syntax with placeholder values


resp = client.start_workspaces_pool({
  pool_id: "WorkspacesPoolId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :pool_id (required, String) —

    The identifier of the pool.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4303
4304
4305
4306
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4303

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



4342
4343
4344
4345
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4342

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

#stop_workspaces_pool(params = {}) ⇒ Struct

Stops the specified pool.

You cannot stop a WorkSpace pool 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_pool({
  pool_id: "WorkspacesPoolId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :pool_id (required, String) —

    The identifier of the pool.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4368
4369
4370
4371
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4368

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

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html [2]: aws.amazon.com/directoryservice/pricing/ [3]: docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html

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:



4437
4438
4439
4440
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4437

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

#terminate_workspaces_pool(params = {}) ⇒ Struct

Terminates the specified pool.

Examples:

Request syntax with placeholder values


resp = client.terminate_workspaces_pool({
  pool_id: "WorkspacesPoolId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :pool_id (required, String) —

    The identifier of the pool.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4459
4460
4461
4462
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4459

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

#terminate_workspaces_pool_session(params = {}) ⇒ Struct

Terminates the pool session.

Examples:

Request syntax with placeholder values


resp = client.terminate_workspaces_pool_session({
  session_id: "AmazonUuid", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :session_id (required, String) —

    The identifier of the pool session.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



4481
4482
4483
4484
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4481

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



4516
4517
4518
4519
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4516

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

<note markdown=“1”> * Before performing this operation, call [

DescribeConnectionAliases][2] 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.

</note>

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html [2]: docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html

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:



4571
4572
4573
4574
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4571

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:



4603
4604
4605
4606
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4603

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.

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/update-custom-bundle.html

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:



4640
4641
4642
4643
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4640

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

<note markdown=“1”> * 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.

</note>

[1]: docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html

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:



4706
4707
4708
4709
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4706

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

#update_workspaces_pool(params = {}) ⇒ Types::UpdateWorkspacesPoolResult

Updates the specified pool.

Examples:

Request syntax with placeholder values


resp = client.update_workspaces_pool({
  pool_id: "WorkspacesPoolId", # required
  description: "UpdateDescription",
  bundle_id: "BundleId",
  directory_id: "DirectoryId",
  capacity: {
    desired_user_sessions: 1, # required
  },
  application_settings: {
    status: "DISABLED", # required, accepts DISABLED, ENABLED
    settings_group: "SettingsGroup",
  },
  timeout_settings: {
    disconnect_timeout_in_seconds: 1,
    idle_disconnect_timeout_in_seconds: 1,
    max_user_duration_in_seconds: 1,
  },
})

Response structure


resp.workspaces_pool.pool_id #=> String
resp.workspaces_pool.pool_arn #=> String
resp.workspaces_pool.capacity_status.available_user_sessions #=> Integer
resp.workspaces_pool.capacity_status.desired_user_sessions #=> Integer
resp.workspaces_pool.capacity_status.actual_user_sessions #=> Integer
resp.workspaces_pool.capacity_status.active_user_sessions #=> Integer
resp.workspaces_pool.pool_name #=> String
resp.workspaces_pool.description #=> String
resp.workspaces_pool.state #=> String, one of "CREATING", "DELETING", "RUNNING", "STARTING", "STOPPED", "STOPPING", "UPDATING"
resp.workspaces_pool.created_at #=> Time
resp.workspaces_pool.bundle_id #=> String
resp.workspaces_pool.directory_id #=> String
resp.workspaces_pool.errors #=> Array
resp.workspaces_pool.errors[0].error_code #=> String, one of "IAM_SERVICE_ROLE_IS_MISSING", "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION", "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION", "NETWORK_INTERFACE_LIMIT_EXCEEDED", "INTERNAL_SERVICE_ERROR", "MACHINE_ROLE_IS_MISSING", "STS_DISABLED_IN_REGION", "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION", "SUBNET_NOT_FOUND", "IMAGE_NOT_FOUND", "INVALID_SUBNET_CONFIGURATION", "SECURITY_GROUPS_NOT_FOUND", "IGW_NOT_ATTACHED", "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION", "WORKSPACES_POOL_STOPPED", "WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE", "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND", "DOMAIN_JOIN_ERROR_ACCESS_DENIED", "DOMAIN_JOIN_ERROR_LOGON_FAILURE", "DOMAIN_JOIN_ERROR_INVALID_PARAMETER", "DOMAIN_JOIN_ERROR_MORE_DATA", "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN", "DOMAIN_JOIN_ERROR_NOT_SUPPORTED", "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME", "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED", "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED", "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED", "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR", "DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING", "DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE", "DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID", "DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND", "DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND", "DOMAIN_JOIN_ERROR_SECRET_INVALID", "BUNDLE_NOT_FOUND", "DIRECTORY_NOT_FOUND", "INSUFFICIENT_PERMISSIONS_ERROR", "DEFAULT_OU_IS_MISSING"
resp.workspaces_pool.errors[0].error_message #=> String
resp.workspaces_pool.application_settings.status #=> String, one of "DISABLED", "ENABLED"
resp.workspaces_pool.application_settings.settings_group #=> String
resp.workspaces_pool.application_settings.s3_bucket_name #=> String
resp.workspaces_pool.timeout_settings.disconnect_timeout_in_seconds #=> Integer
resp.workspaces_pool.timeout_settings.idle_disconnect_timeout_in_seconds #=> Integer
resp.workspaces_pool.timeout_settings.max_user_duration_in_seconds #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :pool_id (required, String) —

    The identifier of the specified pool to update.

  • :description (String) —

    Describes the specified pool to update.

  • :bundle_id (String) —

    The identifier of the bundle.

  • :directory_id (String) —

    The identifier of the directory.

  • :capacity (Types::Capacity) —

    The desired capacity for the pool.

  • :application_settings (Types::ApplicationSettingsRequest) —

    The persistent application settings for users in the pool.

  • :timeout_settings (Types::TimeoutSettings) —

    Indicates the timeout settings of the specified pool.

Returns:

See Also:



4787
4788
4789
4790
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4787

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

#waiter_names ⇒ Object

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

Deprecated. 


4816
4817
4818
 
# File 'lib/aws-sdk-workspaces/client.rb', line 4816

def waiter_names
  []
end