Class: Aws::WorkSpacesThinClient::Client

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

Overview

An API client for WorkSpacesThinClient. To construct a client, you need to configure a :region and :credentials.

client = Aws::WorkSpacesThinClient::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

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

Defined Under Namespace

Modules: _CreateEnvironmentResponseSuccess, _DeleteDeviceResponseSuccess, _DeleteEnvironmentResponseSuccess, _DeregisterDeviceResponseSuccess, _GetDeviceResponseSuccess, _GetEnvironmentResponseSuccess, _GetSoftwareSetResponseSuccess, _ListDevicesResponseSuccess, _ListEnvironmentsResponseSuccess, _ListSoftwareSetsResponseSuccess, _ListTagsForResourceResponseSuccess, _TagResourceResponseSuccess, _UntagResourceResponseSuccess, _UpdateDeviceResponseSuccess, _UpdateEnvironmentResponseSuccess, _UpdateSoftwareSetResponseSuccess

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 used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

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

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

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

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

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

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

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

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

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

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

    • Aws.config[:credentials]

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

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.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['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

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

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

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

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

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

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

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :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.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

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

  • :retry_base_delay (Float) — default: 0.3 —

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

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

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

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

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

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

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

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :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) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or 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::WorkSpacesThinClient::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::WorkSpacesThinClient::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 'http://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.



471
472
473
 
# File 'lib/aws-sdk-workspacesthinclient/client.rb', line 471

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. 



1350
1351
1352
 
# File 'lib/aws-sdk-workspacesthinclient/client.rb', line 1350

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. 



1353
1354
1355
 
# File 'lib/aws-sdk-workspacesthinclient/client.rb', line 1353

def errors_module
  Errors
end

.new ⇒ Object

https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/WorkSpacesThinClient/Client.html#initialize-instance_method



14
 
# File 'sig/client.rbs', line 14

def self.new: (

Instance Method Details

#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: {}) 


1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
 
# File 'lib/aws-sdk-workspacesthinclient/client.rb', line 1323

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::WorkSpacesThinClient')
  )
  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-workspacesthinclient'
  context[:gem_version] = '1.47.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_environment(params = {}) ⇒ Types::CreateEnvironmentResponse

Creates an environment for your thin client devices.

Examples:

Request syntax with placeholder values


resp = client.create_environment({
  name: "EnvironmentName",
  desktop_arn: "Arn", # required
  desktop_endpoint: "DesktopEndpoint",
  software_set_update_schedule: "USE_MAINTENANCE_WINDOW", # accepts USE_MAINTENANCE_WINDOW, APPLY_IMMEDIATELY
  maintenance_window: {
    type: "SYSTEM", # required, accepts SYSTEM, CUSTOM
    start_time_hour: 1,
    start_time_minute: 1,
    end_time_hour: 1,
    end_time_minute: 1,
    days_of_the_week: ["MONDAY"], # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
    apply_time_of: "UTC", # accepts UTC, DEVICE
  },
  software_set_update_mode: "USE_LATEST", # accepts USE_LATEST, USE_DESIRED
  desired_software_set_id: "SoftwareSetId",
  kms_key_arn: "KmsKeyArn",
  client_token: "ClientToken",
  tags: {
    "String" => "String",
  },
  device_creation_tags: {
    "DeviceCreationTagKey" => "DeviceCreationTagValue",
  },
})

Response structure


resp.environment.id #=> String
resp.environment.name #=> String
resp.environment.desktop_arn #=> String
resp.environment.desktop_endpoint #=> String
resp.environment.desktop_type #=> String, one of "workspaces", "appstream", "workspaces-web"
resp.environment.activation_code #=> String
resp.environment.software_set_update_schedule #=> String, one of "USE_MAINTENANCE_WINDOW", "APPLY_IMMEDIATELY"
resp.environment.maintenance_window.type #=> String, one of "SYSTEM", "CUSTOM"
resp.environment.maintenance_window.start_time_hour #=> Integer
resp.environment.maintenance_window.start_time_minute #=> Integer
resp.environment.maintenance_window.end_time_hour #=> Integer
resp.environment.maintenance_window.end_time_minute #=> Integer
resp.environment.maintenance_window.days_of_the_week #=> Array
resp.environment.maintenance_window.days_of_the_week[0] #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.environment.maintenance_window.apply_time_of #=> String, one of "UTC", "DEVICE"
resp.environment.software_set_update_mode #=> String, one of "USE_LATEST", "USE_DESIRED"
resp.environment.desired_software_set_id #=> String
resp.environment.pending_software_set_id #=> String
resp.environment.created_at #=> Time
resp.environment.updated_at #=> Time
resp.environment.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (String) —

    The name for the environment.

  • :desktop_arn (required, String) —

    The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.

  • :desktop_endpoint (String) —

    The URL for the identity provider login (only for environments that use AppStream 2.0).

  • :software_set_update_schedule (String) —

    An option to define if software updates should be applied within a maintenance window.

  • :maintenance_window (Types::MaintenanceWindow) —

    A specification for a time window to apply software updates.

  • :software_set_update_mode (String) —

    An option to define which software updates to apply.

  • :desired_software_set_id (String) —

    The ID of the software set to apply.

  • :kms_key_arn (String) —

    The Amazon Resource Name (ARN) of the Key Management Service key to use to encrypt the environment.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :tags (Hash<String,String>) —

    A map of the key-value pairs of the tag or tags to assign to the resource.

  • :device_creation_tags (Hash<String,String>) —

    A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.

Returns:

See Also:



86
 
# File 'sig/client.rbs', line 86

def create_environment: (

#delete_device(params = {}) ⇒ Struct

Deletes a thin client device.

Examples:

Request syntax with placeholder values


resp = client.delete_device({
  id: "DeviceId", # required
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the device to delete.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



105
 
# File 'sig/client.rbs', line 105

def delete_device: (

#delete_environment(params = {}) ⇒ Struct

Deletes an environment.

Examples:

Request syntax with placeholder values


resp = client.delete_environment({
  id: "EnvironmentId", # required
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the environment to delete.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



115
 
# File 'sig/client.rbs', line 115

def delete_environment: (

#deregister_device(params = {}) ⇒ Struct

Deregisters a thin client device.

Examples:

Request syntax with placeholder values


resp = client.deregister_device({
  id: "DeviceId", # required
  target_device_status: "DEREGISTERED", # accepts DEREGISTERED, ARCHIVED
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the device to deregister.

  • :target_device_status (String) —

    The desired new status for the device.

  • :client_token (String) —

    Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value.

    If you don't provide this value, then Amazon Web Services generates a random one for you.

    If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



125
 
# File 'sig/client.rbs', line 125

def deregister_device: (

#get_device(params = {}) ⇒ Types::GetDeviceResponse

Returns information for a thin client device.

Examples:

Request syntax with placeholder values


resp = client.get_device({
  id: "DeviceId", # required
})

Response structure


resp.device.id #=> String
resp.device.serial_number #=> String
resp.device.name #=> String
resp.device.model #=> String
resp.device.environment_id #=> String
resp.device.status #=> String, one of "REGISTERED", "DEREGISTERING", "DEREGISTERED", "ARCHIVED"
resp.device.current_software_set_id #=> String
resp.device.current_software_set_version #=> String
resp.device.desired_software_set_id #=> String
resp.device.pending_software_set_id #=> String
resp.device.pending_software_set_version #=> String
resp.device.software_set_update_schedule #=> String, one of "USE_MAINTENANCE_WINDOW", "APPLY_IMMEDIATELY"
resp.device.software_set_compliance_status #=> String, one of "NONE", "COMPLIANT", "NOT_COMPLIANT"
resp.device.software_set_update_status #=> String, one of "AVAILABLE", "IN_PROGRESS", "UP_TO_DATE"
resp.device.last_connected_at #=> Time
resp.device.last_posture_at #=> Time
resp.device.created_at #=> Time
resp.device.updated_at #=> Time
resp.device.arn #=> String
resp.device.kms_key_arn #=> String
resp.device.last_user_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the device for which to return information.

Returns:

See Also:



137
 
# File 'sig/client.rbs', line 137

def get_device: (

#get_environment(params = {}) ⇒ Types::GetEnvironmentResponse

Returns information for an environment.

Examples:

Request syntax with placeholder values


resp = client.get_environment({
  id: "EnvironmentId", # required
})

Response structure


resp.environment.id #=> String
resp.environment.name #=> String
resp.environment.desktop_arn #=> String
resp.environment.desktop_endpoint #=> String
resp.environment.desktop_type #=> String, one of "workspaces", "appstream", "workspaces-web"
resp.environment.activation_code #=> String
resp.environment.registered_devices_count #=> Integer
resp.environment.software_set_update_schedule #=> String, one of "USE_MAINTENANCE_WINDOW", "APPLY_IMMEDIATELY"
resp.environment.maintenance_window.type #=> String, one of "SYSTEM", "CUSTOM"
resp.environment.maintenance_window.start_time_hour #=> Integer
resp.environment.maintenance_window.start_time_minute #=> Integer
resp.environment.maintenance_window.end_time_hour #=> Integer
resp.environment.maintenance_window.end_time_minute #=> Integer
resp.environment.maintenance_window.days_of_the_week #=> Array
resp.environment.maintenance_window.days_of_the_week[0] #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.environment.maintenance_window.apply_time_of #=> String, one of "UTC", "DEVICE"
resp.environment.software_set_update_mode #=> String, one of "USE_LATEST", "USE_DESIRED"
resp.environment.desired_software_set_id #=> String
resp.environment.pending_software_set_id #=> String
resp.environment.pending_software_set_version #=> String
resp.environment.software_set_compliance_status #=> String, one of "NO_REGISTERED_DEVICES", "COMPLIANT", "NOT_COMPLIANT"
resp.environment.created_at #=> Time
resp.environment.updated_at #=> Time
resp.environment.arn #=> String
resp.environment.kms_key_arn #=> String
resp.environment.device_creation_tags #=> Hash
resp.environment.device_creation_tags["DeviceCreationTagKey"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the environment for which to return information.

Returns:

See Also:



147
 
# File 'sig/client.rbs', line 147

def get_environment: (

#get_software_set(params = {}) ⇒ Types::GetSoftwareSetResponse

Returns information for a software set.

Examples:

Request syntax with placeholder values


resp = client.get_software_set({
  id: "SoftwareSetId", # required
})

Response structure


resp.software_set.id #=> String
resp.software_set.version #=> String
resp.software_set.released_at #=> Time
resp.software_set.supported_until #=> Time
resp.software_set.validation_status #=> String, one of "VALIDATED", "NOT_VALIDATED"
resp.software_set.software #=> Array
resp.software_set.software[0].name #=> String
resp.software_set.software[0].version #=> String
resp.software_set.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the software set for which to return information.

Returns:

See Also:



157
 
# File 'sig/client.rbs', line 157

def get_software_set: (

#list_devices(params = {}) ⇒ Types::ListDevicesResponse

Returns a list of thin client devices.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.devices #=> Array
resp.devices[0].id #=> String
resp.devices[0].serial_number #=> String
resp.devices[0].name #=> String
resp.devices[0].model #=> String
resp.devices[0].environment_id #=> String
resp.devices[0].status #=> String, one of "REGISTERED", "DEREGISTERING", "DEREGISTERED", "ARCHIVED"
resp.devices[0].current_software_set_id #=> String
resp.devices[0].desired_software_set_id #=> String
resp.devices[0].pending_software_set_id #=> String
resp.devices[0].software_set_update_schedule #=> String, one of "USE_MAINTENANCE_WINDOW", "APPLY_IMMEDIATELY"
resp.devices[0].last_connected_at #=> Time
resp.devices[0].last_posture_at #=> Time
resp.devices[0].created_at #=> Time
resp.devices[0].updated_at #=> Time
resp.devices[0].arn #=> String
resp.devices[0].last_user_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • :max_results (Integer) —

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Returns:

See Also:



168
 
# File 'sig/client.rbs', line 168

def list_devices: (

#list_environments(params = {}) ⇒ Types::ListEnvironmentsResponse

Returns a list of environments.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.environments #=> Array
resp.environments[0].id #=> String
resp.environments[0].name #=> String
resp.environments[0].desktop_arn #=> String
resp.environments[0].desktop_endpoint #=> String
resp.environments[0].desktop_type #=> String, one of "workspaces", "appstream", "workspaces-web"
resp.environments[0].activation_code #=> String
resp.environments[0].software_set_update_schedule #=> String, one of "USE_MAINTENANCE_WINDOW", "APPLY_IMMEDIATELY"
resp.environments[0].maintenance_window.type #=> String, one of "SYSTEM", "CUSTOM"
resp.environments[0].maintenance_window.start_time_hour #=> Integer
resp.environments[0].maintenance_window.start_time_minute #=> Integer
resp.environments[0].maintenance_window.end_time_hour #=> Integer
resp.environments[0].maintenance_window.end_time_minute #=> Integer
resp.environments[0].maintenance_window.days_of_the_week #=> Array
resp.environments[0].maintenance_window.days_of_the_week[0] #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.environments[0].maintenance_window.apply_time_of #=> String, one of "UTC", "DEVICE"
resp.environments[0].software_set_update_mode #=> String, one of "USE_LATEST", "USE_DESIRED"
resp.environments[0].desired_software_set_id #=> String
resp.environments[0].pending_software_set_id #=> String
resp.environments[0].created_at #=> Time
resp.environments[0].updated_at #=> Time
resp.environments[0].arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • :max_results (Integer) —

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Returns:

See Also:



180
 
# File 'sig/client.rbs', line 180

def list_environments: (

#list_software_sets(params = {}) ⇒ Types::ListSoftwareSetsResponse

Returns a list of software sets.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp.software_sets #=> Array
resp.software_sets[0].id #=> String
resp.software_sets[0].version #=> String
resp.software_sets[0].released_at #=> Time
resp.software_sets[0].supported_until #=> Time
resp.software_sets[0].validation_status #=> String, one of "VALIDATED", "NOT_VALIDATED"
resp.software_sets[0].arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

  • :max_results (Integer) —

    The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results.

    This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.

Returns:

See Also:



192
 
# File 'sig/client.rbs', line 192

def list_software_sets: (

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns a list of tags for a resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "String", # required
})

Response structure


resp.tags #=> Hash
resp.tags["String"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.

Returns:

See Also:



203
 
# File 'sig/client.rbs', line 203

def list_tags_for_resource: (

#tag_resource(params = {}) ⇒ Struct

Assigns one or more tags (key-value pairs) to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "String", # required
  tags: { # required
    "String" => "String",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to tag.

  • :tags (required, Hash<String,String>) —

    A map of the key-value pairs of the tag or tags to assign to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



212
 
# File 'sig/client.rbs', line 212

def tag_resource: (

#untag_resource(params = {}) ⇒ Struct

Removes a tag or tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "String", # required
  tag_keys: ["String"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to untag.

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

    The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



222
 
# File 'sig/client.rbs', line 222

def untag_resource: (

#update_device(params = {}) ⇒ Types::UpdateDeviceResponse

Updates a thin client device.

Examples:

Request syntax with placeholder values


resp = client.update_device({
  id: "DeviceId", # required
  name: "DeviceName",
  desired_software_set_id: "SoftwareSetId",
  software_set_update_schedule: "USE_MAINTENANCE_WINDOW", # accepts USE_MAINTENANCE_WINDOW, APPLY_IMMEDIATELY
})

Response structure


resp.device.id #=> String
resp.device.serial_number #=> String
resp.device.name #=> String
resp.device.model #=> String
resp.device.environment_id #=> String
resp.device.status #=> String, one of "REGISTERED", "DEREGISTERING", "DEREGISTERED", "ARCHIVED"
resp.device.current_software_set_id #=> String
resp.device.desired_software_set_id #=> String
resp.device.pending_software_set_id #=> String
resp.device.software_set_update_schedule #=> String, one of "USE_MAINTENANCE_WINDOW", "APPLY_IMMEDIATELY"
resp.device.last_connected_at #=> Time
resp.device.last_posture_at #=> Time
resp.device.created_at #=> Time
resp.device.updated_at #=> Time
resp.device.arn #=> String
resp.device.last_user_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the device to update.

  • :name (String) —

    The name of the device to update.

  • :desired_software_set_id (String) —

    The ID of the software set to apply.

  • :software_set_update_schedule (String) —

    An option to define if software updates should be applied within a maintenance window.

Returns:

See Also:



233
 
# File 'sig/client.rbs', line 233

def update_device: (

#update_environment(params = {}) ⇒ Types::UpdateEnvironmentResponse

Updates an environment.

Examples:

Request syntax with placeholder values


resp = client.update_environment({
  id: "EnvironmentId", # required
  name: "EnvironmentName",
  desktop_arn: "Arn",
  desktop_endpoint: "DesktopEndpoint",
  software_set_update_schedule: "USE_MAINTENANCE_WINDOW", # accepts USE_MAINTENANCE_WINDOW, APPLY_IMMEDIATELY
  maintenance_window: {
    type: "SYSTEM", # required, accepts SYSTEM, CUSTOM
    start_time_hour: 1,
    start_time_minute: 1,
    end_time_hour: 1,
    end_time_minute: 1,
    days_of_the_week: ["MONDAY"], # accepts MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY
    apply_time_of: "UTC", # accepts UTC, DEVICE
  },
  software_set_update_mode: "USE_LATEST", # accepts USE_LATEST, USE_DESIRED
  desired_software_set_id: "SoftwareSetIdOrEmptyString",
  device_creation_tags: {
    "DeviceCreationTagKey" => "DeviceCreationTagValue",
  },
})

Response structure


resp.environment.id #=> String
resp.environment.name #=> String
resp.environment.desktop_arn #=> String
resp.environment.desktop_endpoint #=> String
resp.environment.desktop_type #=> String, one of "workspaces", "appstream", "workspaces-web"
resp.environment.activation_code #=> String
resp.environment.software_set_update_schedule #=> String, one of "USE_MAINTENANCE_WINDOW", "APPLY_IMMEDIATELY"
resp.environment.maintenance_window.type #=> String, one of "SYSTEM", "CUSTOM"
resp.environment.maintenance_window.start_time_hour #=> Integer
resp.environment.maintenance_window.start_time_minute #=> Integer
resp.environment.maintenance_window.end_time_hour #=> Integer
resp.environment.maintenance_window.end_time_minute #=> Integer
resp.environment.maintenance_window.days_of_the_week #=> Array
resp.environment.maintenance_window.days_of_the_week[0] #=> String, one of "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"
resp.environment.maintenance_window.apply_time_of #=> String, one of "UTC", "DEVICE"
resp.environment.software_set_update_mode #=> String, one of "USE_LATEST", "USE_DESIRED"
resp.environment.desired_software_set_id #=> String
resp.environment.pending_software_set_id #=> String
resp.environment.created_at #=> Time
resp.environment.updated_at #=> Time
resp.environment.arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the environment to update.

  • :name (String) —

    The name of the environment to update.

  • :desktop_arn (String) —

    The Amazon Resource Name (ARN) of the desktop to stream from Amazon WorkSpaces, WorkSpaces Secure Browser, or AppStream 2.0.

  • :desktop_endpoint (String) —

    The URL for the identity provider login (only for environments that use AppStream 2.0).

  • :software_set_update_schedule (String) —

    An option to define if software updates should be applied within a maintenance window.

  • :maintenance_window (Types::MaintenanceWindow) —

    A specification for a time window to apply software updates.

  • :software_set_update_mode (String) —

    An option to define which software updates to apply.

  • :desired_software_set_id (String) —

    The ID of the software set to apply.

  • :device_creation_tags (Hash<String,String>) —

    A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.

Returns:

See Also:



246
 
# File 'sig/client.rbs', line 246

def update_environment: (

#update_software_set(params = {}) ⇒ Struct

Updates a software set.

Examples:

Request syntax with placeholder values


resp = client.update_software_set({
  id: "SoftwareSetId", # required
  validation_status: "VALIDATED", # required, accepts VALIDATED, NOT_VALIDATED
})

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the software set to update.

  • :validation_status (required, String) —

    An option to define if the software set has been validated.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



263
 
# File 'sig/client.rbs', line 263

def update_software_set: (

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


1343
1344
1345
 
# File 'lib/aws-sdk-workspacesthinclient/client.rb', line 1343

def waiter_names
  []
end