Class: Aws::WorkSpacesWeb::Client

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

Overview

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

client = Aws::WorkSpacesWeb::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: _AssociateBrowserSettingsResponseSuccess, _AssociateDataProtectionSettingsResponseSuccess, _AssociateIpAccessSettingsResponseSuccess, _AssociateNetworkSettingsResponseSuccess, _AssociateSessionLoggerResponseSuccess, _AssociateTrustStoreResponseSuccess, _AssociateUserAccessLoggingSettingsResponseSuccess, _AssociateUserSettingsResponseSuccess, _CreateBrowserSettingsResponseSuccess, _CreateDataProtectionSettingsResponseSuccess, _CreateIdentityProviderResponseSuccess, _CreateIpAccessSettingsResponseSuccess, _CreateNetworkSettingsResponseSuccess, _CreatePortalResponseSuccess, _CreateSessionLoggerResponseSuccess, _CreateTrustStoreResponseSuccess, _CreateUserAccessLoggingSettingsResponseSuccess, _CreateUserSettingsResponseSuccess, _DeleteBrowserSettingsResponseSuccess, _DeleteDataProtectionSettingsResponseSuccess, _DeleteIdentityProviderResponseSuccess, _DeleteIpAccessSettingsResponseSuccess, _DeleteNetworkSettingsResponseSuccess, _DeletePortalResponseSuccess, _DeleteSessionLoggerResponseSuccess, _DeleteTrustStoreResponseSuccess, _DeleteUserAccessLoggingSettingsResponseSuccess, _DeleteUserSettingsResponseSuccess, _DisassociateBrowserSettingsResponseSuccess, _DisassociateDataProtectionSettingsResponseSuccess, _DisassociateIpAccessSettingsResponseSuccess, _DisassociateNetworkSettingsResponseSuccess, _DisassociateSessionLoggerResponseSuccess, _DisassociateTrustStoreResponseSuccess, _DisassociateUserAccessLoggingSettingsResponseSuccess, _DisassociateUserSettingsResponseSuccess, _ExpireSessionResponseSuccess, _GetBrowserSettingsResponseSuccess, _GetDataProtectionSettingsResponseSuccess, _GetIdentityProviderResponseSuccess, _GetIpAccessSettingsResponseSuccess, _GetNetworkSettingsResponseSuccess, _GetPortalResponseSuccess, _GetPortalServiceProviderMetadataResponseSuccess, _GetSessionLoggerResponseSuccess, _GetSessionResponseSuccess, _GetTrustStoreCertificateResponseSuccess, _GetTrustStoreResponseSuccess, _GetUserAccessLoggingSettingsResponseSuccess, _GetUserSettingsResponseSuccess, _ListBrowserSettingsResponseSuccess, _ListDataProtectionSettingsResponseSuccess, _ListIdentityProvidersResponseSuccess, _ListIpAccessSettingsResponseSuccess, _ListNetworkSettingsResponseSuccess, _ListPortalsResponseSuccess, _ListSessionLoggersResponseSuccess, _ListSessionsResponseSuccess, _ListTagsForResourceResponseSuccess, _ListTrustStoreCertificatesResponseSuccess, _ListTrustStoresResponseSuccess, _ListUserAccessLoggingSettingsResponseSuccess, _ListUserSettingsResponseSuccess, _TagResourceResponseSuccess, _UntagResourceResponseSuccess, _UpdateBrowserSettingsResponseSuccess, _UpdateDataProtectionSettingsResponseSuccess, _UpdateIdentityProviderResponseSuccess, _UpdateIpAccessSettingsResponseSuccess, _UpdateNetworkSettingsResponseSuccess, _UpdatePortalResponseSuccess, _UpdateSessionLoggerResponseSuccess, _UpdateTrustStoreResponseSuccess, _UpdateUserAccessLoggingSettingsResponseSuccess, _UpdateUserSettingsResponseSuccess

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::WorkSpacesWeb::EndpointProvider) —

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



4539
4540
4541
 
# File 'lib/aws-sdk-workspacesweb/client.rb', line 4539

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. 



4542
4543
4544
 
# File 'lib/aws-sdk-workspacesweb/client.rb', line 4542

def errors_module
  Errors
end

.new ⇒ Object

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



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

def self.new: (

Instance Method Details

#associate_browser_settings(params = {}) ⇒ Types::AssociateBrowserSettingsResponse

Associates a browser settings resource with a web portal.

Examples:

Request syntax with placeholder values


resp = client.associate_browser_settings({
  portal_arn: "ARN", # required
  browser_settings_arn: "ARN", # required
})

Response structure


resp.portal_arn #=> String
resp.browser_settings_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

  • :browser_settings_arn (required, String) —

    The ARN of the browser settings.

Returns:

See Also:



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

def associate_browser_settings: (

#associate_data_protection_settings(params = {}) ⇒ Types::AssociateDataProtectionSettingsResponse

Associates a data protection settings resource with a web portal.

Examples:

Request syntax with placeholder values


resp = client.associate_data_protection_settings({
  portal_arn: "ARN", # required
  data_protection_settings_arn: "ARN", # required
})

Response structure


resp.portal_arn #=> String
resp.data_protection_settings_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

  • :data_protection_settings_arn (required, String) —

    The ARN of the data protection settings.

Returns:

See Also:



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

def associate_data_protection_settings: (

#associate_ip_access_settings(params = {}) ⇒ Types::AssociateIpAccessSettingsResponse

Associates an IP access settings resource with a web portal.

Examples:

Request syntax with placeholder values


resp = client.associate_ip_access_settings({
  portal_arn: "ARN", # required
  ip_access_settings_arn: "ARN", # required
})

Response structure


resp.portal_arn #=> String
resp.ip_access_settings_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

  • :ip_access_settings_arn (required, String) —

    The ARN of the IP access settings.

Returns:

See Also:



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

def associate_ip_access_settings: (

#associate_network_settings(params = {}) ⇒ Types::AssociateNetworkSettingsResponse

Associates a network settings resource with a web portal.

Examples:

Request syntax with placeholder values


resp = client.associate_network_settings({
  portal_arn: "ARN", # required
  network_settings_arn: "ARN", # required
})

Response structure


resp.portal_arn #=> String
resp.network_settings_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

  • :network_settings_arn (required, String) —

    The ARN of the network settings.

Returns:

See Also:



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

def associate_network_settings: (

#associate_session_logger(params = {}) ⇒ Types::AssociateSessionLoggerResponse

Associates a session logger with a portal.

Examples:

Example: Associate Session Logger with Portal


# Associates a session logger with a portal

resp = client.associate_session_logger({
  portal_arn: "arn:aws:workspaces-web:us-west-2:123456789012:portal/12345678-1234-1234-1234-123456789012", 
  session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/11111111-1111-1111-1111-111111111111", 
})

resp.to_h outputs the following:
{
  portal_arn: "arn:aws:workspaces-web:us-west-2:123456789012:portal/12345678-1234-1234-1234-123456789012", 
  session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/11111111-1111-1111-1111-111111111111", 
}

Request syntax with placeholder values


resp = client.associate_session_logger({
  portal_arn: "ARN", # required
  session_logger_arn: "ARN", # required
})

Response structure


resp.portal_arn #=> String
resp.session_logger_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the portal to associate to the session logger ARN.

  • :session_logger_arn (required, String) —

    The ARN of the session logger to associate to the portal ARN.

Returns:

See Also:



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

def associate_session_logger: (

#associate_trust_store(params = {}) ⇒ Types::AssociateTrustStoreResponse

Associates a trust store with a web portal.

Examples:

Request syntax with placeholder values


resp = client.associate_trust_store({
  portal_arn: "ARN", # required
  trust_store_arn: "ARN", # required
})

Response structure


resp.portal_arn #=> String
resp.trust_store_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

  • :trust_store_arn (required, String) —

    The ARN of the trust store.

Returns:

See Also:



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

def associate_trust_store: (

#associate_user_access_logging_settings(params = {}) ⇒ Types::AssociateUserAccessLoggingSettingsResponse

Associates a user access logging settings resource with a web portal.

Examples:

Request syntax with placeholder values


resp = client.associate_user_access_logging_settings({
  portal_arn: "ARN", # required
  user_access_logging_settings_arn: "ARN", # required
})

Response structure


resp.portal_arn #=> String
resp.user_access_logging_settings_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

  • :user_access_logging_settings_arn (required, String) —

    The ARN of the user access logging settings.

Returns:

See Also:



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

def associate_user_access_logging_settings: (

#associate_user_settings(params = {}) ⇒ Types::AssociateUserSettingsResponse

Associates a user settings resource with a web portal.

Examples:

Request syntax with placeholder values


resp = client.({
  portal_arn: "ARN", # required
  user_settings_arn: "ARN", # required
})

Response structure


resp.portal_arn #=> String
resp. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

  • :user_settings_arn (required, String) —

    The ARN of the user settings.

Returns:

See Also:



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

def associate_user_settings: (

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


4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
 
# File 'lib/aws-sdk-workspacesweb/client.rb', line 4512

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

#create_browser_settings(params = {}) ⇒ Types::CreateBrowserSettingsResponse

Creates a browser settings resource that can be associated with a web portal. Once associated with a web portal, browser settings control how the browser will behave once a user starts a streaming session for the web portal.

Examples:

Request syntax with placeholder values


resp = client.create_browser_settings({
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  customer_managed_key: "keyArn",
  additional_encryption_context: {
    "StringType" => "StringType",
  },
  browser_policy: "BrowserPolicy",
  client_token: "ClientToken",
  web_content_filtering_policy: {
    blocked_categories: ["Cults"], # accepts Cults, Gambling, Nudity, Pornography, SexEducation, Tasteless, Violence, DownloadSites, ImageSharing, PeerToPeer, StreamingMediaAndDownloads, GenerativeAI, CriminalActivity, Hacking, HateAndIntolerance, IllegalDrug, IllegalSoftware, SchoolCheating, SelfHarm, Weapons, Chat, Games, InstantMessaging, ProfessionalNetwork, SocialNetworking, WebBasedEmail, ParkedDomains
    allowed_urls: ["UrlPattern"],
    blocked_urls: ["UrlPattern"],
  },
})

Response structure


resp.browser_settings_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    The tags to add to the browser settings resource. A tag is a key-value pair.

  • :customer_managed_key (String) —

    The custom managed key of the browser settings.

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

    Additional encryption context of the browser settings.

  • :browser_policy (String) —

    A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

  • :web_content_filtering_policy (Types::WebContentFilteringPolicy) —

    The policy that specifies which URLs end users are allowed to access or which URLs or domain categories they are restricted from accessing for enhanced security.

Returns:

See Also:



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

def create_browser_settings: (

#create_data_protection_settings(params = {}) ⇒ Types::CreateDataProtectionSettingsResponse

Creates a data protection settings resource that can be associated with a web portal.

Examples:

Request syntax with placeholder values


resp = client.create_data_protection_settings({
  display_name: "DisplayNameSafe",
  description: "DescriptionSafe",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  customer_managed_key: "keyArn",
  additional_encryption_context: {
    "StringType" => "StringType",
  },
  inline_redaction_configuration: {
    inline_redaction_patterns: [ # required
      {
        built_in_pattern_id: "BuiltInPatternId",
        custom_pattern: {
          pattern_name: "PatternName", # required
          pattern_regex: "Regex", # required
          pattern_description: "DescriptionSafe",
          keyword_regex: "Regex",
        },
        redaction_place_holder: { # required
          redaction_place_holder_type: "CustomText", # required, accepts CustomText
          redaction_place_holder_text: "RedactionPlaceHolderText",
        },
        enforced_urls: ["InlineRedactionUrl"],
        exempt_urls: ["InlineRedactionUrl"],
        confidence_level: 1,
      },
    ],
    global_enforced_urls: ["InlineRedactionUrl"],
    global_exempt_urls: ["InlineRedactionUrl"],
    global_confidence_level: 1,
  },
  client_token: "ClientToken",
})

Response structure


resp.data_protection_settings_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :display_name (String) —

    The display name of the data protection settings.

  • :description (String) —

    The description of the data protection settings.

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

    The tags to add to the data protection settings resource. A tag is a key-value pair.

  • :customer_managed_key (String) —

    The custom managed key of the data protection settings.

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

    Additional encryption context of the data protection settings.

  • :inline_redaction_configuration (Types::InlineRedactionConfiguration) —

    The inline redaction configuration of the data protection settings that will be applied to all sessions.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

Returns:

See Also:



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

def create_data_protection_settings: (

#create_identity_provider(params = {}) ⇒ Types::CreateIdentityProviderResponse

Creates an identity provider resource that is then associated with a web portal.

Examples:

Request syntax with placeholder values


resp = client.create_identity_provider({
  portal_arn: "ARN", # required
  identity_provider_name: "IdentityProviderName", # required
  identity_provider_type: "SAML", # required, accepts SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
  identity_provider_details: { # required
    "StringType" => "StringType",
  },
  client_token: "ClientToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.identity_provider_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

  • :identity_provider_name (required, String) —

    The identity provider name.

  • :identity_provider_type (required, String) —

    The identity provider type.

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

    The identity provider details. The following list describes the provider detail keys for each identity provider type.

    • For Google and Login with Amazon:

    • client_id

    • client_secret

    • authorize_scopes

    • For Facebook:

    • client_id

    • client_secret

    • authorize_scopes

    • api_version

    • For Sign in with Apple:

    • client_id

    • team_id

    • key_id

    • private_key

    • authorize_scopes

    • For OIDC providers:

    • client_id

    • client_secret

    • attributes_request_method

    • oidc_issuer

    • authorize_scopes

    • authorize_url if not available from discovery URL specified by oidc_issuer key

    • token_url if not available from discovery URL specified by oidc_issuer key

    • attributes_url if not available from discovery URL specified by oidc_issuer key

    • jwks_uri if not available from discovery URL specified by oidc_issuer key

    • For SAML providers:

    • MetadataFile OR MetadataURL

    • IDPSignout (boolean) optional

    • IDPInit (boolean) optional

    • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

    • EncryptedResponses (boolean) optional

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

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

    The tags to add to the identity provider resource. A tag is a key-value pair.

Returns:

See Also:



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

def create_identity_provider: (

#create_ip_access_settings(params = {}) ⇒ Types::CreateIpAccessSettingsResponse

Creates an IP access settings resource that can be associated with a web portal.

Examples:

Request syntax with placeholder values


resp = client.create_ip_access_settings({
  display_name: "DisplayName",
  description: "Description",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  customer_managed_key: "keyArn",
  additional_encryption_context: {
    "StringType" => "StringType",
  },
  ip_rules: [ # required
    {
      ip_range: "IpRange", # required
      description: "Description",
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.ip_access_settings_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :display_name (String) —

    The display name of the IP access settings.

  • :description (String) —

    The description of the IP access settings.

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

    The tags to add to the IP access settings resource. A tag is a key-value pair.

  • :customer_managed_key (String) —

    The custom managed key of the IP access settings.

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

    Additional encryption context of the IP access settings.

  • :ip_rules (required, Array<Types::IpRule>) —

    The IP rules of the IP access settings.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

Returns:

See Also:



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

def create_ip_access_settings: (

#create_network_settings(params = {}) ⇒ Types::CreateNetworkSettingsResponse

Creates a network settings resource that can be associated with a web portal. Once associated with a web portal, network settings define how streaming instances will connect with your specified VPC.

Examples:

Request syntax with placeholder values


resp = client.create_network_settings({
  vpc_id: "VpcId", # required
  subnet_ids: ["SubnetId"], # required
  security_group_ids: ["SecurityGroupId"], # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.network_settings_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :vpc_id (required, String) —

    The VPC that streaming instances will connect to.

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

    The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

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

    One or more security groups used to control access from streaming instances to your VPC.

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

    The tags to add to the network settings resource. A tag is a key-value pair.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

Returns:

See Also:



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

def create_network_settings: (

#create_portal(params = {}) ⇒ Types::CreatePortalResponse

Creates a web portal.

Examples:

Request syntax with placeholder values


resp = client.create_portal({
  display_name: "DisplayName",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  customer_managed_key: "keyArn",
  additional_encryption_context: {
    "StringType" => "StringType",
  },
  client_token: "ClientToken",
  authentication_type: "Standard", # accepts Standard, IAM_Identity_Center
  instance_type: "standard.regular", # accepts standard.regular, standard.large, standard.xlarge
  max_concurrent_sessions: 1,
  portal_custom_domain: "PortalCustomDomain",
})

Response structure


resp.portal_arn #=> String
resp.portal_endpoint #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :display_name (String) —

    The name of the web portal. This is not visible to users who log into the web portal.

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

    The tags to add to the web portal. A tag is a key-value pair.

  • :customer_managed_key (String) —

    The customer managed key of the web portal.

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

    The additional encryption context of the portal.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

  • :authentication_type (String) —

    The type of authentication integration points used when signing into the web portal. Defaults to Standard.

    Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

    IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

  • :instance_type (String) —

    The type and resources of the underlying instance.

  • :max_concurrent_sessions (Integer) —

    The maximum number of concurrent sessions for the portal.

  • :portal_custom_domain (String) —

    The custom domain of the web portal that users access in order to start streaming sessions.

Returns:

See Also:



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

def create_portal: (

#create_session_logger(params = {}) ⇒ Types::CreateSessionLoggerResponse

Creates a session logger.

Examples:

Example: Create Session Logger with All Events


# Creates a session logger that captures all events and stores them in S3 with JSON format and flat folder structure

resp = client.create_session_logger({
  display_name: "Session Logger with All Events", 
  event_filter: {
    all: {
    }, 
  }, 
  log_configuration: {
    s3: {
      bucket: "my-session-logs-bucket", 
      bucket_owner: "123456789012", 
      folder_structure: "Flat", 
      key_prefix: "session-logs/all/events", 
      log_file_format: "Json", 
    }, 
  }, 
})

resp.to_h outputs the following:
{
  session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012", 
}

Example: Create Session Logger with Specific Events


# Creates a session logger that captures only specific events with JSONLines format and nested folder structure

resp = client.create_session_logger({
  additional_encryption_context: {
    "EncryptionContextKey" => "EncryptionContextValue", 
  }, 
  customer_managed_key: "arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012", 
  display_name: "Session Logger with Each Events", 
  event_filter: {
    include: [
      "SessionStart", 
      "SessionEnd", 
      "UrlLoad", 
      "WebsiteInteract", 
    ], 
  }, 
  log_configuration: {
    s3: {
      bucket: "my-session-logs-bucket", 
      bucket_owner: "123456789012", 
      folder_structure: "NestedByDate", 
      key_prefix: "session-logs/each/event", 
      log_file_format: "JSONLines", 
    }, 
  }, 
  tags: [
    {
      key: "KEY-1", 
      value: "VALUE-1", 
    }, 
    {
      key: "KEY-2", 
      value: "VALUE-2", 
    }, 
  ], 
})

resp.to_h outputs the following:
{
  session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321", 
}

Request syntax with placeholder values


resp = client.create_session_logger({
  event_filter: { # required
    all: {
    },
    include: ["WebsiteInteract"], # accepts WebsiteInteract, FileDownloadFromSecureBrowserToRemoteDisk, FileTransferFromRemoteToLocalDisk, FileTransferFromLocalToRemoteDisk, FileUploadFromRemoteDiskToSecureBrowser, ContentPasteToWebsite, ContentTransferFromLocalToRemoteClipboard, ContentCopyFromWebsite, UrlLoad, TabOpen, TabClose, PrintJobSubmit, SessionConnect, SessionStart, SessionDisconnect, SessionEnd, UrlBlockByContentFilter
  },
  log_configuration: { # required
    s3: {
      bucket: "S3Bucket", # required
      key_prefix: "S3KeyPrefix",
      bucket_owner: "S3BucketOwner",
      log_file_format: "JSONLines", # required, accepts JSONLines, Json
      folder_structure: "Flat", # required, accepts Flat, NestedByDate
    },
  },
  display_name: "DisplayNameSafe",
  customer_managed_key: "keyArn",
  additional_encryption_context: {
    "StringType" => "StringType",
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.session_logger_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :event_filter (required, Types::EventFilter) —

    The filter that specifies the events to monitor.

  • :log_configuration (required, Types::LogConfiguration) —

    The configuration that specifies where logs are delivered.

  • :display_name (String) —

    The human-readable display name for the session logger resource.

  • :customer_managed_key (String) —

    The custom managed key of the session logger.

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

    The additional encryption context of the session logger.

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

    The tags to add to the session logger.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request. If you do not specify a client token, one is automatically generated by the AWS SDK.

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

Returns:

See Also:



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

def create_session_logger: (

#create_trust_store(params = {}) ⇒ Types::CreateTrustStoreResponse

Creates a trust store that can be associated with a web portal. A trust store contains certificate authority (CA) certificates. Once associated with a web portal, the browser in a streaming session will recognize certificates that have been issued using any of the CAs in the trust store. If your organization has internal websites that use certificates issued by private CAs, you should add the private CA certificate to the trust store.

Examples:

Request syntax with placeholder values


resp = client.create_trust_store({
  certificate_list: ["data"], # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.trust_store_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :certificate_list (required, Array<String, StringIO, File>) —

    A list of CA certificates to be added to the trust store.

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

    The tags to add to the trust store. A tag is a key-value pair.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

Returns:

See Also:



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

def create_trust_store: (

#create_user_access_logging_settings(params = {}) ⇒ Types::CreateUserAccessLoggingSettingsResponse

Creates a user access logging settings resource that can be associated with a web portal.

Examples:

Request syntax with placeholder values


resp = client.create_user_access_logging_settings({
  kinesis_stream_arn: "KinesisStreamArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.user_access_logging_settings_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :kinesis_stream_arn (required, String) —

    The ARN of the Kinesis stream.

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

    The tags to add to the user settings resource. A tag is a key-value pair.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

Returns:

See Also:



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

def create_user_access_logging_settings: (

#create_user_settings(params = {}) ⇒ Types::CreateUserSettingsResponse

Creates a user settings resource that can be associated with a web portal. Once associated with a web portal, user settings control how users can transfer data between a streaming session and the their local devices.

Examples:

Request syntax with placeholder values


resp = client.({
  copy_allowed: "Disabled", # required, accepts Disabled, Enabled
  paste_allowed: "Disabled", # required, accepts Disabled, Enabled
  download_allowed: "Disabled", # required, accepts Disabled, Enabled
  upload_allowed: "Disabled", # required, accepts Disabled, Enabled
  print_allowed: "Disabled", # required, accepts Disabled, Enabled
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  disconnect_timeout_in_minutes: 1,
  idle_disconnect_timeout_in_minutes: 1,
  client_token: "ClientToken",
  cookie_synchronization_configuration: {
    allowlist: [ # required
      {
        domain: "CookieDomain", # required
        name: "CookieName",
        path: "CookiePath",
      },
    ],
    blocklist: [
      {
        domain: "CookieDomain", # required
        name: "CookieName",
        path: "CookiePath",
      },
    ],
  },
  customer_managed_key: "keyArn",
  additional_encryption_context: {
    "StringType" => "StringType",
  },
  deep_link_allowed: "Disabled", # accepts Disabled, Enabled
  toolbar_configuration: {
    toolbar_type: "Floating", # accepts Floating, Docked
    visual_mode: "Dark", # accepts Dark, Light
    hidden_toolbar_items: ["Windows"], # accepts Windows, DualMonitor, FullScreen, Webcam, Microphone
    max_display_resolution: "size4096X2160", # accepts size4096X2160, size3840X2160, size3440X1440, size2560X1440, size1920X1080, size1280X720, size1024X768, size800X600
  },
  branding_configuration_input: {
    logo: { # required
      blob: "data",
      s3_uri: "S3Uri",
    },
    wallpaper: {
      blob: "data",
      s3_uri: "S3Uri",
    },
    favicon: { # required
      blob: "data",
      s3_uri: "S3Uri",
    },
    localized_strings: { # required
      "de-DE" => {
        browser_tab_title: "LocalizedBrandingStringsBrowserTabTitleString", # required
        welcome_text: "LocalizedBrandingStringsWelcomeTextString", # required
        login_title: "LocalizedBrandingStringsLoginTitleString",
        login_description: "LocalizedBrandingStringsLoginDescriptionString",
        login_button_text: "LocalizedBrandingStringsLoginButtonTextString",
        contact_link: "ContactLinkUrl",
        contact_button_text: "LocalizedBrandingStringsContactButtonTextString",
        loading_text: "LocalizedBrandingStringsLoadingTextString",
      },
    },
    color_theme: "Light", # required, accepts Light, Dark
    terms_of_service: "Markdown",
  },
  web_authn_allowed: "Disabled", # accepts Disabled, Enabled
})

Response structure


resp. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :copy_allowed (required, String) —

    Specifies whether the user can copy text from the streaming session to the local device.

  • :paste_allowed (required, String) —

    Specifies whether the user can paste text from the local device to the streaming session.

  • :download_allowed (required, String) —

    Specifies whether the user can download files from the streaming session to the local device.

  • :upload_allowed (required, String) —

    Specifies whether the user can upload files from the local device to the streaming session.

  • :print_allowed (required, String) —

    Specifies whether the user can print to the local device.

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

    The tags to add to the user settings resource. A tag is a key-value pair.

  • :disconnect_timeout_in_minutes (Integer) —

    The amount of time that a streaming session remains active after users disconnect.

  • :idle_disconnect_timeout_in_minutes (Integer) —

    The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

  • :cookie_synchronization_configuration (Types::CookieSynchronizationConfiguration) —

    The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

  • :customer_managed_key (String) —

    The customer managed key used to encrypt sensitive information in the user settings.

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

    The additional encryption context of the user settings.

  • :deep_link_allowed (String) —

    Specifies whether the user can use deep links that open automatically when connecting to a session.

  • :toolbar_configuration (Types::ToolbarConfiguration) —

    The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.

  • :branding_configuration_input (Types::BrandingConfigurationCreateInput) —

    The branding configuration input that customizes the appearance of the web portal for end users. This includes a custom logo, favicon, localized strings, color theme, and optionally a wallpaper and terms of service.

  • :web_authn_allowed (String) —

    Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.

Returns:

See Also:



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

def create_user_settings: (

#delete_browser_settings(params = {}) ⇒ Struct

Deletes browser settings.

Examples:

Request syntax with placeholder values


resp = client.delete_browser_settings({
  browser_settings_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :browser_settings_arn (required, String) —

    The ARN of the browser settings.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def delete_browser_settings: (

#delete_data_protection_settings(params = {}) ⇒ Struct

Deletes data protection settings.

Examples:

Request syntax with placeholder values


resp = client.delete_data_protection_settings({
  data_protection_settings_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :data_protection_settings_arn (required, String) —

    The ARN of the data protection settings.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def delete_data_protection_settings: (

#delete_identity_provider(params = {}) ⇒ Struct

Deletes the identity provider.

Examples:

Request syntax with placeholder values


resp = client.delete_identity_provider({
  identity_provider_arn: "SubresourceARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :identity_provider_arn (required, String) —

    The ARN of the identity provider.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def delete_identity_provider: (

#delete_ip_access_settings(params = {}) ⇒ Struct

Deletes IP access settings.

Examples:

Request syntax with placeholder values


resp = client.delete_ip_access_settings({
  ip_access_settings_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :ip_access_settings_arn (required, String) —

    The ARN of the IP access settings.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def delete_ip_access_settings: (

#delete_network_settings(params = {}) ⇒ Struct

Deletes network settings.

Examples:

Request syntax with placeholder values


resp = client.delete_network_settings({
  network_settings_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :network_settings_arn (required, String) —

    The ARN of the network settings.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def delete_network_settings: (

#delete_portal(params = {}) ⇒ Struct

Deletes a web portal.

Examples:

Request syntax with placeholder values


resp = client.delete_portal({
  portal_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def delete_portal: (

#delete_session_logger(params = {}) ⇒ Struct

Deletes a session logger resource.

Examples:

Example: Delete Session Logger


# Deletes a session logger resource

resp = client.delete_session_logger({
  session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.delete_session_logger({
  session_logger_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :session_logger_arn (required, String) —

    The ARN of the session logger.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def delete_session_logger: (

#delete_trust_store(params = {}) ⇒ Struct

Deletes the trust store.

Examples:

Request syntax with placeholder values


resp = client.delete_trust_store({
  trust_store_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :trust_store_arn (required, String) —

    The ARN of the trust store.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def delete_trust_store: (

#delete_user_access_logging_settings(params = {}) ⇒ Struct

Deletes user access logging settings.

Examples:

Request syntax with placeholder values


resp = client.delete_user_access_logging_settings({
  user_access_logging_settings_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :user_access_logging_settings_arn (required, String) —

    The ARN of the user access logging settings.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def delete_user_access_logging_settings: (

#delete_user_settings(params = {}) ⇒ Struct

Deletes user settings.

Examples:

Request syntax with placeholder values


resp = client.({
  user_settings_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :user_settings_arn (required, String) —

    The ARN of the user settings.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def delete_user_settings: (

#disassociate_browser_settings(params = {}) ⇒ Struct

Disassociates browser settings from a web portal.

Examples:

Request syntax with placeholder values


resp = client.disassociate_browser_settings({
  portal_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def disassociate_browser_settings: (

#disassociate_data_protection_settings(params = {}) ⇒ Struct

Disassociates data protection settings from a web portal.

Examples:

Request syntax with placeholder values


resp = client.disassociate_data_protection_settings({
  portal_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def disassociate_data_protection_settings: (

#disassociate_ip_access_settings(params = {}) ⇒ Struct

Disassociates IP access settings from a web portal.

Examples:

Request syntax with placeholder values


resp = client.disassociate_ip_access_settings({
  portal_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def disassociate_ip_access_settings: (

#disassociate_network_settings(params = {}) ⇒ Struct

Disassociates network settings from a web portal.

Examples:

Request syntax with placeholder values


resp = client.disassociate_network_settings({
  portal_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def disassociate_network_settings: (

#disassociate_session_logger(params = {}) ⇒ Struct

Disassociates a session logger from a portal.

Examples:

Example: Disassociate Session Logger from Portal


# Removes the association between a session logger and a portal

resp = client.disassociate_session_logger({
  portal_arn: "arn:aws:workspaces-web:us-west-2:123456789012:portal/12345678-1234-1234-1234-123456789012", 
})

resp.to_h outputs the following:
{
}

Request syntax with placeholder values


resp = client.disassociate_session_logger({
  portal_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the portal to disassociate from the a session logger.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def disassociate_session_logger: (

#disassociate_trust_store(params = {}) ⇒ Struct

Disassociates a trust store from a web portal.

Examples:

Request syntax with placeholder values


resp = client.disassociate_trust_store({
  portal_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def disassociate_trust_store: (

#disassociate_user_access_logging_settings(params = {}) ⇒ Struct

Disassociates user access logging settings from a web portal.

Examples:

Request syntax with placeholder values


resp = client.disassociate_user_access_logging_settings({
  portal_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def disassociate_user_access_logging_settings: (

#disassociate_user_settings(params = {}) ⇒ Struct

Disassociates user settings from a web portal.

Examples:

Request syntax with placeholder values


resp = client.({
  portal_arn: "ARN", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def disassociate_user_settings: (

#expire_session(params = {}) ⇒ Struct

Expires an active secure browser session.

Examples:

Request syntax with placeholder values


resp = client.expire_session({
  portal_id: "PortalId", # required
  session_id: "SessionId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :portal_id (required, String) —

    The ID of the web portal for the session.

  • :session_id (required, String) —

    The ID of the session to expire.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def expire_session: (

#get_browser_settings(params = {}) ⇒ Types::GetBrowserSettingsResponse

Gets browser settings.

Examples:

Request syntax with placeholder values


resp = client.get_browser_settings({
  browser_settings_arn: "ARN", # required
})

Response structure


resp.browser_settings.browser_settings_arn #=> String
resp.browser_settings.associated_portal_arns #=> Array
resp.browser_settings.associated_portal_arns[0] #=> String
resp.browser_settings.browser_policy #=> String
resp.browser_settings.customer_managed_key #=> String
resp.browser_settings.additional_encryption_context #=> Hash
resp.browser_settings.additional_encryption_context["StringType"] #=> String
resp.browser_settings.web_content_filtering_policy.blocked_categories #=> Array
resp.browser_settings.web_content_filtering_policy.blocked_categories[0] #=> String, one of "Cults", "Gambling", "Nudity", "Pornography", "SexEducation", "Tasteless", "Violence", "DownloadSites", "ImageSharing", "PeerToPeer", "StreamingMediaAndDownloads", "GenerativeAI", "CriminalActivity", "Hacking", "HateAndIntolerance", "IllegalDrug", "IllegalSoftware", "SchoolCheating", "SelfHarm", "Weapons", "Chat", "Games", "InstantMessaging", "ProfessionalNetwork", "SocialNetworking", "WebBasedEmail", "ParkedDomains"
resp.browser_settings.web_content_filtering_policy.allowed_urls #=> Array
resp.browser_settings.web_content_filtering_policy.allowed_urls[0] #=> String
resp.browser_settings.web_content_filtering_policy.blocked_urls #=> Array
resp.browser_settings.web_content_filtering_policy.blocked_urls[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :browser_settings_arn (required, String) —

    The ARN of the browser settings.

Returns:

See Also:



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

def get_browser_settings: (

#get_data_protection_settings(params = {}) ⇒ Types::GetDataProtectionSettingsResponse

Gets the data protection settings.

Examples:

Request syntax with placeholder values


resp = client.get_data_protection_settings({
  data_protection_settings_arn: "ARN", # required
})

Response structure


resp.data_protection_settings.data_protection_settings_arn #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns #=> Array
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].built_in_pattern_id #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].custom_pattern.pattern_name #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].custom_pattern.pattern_regex #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].custom_pattern.pattern_description #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].custom_pattern.keyword_regex #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].redaction_place_holder.redaction_place_holder_type #=> String, one of "CustomText"
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].redaction_place_holder.redaction_place_holder_text #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].enforced_urls #=> Array
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].enforced_urls[0] #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].exempt_urls #=> Array
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].exempt_urls[0] #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].confidence_level #=> Integer
resp.data_protection_settings.inline_redaction_configuration.global_enforced_urls #=> Array
resp.data_protection_settings.inline_redaction_configuration.global_enforced_urls[0] #=> String
resp.data_protection_settings.inline_redaction_configuration.global_exempt_urls #=> Array
resp.data_protection_settings.inline_redaction_configuration.global_exempt_urls[0] #=> String
resp.data_protection_settings.inline_redaction_configuration.global_confidence_level #=> Integer
resp.data_protection_settings.associated_portal_arns #=> Array
resp.data_protection_settings.associated_portal_arns[0] #=> String
resp.data_protection_settings.display_name #=> String
resp.data_protection_settings.description #=> String
resp.data_protection_settings.creation_date #=> Time
resp.data_protection_settings.customer_managed_key #=> String
resp.data_protection_settings.additional_encryption_context #=> Hash
resp.data_protection_settings.additional_encryption_context["StringType"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :data_protection_settings_arn (required, String) —

    The ARN of the data protection settings.

Returns:

See Also:



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

def get_data_protection_settings: (

#get_identity_provider(params = {}) ⇒ Types::GetIdentityProviderResponse

Gets the identity provider.

Examples:

Request syntax with placeholder values


resp = client.get_identity_provider({
  identity_provider_arn: "SubresourceARN", # required
})

Response structure


resp.identity_provider.identity_provider_arn #=> String
resp.identity_provider.identity_provider_name #=> String
resp.identity_provider.identity_provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"
resp.identity_provider.identity_provider_details #=> Hash
resp.identity_provider.identity_provider_details["StringType"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_provider_arn (required, String) —

    The ARN of the identity provider.

Returns:

See Also:



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

def get_identity_provider: (

#get_ip_access_settings(params = {}) ⇒ Types::GetIpAccessSettingsResponse

Gets the IP access settings.

Examples:

Request syntax with placeholder values


resp = client.get_ip_access_settings({
  ip_access_settings_arn: "ARN", # required
})

Response structure


resp.ip_access_settings.ip_access_settings_arn #=> String
resp.ip_access_settings.associated_portal_arns #=> Array
resp.ip_access_settings.associated_portal_arns[0] #=> String
resp.ip_access_settings.ip_rules #=> Array
resp.ip_access_settings.ip_rules[0].ip_range #=> String
resp.ip_access_settings.ip_rules[0].description #=> String
resp.ip_access_settings.display_name #=> String
resp.ip_access_settings.description #=> String
resp.ip_access_settings.creation_date #=> Time
resp.ip_access_settings.customer_managed_key #=> String
resp.ip_access_settings.additional_encryption_context #=> Hash
resp.ip_access_settings.additional_encryption_context["StringType"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :ip_access_settings_arn (required, String) —

    The ARN of the IP access settings.

Returns:

See Also:



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

def get_ip_access_settings: (

#get_network_settings(params = {}) ⇒ Types::GetNetworkSettingsResponse

Gets the network settings.

Examples:

Request syntax with placeholder values


resp = client.get_network_settings({
  network_settings_arn: "ARN", # required
})

Response structure


resp.network_settings.network_settings_arn #=> String
resp.network_settings.associated_portal_arns #=> Array
resp.network_settings.associated_portal_arns[0] #=> String
resp.network_settings.vpc_id #=> String
resp.network_settings.subnet_ids #=> Array
resp.network_settings.subnet_ids[0] #=> String
resp.network_settings.security_group_ids #=> Array
resp.network_settings.security_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :network_settings_arn (required, String) —

    The ARN of the network settings.

Returns:

See Also:



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

def get_network_settings: (

#get_portal(params = {}) ⇒ Types::GetPortalResponse

Gets the web portal.

Examples:

Request syntax with placeholder values


resp = client.get_portal({
  portal_arn: "ARN", # required
})

Response structure


resp.portal.portal_arn #=> String
resp.portal.renderer_type #=> String, one of "AppStream"
resp.portal.browser_type #=> String, one of "Chrome"
resp.portal.portal_status #=> String, one of "Incomplete", "Pending", "Active"
resp.portal.portal_endpoint #=> String
resp.portal.display_name #=> String
resp.portal.creation_date #=> Time
resp.portal.browser_settings_arn #=> String
resp.portal.data_protection_settings_arn #=> String
resp.portal. #=> String
resp.portal.network_settings_arn #=> String
resp.portal.session_logger_arn #=> String
resp.portal.trust_store_arn #=> String
resp.portal.status_reason #=> String
resp.portal.user_access_logging_settings_arn #=> String
resp.portal.authentication_type #=> String, one of "Standard", "IAM_Identity_Center"
resp.portal.ip_access_settings_arn #=> String
resp.portal.customer_managed_key #=> String
resp.portal.additional_encryption_context #=> Hash
resp.portal.additional_encryption_context["StringType"] #=> String
resp.portal.instance_type #=> String, one of "standard.regular", "standard.large", "standard.xlarge"
resp.portal.max_concurrent_sessions #=> Integer
resp.portal.portal_custom_domain #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

See Also:



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

def get_portal: (

#get_portal_service_provider_metadata(params = {}) ⇒ Types::GetPortalServiceProviderMetadataResponse

Gets the service provider metadata.

Examples:

Request syntax with placeholder values


resp = client.get_portal_service_provider_metadata({
  portal_arn: "ARN", # required
})

Response structure


resp.portal_arn #=> String
resp.service_provider_saml_metadata #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

See Also:



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

def get_portal_service_provider_metadata: (

#get_session(params = {}) ⇒ Types::GetSessionResponse

Gets information for a secure browser session.

Examples:

Request syntax with placeholder values


resp = client.get_session({
  portal_id: "PortalId", # required
  session_id: "SessionId", # required
})

Response structure


resp.session.portal_arn #=> String
resp.session.session_id #=> String
resp.session.username #=> String
resp.session.client_ip_addresses #=> Array
resp.session.client_ip_addresses[0] #=> String
resp.session.status #=> String, one of "Active", "Terminated"
resp.session.start_time #=> Time
resp.session.end_time #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :portal_id (required, String) —

    The ID of the web portal for the session.

  • :session_id (required, String) —

    The ID of the session.

Returns:

See Also:



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

def get_session: (

#get_session_logger(params = {}) ⇒ Types::GetSessionLoggerResponse

Gets details about a specific session logger resource.

Examples:

Example: Get Session Logger with All Events


# Retrieves a session logger configured for all events

resp = client.get_session_logger({
  session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012", 
})

resp.to_h outputs the following:
{
  session_logger: {
    associated_portal_arns: [
      "arn:aws:workspaces-web:us-west-2:123456789012:portal/87654321-4321-4321-4321-210987654321", 
    ], 
    creation_date: Time.parse("2024-01-15T10:30:00Z"), 
    display_name: "Session Logger with All Events", 
    event_filter: {
      all: {
      }, 
    }, 
    log_configuration: {
      s3: {
        bucket: "my-session-logs-bucket-1", 
        bucket_owner: "123456789012", 
        folder_structure: "Flat", 
        key_prefix: "session-logs/all/events", 
        log_file_format: "Json", 
      }, 
    }, 
    session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012", 
  }, 
}

Example: Get Session Logger with Specific Events


# Retrieves a session logger configured for specific events

resp = client.get_session_logger({
  session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321", 
})

resp.to_h outputs the following:
{
  session_logger: {
    additional_encryption_context: {
      "EncryptionContextKey" => "EncryptionContextValue", 
    }, 
    creation_date: Time.parse("2024-01-15T14:45:00Z"), 
    customer_managed_key: "arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012", 
    display_name: "Session Logger with Each Events", 
    event_filter: {
      include: [
        "SessionStart", 
        "SessionEnd", 
        "UrlLoad", 
        "WebsiteInteract", 
      ], 
    }, 
    log_configuration: {
      s3: {
        bucket: "my-session-logs-bucket-2", 
        bucket_owner: "123456789012", 
        folder_structure: "NestedByDate", 
        key_prefix: "session-logs/each/event", 
        log_file_format: "JSONLines", 
      }, 
    }, 
    session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321", 
  }, 
}

Request syntax with placeholder values


resp = client.get_session_logger({
  session_logger_arn: "ARN", # required
})

Response structure


resp.session_logger.session_logger_arn #=> String
resp.session_logger.event_filter.include #=> Array
resp.session_logger.event_filter.include[0] #=> String, one of "WebsiteInteract", "FileDownloadFromSecureBrowserToRemoteDisk", "FileTransferFromRemoteToLocalDisk", "FileTransferFromLocalToRemoteDisk", "FileUploadFromRemoteDiskToSecureBrowser", "ContentPasteToWebsite", "ContentTransferFromLocalToRemoteClipboard", "ContentCopyFromWebsite", "UrlLoad", "TabOpen", "TabClose", "PrintJobSubmit", "SessionConnect", "SessionStart", "SessionDisconnect", "SessionEnd", "UrlBlockByContentFilter"
resp.session_logger.log_configuration.s3.bucket #=> String
resp.session_logger.log_configuration.s3.key_prefix #=> String
resp.session_logger.log_configuration.s3.bucket_owner #=> String
resp.session_logger.log_configuration.s3.log_file_format #=> String, one of "JSONLines", "Json"
resp.session_logger.log_configuration.s3.folder_structure #=> String, one of "Flat", "NestedByDate"
resp.session_logger.customer_managed_key #=> String
resp.session_logger.additional_encryption_context #=> Hash
resp.session_logger.additional_encryption_context["StringType"] #=> String
resp.session_logger.associated_portal_arns #=> Array
resp.session_logger.associated_portal_arns[0] #=> String
resp.session_logger.display_name #=> String
resp.session_logger.creation_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :session_logger_arn (required, String) —

    The ARN of the session logger.

Returns:

See Also:



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

def get_session_logger: (

#get_trust_store(params = {}) ⇒ Types::GetTrustStoreResponse

Gets the trust store.

Examples:

Request syntax with placeholder values


resp = client.get_trust_store({
  trust_store_arn: "ARN", # required
})

Response structure


resp.trust_store.associated_portal_arns #=> Array
resp.trust_store.associated_portal_arns[0] #=> String
resp.trust_store.trust_store_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :trust_store_arn (required, String) —

    The ARN of the trust store.

Returns:

See Also:



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

def get_trust_store: (

#get_trust_store_certificate(params = {}) ⇒ Types::GetTrustStoreCertificateResponse

Gets the trust store certificate.

Examples:

Request syntax with placeholder values


resp = client.get_trust_store_certificate({
  trust_store_arn: "ARN", # required
  thumbprint: "CertificateThumbprint", # required
})

Response structure


resp.trust_store_arn #=> String
resp.certificate.thumbprint #=> String
resp.certificate.subject #=> String
resp.certificate.issuer #=> String
resp.certificate.not_valid_before #=> Time
resp.certificate.not_valid_after #=> Time
resp.certificate.body #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :trust_store_arn (required, String) —

    The ARN of the trust store certificate.

  • :thumbprint (required, String) —

    The thumbprint of the trust store certificate.

Returns:

See Also:



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

def get_trust_store_certificate: (

#get_user_access_logging_settings(params = {}) ⇒ Types::GetUserAccessLoggingSettingsResponse

Gets user access logging settings.

Examples:

Request syntax with placeholder values


resp = client.get_user_access_logging_settings({
  user_access_logging_settings_arn: "ARN", # required
})

Response structure


resp.user_access_logging_settings.user_access_logging_settings_arn #=> String
resp.user_access_logging_settings.associated_portal_arns #=> Array
resp.user_access_logging_settings.associated_portal_arns[0] #=> String
resp.user_access_logging_settings.kinesis_stream_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :user_access_logging_settings_arn (required, String) —

    The ARN of the user access logging settings.

Returns:

See Also:



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

def get_user_access_logging_settings: (

#get_user_settings(params = {}) ⇒ Types::GetUserSettingsResponse

Gets user settings.

Examples:

Request syntax with placeholder values


resp = client.({
  user_settings_arn: "ARN", # required
})

Response structure


resp.. #=> String
resp..associated_portal_arns #=> Array
resp..associated_portal_arns[0] #=> String
resp..copy_allowed #=> String, one of "Disabled", "Enabled"
resp..paste_allowed #=> String, one of "Disabled", "Enabled"
resp..download_allowed #=> String, one of "Disabled", "Enabled"
resp..upload_allowed #=> String, one of "Disabled", "Enabled"
resp..print_allowed #=> String, one of "Disabled", "Enabled"
resp..disconnect_timeout_in_minutes #=> Integer
resp..idle_disconnect_timeout_in_minutes #=> Integer
resp..cookie_synchronization_configuration.allowlist #=> Array
resp..cookie_synchronization_configuration.allowlist[0].domain #=> String
resp..cookie_synchronization_configuration.allowlist[0].name #=> String
resp..cookie_synchronization_configuration.allowlist[0].path #=> String
resp..cookie_synchronization_configuration.blocklist #=> Array
resp..cookie_synchronization_configuration.blocklist[0].domain #=> String
resp..cookie_synchronization_configuration.blocklist[0].name #=> String
resp..cookie_synchronization_configuration.blocklist[0].path #=> String
resp..customer_managed_key #=> String
resp..additional_encryption_context #=> Hash
resp..additional_encryption_context["StringType"] #=> String
resp..deep_link_allowed #=> String, one of "Disabled", "Enabled"
resp..toolbar_configuration.toolbar_type #=> String, one of "Floating", "Docked"
resp..toolbar_configuration.visual_mode #=> String, one of "Dark", "Light"
resp..toolbar_configuration.hidden_toolbar_items #=> Array
resp..toolbar_configuration.hidden_toolbar_items[0] #=> String, one of "Windows", "DualMonitor", "FullScreen", "Webcam", "Microphone"
resp..toolbar_configuration.max_display_resolution #=> String, one of "size4096X2160", "size3840X2160", "size3440X1440", "size2560X1440", "size1920X1080", "size1280X720", "size1024X768", "size800X600"
resp..branding_configuration..mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
resp..branding_configuration..file_extension #=> String
resp..branding_configuration..last_upload_timestamp #=> Time
resp..branding_configuration.wallpaper.mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
resp..branding_configuration.wallpaper.file_extension #=> String
resp..branding_configuration.wallpaper.last_upload_timestamp #=> Time
resp..branding_configuration.favicon.mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
resp..branding_configuration.favicon.file_extension #=> String
resp..branding_configuration.favicon.last_upload_timestamp #=> Time
resp..branding_configuration.localized_strings #=> Hash
resp..branding_configuration.localized_strings["Locale"].browser_tab_title #=> String
resp..branding_configuration.localized_strings["Locale"].welcome_text #=> String
resp..branding_configuration.localized_strings["Locale"]. #=> String
resp..branding_configuration.localized_strings["Locale"]. #=> String
resp..branding_configuration.localized_strings["Locale"]. #=> String
resp..branding_configuration.localized_strings["Locale"].contact_link #=> String
resp..branding_configuration.localized_strings["Locale"].contact_button_text #=> String
resp..branding_configuration.localized_strings["Locale"].loading_text #=> String
resp..branding_configuration.color_theme #=> String, one of "Light", "Dark"
resp..branding_configuration.terms_of_service #=> String
resp..web_authn_allowed #=> String, one of "Disabled", "Enabled"

Parameters:

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

    ({})

Options Hash (params):

  • :user_settings_arn (required, String) —

    The ARN of the user settings.

Returns:

See Also:



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

def get_user_settings: (

#list_browser_settings(params = {}) ⇒ Types::ListBrowserSettingsResponse

Retrieves a list of browser settings.

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_browser_settings({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.browser_settings #=> Array
resp.browser_settings[0].browser_settings_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

Returns:

See Also:



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

def list_browser_settings: (

#list_data_protection_settings(params = {}) ⇒ Types::ListDataProtectionSettingsResponse

Retrieves a list of data protection settings.

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_data_protection_settings({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.data_protection_settings #=> Array
resp.data_protection_settings[0].data_protection_settings_arn #=> String
resp.data_protection_settings[0].display_name #=> String
resp.data_protection_settings[0].description #=> String
resp.data_protection_settings[0].creation_date #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

Returns:

See Also:



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

def list_data_protection_settings: (

#list_identity_providers(params = {}) ⇒ Types::ListIdentityProvidersResponse

Retrieves a list of identity providers for a specific web portal.

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_identity_providers({
  next_token: "PaginationToken",
  max_results: 1,
  portal_arn: "ARN", # required
})

Response structure


resp.next_token #=> String
resp.identity_providers #=> Array
resp.identity_providers[0].identity_provider_arn #=> String
resp.identity_providers[0].identity_provider_name #=> String
resp.identity_providers[0].identity_provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

See Also:



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

def list_identity_providers: (

#list_ip_access_settings(params = {}) ⇒ Types::ListIpAccessSettingsResponse

Retrieves a list of IP access settings.

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_ip_access_settings({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.ip_access_settings #=> Array
resp.ip_access_settings[0].ip_access_settings_arn #=> String
resp.ip_access_settings[0].display_name #=> String
resp.ip_access_settings[0].description #=> String
resp.ip_access_settings[0].creation_date #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

Returns:

See Also:



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

def list_ip_access_settings: (

#list_network_settings(params = {}) ⇒ Types::ListNetworkSettingsResponse

Retrieves a list of network settings.

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_network_settings({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.network_settings #=> Array
resp.network_settings[0].network_settings_arn #=> String
resp.network_settings[0].vpc_id #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

Returns:

See Also:



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

def list_network_settings: (

#list_portals(params = {}) ⇒ Types::ListPortalsResponse

Retrieves a list or web portals.

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_portals({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.portals #=> Array
resp.portals[0].portal_arn #=> String
resp.portals[0].renderer_type #=> String, one of "AppStream"
resp.portals[0].browser_type #=> String, one of "Chrome"
resp.portals[0].portal_status #=> String, one of "Incomplete", "Pending", "Active"
resp.portals[0].portal_endpoint #=> String
resp.portals[0].display_name #=> String
resp.portals[0].creation_date #=> Time
resp.portals[0].browser_settings_arn #=> String
resp.portals[0].data_protection_settings_arn #=> String
resp.portals[0]. #=> String
resp.portals[0].network_settings_arn #=> String
resp.portals[0].session_logger_arn #=> String
resp.portals[0].trust_store_arn #=> String
resp.portals[0].user_access_logging_settings_arn #=> String
resp.portals[0].authentication_type #=> String, one of "Standard", "IAM_Identity_Center"
resp.portals[0].ip_access_settings_arn #=> String
resp.portals[0].instance_type #=> String, one of "standard.regular", "standard.large", "standard.xlarge"
resp.portals[0].max_concurrent_sessions #=> Integer
resp.portals[0].portal_custom_domain #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

Returns:

See Also:



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

def list_portals: (

#list_session_loggers(params = {}) ⇒ Types::ListSessionLoggersResponse

Lists all available session logger resources.

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

Examples:

Example: List All Session Loggers


# Lists all session loggers in the account without pagination

resp = client.list_session_loggers({
})

resp.to_h outputs the following:
{
  session_loggers: [
    {
      creation_date: Time.parse("2024-01-15T10:30:00Z"), 
      display_name: "Session Logger with All Events", 
      log_configuration: {
        s3: {
          bucket: "my-session-logs-bucket-1", 
          bucket_owner: "123456789012", 
          folder_structure: "Flat", 
          key_prefix: "session-logs/all/events", 
          log_file_format: "Json", 
        }, 
      }, 
      session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012", 
    }, 
    {
      creation_date: Time.parse("2024-01-15T14:45:00Z"), 
      display_name: "Session Logger with Each Events", 
      log_configuration: {
        s3: {
          bucket: "my-session-logs-bucket-2", 
          bucket_owner: "123456789012", 
          folder_structure: "NestedByDate", 
          key_prefix: "session-logs/each/event", 
          log_file_format: "JSONLines", 
        }, 
      }, 
      session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321", 
    }, 
  ], 
}

Example: List Session Loggers with Pagination


# Lists session loggers with pagination parameters

resp = client.list_session_loggers({
  max_results: 1, 
  next_token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9", 
})

resp.to_h outputs the following:
{
  next_token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9", 
  session_loggers: [
    {
      creation_date: Time.parse("2024-03-15T12:45:00Z"), 
      display_name: "Session Logger Example with Pagination", 
      log_configuration: {
        s3: {
          bucket: "my-session-logs-bucket-3", 
          bucket_owner: "123456789012", 
          folder_structure: "Flat", 
          key_prefix: "session-logs/pagination/example", 
          log_file_format: "JSONLines", 
        }, 
      }, 
      session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/11111111-1111-1111-1111-111111111111", 
    }, 
  ], 
}

Request syntax with placeholder values


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

Response structure


resp.session_loggers #=> Array
resp.session_loggers[0].session_logger_arn #=> String
resp.session_loggers[0].log_configuration.s3.bucket #=> String
resp.session_loggers[0].log_configuration.s3.key_prefix #=> String
resp.session_loggers[0].log_configuration.s3.bucket_owner #=> String
resp.session_loggers[0].log_configuration.s3.log_file_format #=> String, one of "JSONLines", "Json"
resp.session_loggers[0].log_configuration.s3.folder_structure #=> String, one of "Flat", "NestedByDate"
resp.session_loggers[0].display_name #=> String
resp.session_loggers[0].creation_date #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

Returns:

See Also:



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

def list_session_loggers: (

#list_sessions(params = {}) ⇒ Types::ListSessionsResponse

Lists information for multiple secure browser sessions from a specific portal.

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_sessions({
  portal_id: "PortalId", # required
  username: "Username",
  session_id: "SessionId",
  sort_by: "StartTimeAscending", # accepts StartTimeAscending, StartTimeDescending
  status: "Active", # accepts Active, Terminated
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.sessions #=> Array
resp.sessions[0].portal_arn #=> String
resp.sessions[0].session_id #=> String
resp.sessions[0].username #=> String
resp.sessions[0].status #=> String, one of "Active", "Terminated"
resp.sessions[0].start_time #=> Time
resp.sessions[0].end_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_id (required, String) —

    The ID of the web portal for the sessions.

  • :username (String) —

    The username of the session.

  • :session_id (String) —

    The ID of the session.

  • :sort_by (String) —

    The method in which the returned sessions should be sorted.

  • :status (String) —

    The status of the session.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation.

Returns:

See Also:



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

def list_sessions: (

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

Retrieves a list of tags for a resource.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

Returns:

See Also:



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

def list_tags_for_resource: (

#list_trust_store_certificates(params = {}) ⇒ Types::ListTrustStoreCertificatesResponse

Retrieves a list of trust store certificates.

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_trust_store_certificates({
  trust_store_arn: "ARN", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.certificate_list #=> Array
resp.certificate_list[0].thumbprint #=> String
resp.certificate_list[0].subject #=> String
resp.certificate_list[0].issuer #=> String
resp.certificate_list[0].not_valid_before #=> Time
resp.certificate_list[0].not_valid_after #=> Time
resp.trust_store_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :trust_store_arn (required, String) —

    The ARN of the trust store

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

Returns:

See Also:



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

def list_trust_store_certificates: (

#list_trust_stores(params = {}) ⇒ Types::ListTrustStoresResponse

Retrieves a list of trust stores.

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_trust_stores({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.trust_stores #=> Array
resp.trust_stores[0].trust_store_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

Returns:

See Also:



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

def list_trust_stores: (

#list_user_access_logging_settings(params = {}) ⇒ Types::ListUserAccessLoggingSettingsResponse

Retrieves a list of user access logging settings.

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_user_access_logging_settings({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.user_access_logging_settings #=> Array
resp.user_access_logging_settings[0].user_access_logging_settings_arn #=> String
resp.user_access_logging_settings[0].kinesis_stream_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

Returns:

See Also:



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

def list_user_access_logging_settings: (

#list_user_settings(params = {}) ⇒ Types::ListUserSettingsResponse

Retrieves a list of user settings.

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

Examples:

Request syntax with placeholder values


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

Response structure


resp. #=> Array
resp.[0]. #=> String
resp.[0].copy_allowed #=> String, one of "Disabled", "Enabled"
resp.[0].paste_allowed #=> String, one of "Disabled", "Enabled"
resp.[0].download_allowed #=> String, one of "Disabled", "Enabled"
resp.[0].upload_allowed #=> String, one of "Disabled", "Enabled"
resp.[0].print_allowed #=> String, one of "Disabled", "Enabled"
resp.[0].disconnect_timeout_in_minutes #=> Integer
resp.[0].idle_disconnect_timeout_in_minutes #=> Integer
resp.[0].cookie_synchronization_configuration.allowlist #=> Array
resp.[0].cookie_synchronization_configuration.allowlist[0].domain #=> String
resp.[0].cookie_synchronization_configuration.allowlist[0].name #=> String
resp.[0].cookie_synchronization_configuration.allowlist[0].path #=> String
resp.[0].cookie_synchronization_configuration.blocklist #=> Array
resp.[0].cookie_synchronization_configuration.blocklist[0].domain #=> String
resp.[0].cookie_synchronization_configuration.blocklist[0].name #=> String
resp.[0].cookie_synchronization_configuration.blocklist[0].path #=> String
resp.[0].deep_link_allowed #=> String, one of "Disabled", "Enabled"
resp.[0].toolbar_configuration.toolbar_type #=> String, one of "Floating", "Docked"
resp.[0].toolbar_configuration.visual_mode #=> String, one of "Dark", "Light"
resp.[0].toolbar_configuration.hidden_toolbar_items #=> Array
resp.[0].toolbar_configuration.hidden_toolbar_items[0] #=> String, one of "Windows", "DualMonitor", "FullScreen", "Webcam", "Microphone"
resp.[0].toolbar_configuration.max_display_resolution #=> String, one of "size4096X2160", "size3840X2160", "size3440X1440", "size2560X1440", "size1920X1080", "size1280X720", "size1024X768", "size800X600"
resp.[0].branding_configuration..mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
resp.[0].branding_configuration..file_extension #=> String
resp.[0].branding_configuration..last_upload_timestamp #=> Time
resp.[0].branding_configuration.wallpaper.mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
resp.[0].branding_configuration.wallpaper.file_extension #=> String
resp.[0].branding_configuration.wallpaper.last_upload_timestamp #=> Time
resp.[0].branding_configuration.favicon.mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
resp.[0].branding_configuration.favicon.file_extension #=> String
resp.[0].branding_configuration.favicon.last_upload_timestamp #=> Time
resp.[0].branding_configuration.localized_strings #=> Hash
resp.[0].branding_configuration.localized_strings["Locale"].browser_tab_title #=> String
resp.[0].branding_configuration.localized_strings["Locale"].welcome_text #=> String
resp.[0].branding_configuration.localized_strings["Locale"]. #=> String
resp.[0].branding_configuration.localized_strings["Locale"]. #=> String
resp.[0].branding_configuration.localized_strings["Locale"]. #=> String
resp.[0].branding_configuration.localized_strings["Locale"].contact_link #=> String
resp.[0].branding_configuration.localized_strings["Locale"].contact_button_text #=> String
resp.[0].branding_configuration.localized_strings["Locale"].loading_text #=> String
resp.[0].branding_configuration.color_theme #=> String, one of "Light", "Dark"
resp.[0].branding_configuration.terms_of_service #=> String
resp.[0].web_authn_allowed #=> String, one of "Disabled", "Enabled"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :next_token (String) —

    The pagination token used to retrieve the next page of results for this operation.

  • :max_results (Integer) —

    The maximum number of results to be included in the next page.

Returns:

See Also:



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

def list_user_settings: (

#tag_resource(params = {}) ⇒ Struct

Adds or overwrites one or more tags for the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ARN", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  client_token: "ClientToken",
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

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

    The tags of the resource.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token returns the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def tag_resource: (

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from the specified resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The ARN of the resource.

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

    The list of tag keys to remove from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



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

def untag_resource: (

#update_browser_settings(params = {}) ⇒ Types::UpdateBrowserSettingsResponse

Updates browser settings.

Examples:

Request syntax with placeholder values


resp = client.update_browser_settings({
  browser_settings_arn: "ARN", # required
  browser_policy: "BrowserPolicy",
  client_token: "ClientToken",
  web_content_filtering_policy: {
    blocked_categories: ["Cults"], # accepts Cults, Gambling, Nudity, Pornography, SexEducation, Tasteless, Violence, DownloadSites, ImageSharing, PeerToPeer, StreamingMediaAndDownloads, GenerativeAI, CriminalActivity, Hacking, HateAndIntolerance, IllegalDrug, IllegalSoftware, SchoolCheating, SelfHarm, Weapons, Chat, Games, InstantMessaging, ProfessionalNetwork, SocialNetworking, WebBasedEmail, ParkedDomains
    allowed_urls: ["UrlPattern"],
    blocked_urls: ["UrlPattern"],
  },
})

Response structure


resp.browser_settings.browser_settings_arn #=> String
resp.browser_settings.associated_portal_arns #=> Array
resp.browser_settings.associated_portal_arns[0] #=> String
resp.browser_settings.browser_policy #=> String
resp.browser_settings.customer_managed_key #=> String
resp.browser_settings.additional_encryption_context #=> Hash
resp.browser_settings.additional_encryption_context["StringType"] #=> String
resp.browser_settings.web_content_filtering_policy.blocked_categories #=> Array
resp.browser_settings.web_content_filtering_policy.blocked_categories[0] #=> String, one of "Cults", "Gambling", "Nudity", "Pornography", "SexEducation", "Tasteless", "Violence", "DownloadSites", "ImageSharing", "PeerToPeer", "StreamingMediaAndDownloads", "GenerativeAI", "CriminalActivity", "Hacking", "HateAndIntolerance", "IllegalDrug", "IllegalSoftware", "SchoolCheating", "SelfHarm", "Weapons", "Chat", "Games", "InstantMessaging", "ProfessionalNetwork", "SocialNetworking", "WebBasedEmail", "ParkedDomains"
resp.browser_settings.web_content_filtering_policy.allowed_urls #=> Array
resp.browser_settings.web_content_filtering_policy.allowed_urls[0] #=> String
resp.browser_settings.web_content_filtering_policy.blocked_urls #=> Array
resp.browser_settings.web_content_filtering_policy.blocked_urls[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :browser_settings_arn (required, String) —

    The ARN of the browser settings.

  • :browser_policy (String) —

    A JSON string containing Chrome Enterprise policies that will be applied to all streaming sessions.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

  • :web_content_filtering_policy (Types::WebContentFilteringPolicy) —

    The policy that specifies which URLs end users are allowed to access or which URLs or domain categories they are restricted from accessing for enhanced security.

Returns:

See Also:



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

def update_browser_settings: (

#update_data_protection_settings(params = {}) ⇒ Types::UpdateDataProtectionSettingsResponse

Updates data protection settings.

Examples:

Request syntax with placeholder values


resp = client.update_data_protection_settings({
  data_protection_settings_arn: "ARN", # required
  inline_redaction_configuration: {
    inline_redaction_patterns: [ # required
      {
        built_in_pattern_id: "BuiltInPatternId",
        custom_pattern: {
          pattern_name: "PatternName", # required
          pattern_regex: "Regex", # required
          pattern_description: "DescriptionSafe",
          keyword_regex: "Regex",
        },
        redaction_place_holder: { # required
          redaction_place_holder_type: "CustomText", # required, accepts CustomText
          redaction_place_holder_text: "RedactionPlaceHolderText",
        },
        enforced_urls: ["InlineRedactionUrl"],
        exempt_urls: ["InlineRedactionUrl"],
        confidence_level: 1,
      },
    ],
    global_enforced_urls: ["InlineRedactionUrl"],
    global_exempt_urls: ["InlineRedactionUrl"],
    global_confidence_level: 1,
  },
  display_name: "DisplayNameSafe",
  description: "DescriptionSafe",
  client_token: "ClientToken",
})

Response structure


resp.data_protection_settings.data_protection_settings_arn #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns #=> Array
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].built_in_pattern_id #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].custom_pattern.pattern_name #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].custom_pattern.pattern_regex #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].custom_pattern.pattern_description #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].custom_pattern.keyword_regex #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].redaction_place_holder.redaction_place_holder_type #=> String, one of "CustomText"
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].redaction_place_holder.redaction_place_holder_text #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].enforced_urls #=> Array
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].enforced_urls[0] #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].exempt_urls #=> Array
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].exempt_urls[0] #=> String
resp.data_protection_settings.inline_redaction_configuration.inline_redaction_patterns[0].confidence_level #=> Integer
resp.data_protection_settings.inline_redaction_configuration.global_enforced_urls #=> Array
resp.data_protection_settings.inline_redaction_configuration.global_enforced_urls[0] #=> String
resp.data_protection_settings.inline_redaction_configuration.global_exempt_urls #=> Array
resp.data_protection_settings.inline_redaction_configuration.global_exempt_urls[0] #=> String
resp.data_protection_settings.inline_redaction_configuration.global_confidence_level #=> Integer
resp.data_protection_settings.associated_portal_arns #=> Array
resp.data_protection_settings.associated_portal_arns[0] #=> String
resp.data_protection_settings.display_name #=> String
resp.data_protection_settings.description #=> String
resp.data_protection_settings.creation_date #=> Time
resp.data_protection_settings.customer_managed_key #=> String
resp.data_protection_settings.additional_encryption_context #=> Hash
resp.data_protection_settings.additional_encryption_context["StringType"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :data_protection_settings_arn (required, String) —

    The ARN of the data protection settings.

  • :inline_redaction_configuration (Types::InlineRedactionConfiguration) —

    The inline redaction configuration of the data protection settings that will be applied to all sessions.

  • :display_name (String) —

    The display name of the data protection settings.

  • :description (String) —

    The description of the data protection settings.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

Returns:

See Also:



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

def update_data_protection_settings: (

#update_identity_provider(params = {}) ⇒ Types::UpdateIdentityProviderResponse

Updates the identity provider.

Examples:

Request syntax with placeholder values


resp = client.update_identity_provider({
  identity_provider_arn: "SubresourceARN", # required
  identity_provider_name: "IdentityProviderName",
  identity_provider_type: "SAML", # accepts SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
  identity_provider_details: {
    "StringType" => "StringType",
  },
  client_token: "ClientToken",
})

Response structure


resp.identity_provider.identity_provider_arn #=> String
resp.identity_provider.identity_provider_name #=> String
resp.identity_provider.identity_provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"
resp.identity_provider.identity_provider_details #=> Hash
resp.identity_provider.identity_provider_details["StringType"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :identity_provider_arn (required, String) —

    The ARN of the identity provider.

  • :identity_provider_name (String) —

    The name of the identity provider.

  • :identity_provider_type (String) —

    The type of the identity provider.

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

    The details of the identity provider. The following list describes the provider detail keys for each identity provider type.

    • For Google and Login with Amazon:

    • client_id

    • client_secret

    • authorize_scopes

    • For Facebook:

    • client_id

    • client_secret

    • authorize_scopes

    • api_version

    • For Sign in with Apple:

    • client_id

    • team_id

    • key_id

    • private_key

    • authorize_scopes

    • For OIDC providers:

    • client_id

    • client_secret

    • attributes_request_method

    • oidc_issuer

    • authorize_scopes

    • authorize_url if not available from discovery URL specified by oidc_issuer key

    • token_url if not available from discovery URL specified by oidc_issuer key

    • attributes_url if not available from discovery URL specified by oidc_issuer key

    • jwks_uri if not available from discovery URL specified by oidc_issuer key

    • For SAML providers:

    • MetadataFile OR MetadataURL

    • IDPSignout (boolean) optional

    • IDPInit (boolean) optional

    • RequestSigningAlgorithm (string) optional - Only accepts rsa-sha256

    • EncryptedResponses (boolean) optional

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

Returns:

See Also:



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

def update_identity_provider: (

#update_ip_access_settings(params = {}) ⇒ Types::UpdateIpAccessSettingsResponse

Updates IP access settings.

Examples:

Request syntax with placeholder values


resp = client.update_ip_access_settings({
  ip_access_settings_arn: "ARN", # required
  display_name: "DisplayName",
  description: "Description",
  ip_rules: [
    {
      ip_range: "IpRange", # required
      description: "Description",
    },
  ],
  client_token: "ClientToken",
})

Response structure


resp.ip_access_settings.ip_access_settings_arn #=> String
resp.ip_access_settings.associated_portal_arns #=> Array
resp.ip_access_settings.associated_portal_arns[0] #=> String
resp.ip_access_settings.ip_rules #=> Array
resp.ip_access_settings.ip_rules[0].ip_range #=> String
resp.ip_access_settings.ip_rules[0].description #=> String
resp.ip_access_settings.display_name #=> String
resp.ip_access_settings.description #=> String
resp.ip_access_settings.creation_date #=> Time
resp.ip_access_settings.customer_managed_key #=> String
resp.ip_access_settings.additional_encryption_context #=> Hash
resp.ip_access_settings.additional_encryption_context["StringType"] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :ip_access_settings_arn (required, String) —

    The ARN of the IP access settings.

  • :display_name (String) —

    The display name of the IP access settings.

  • :description (String) —

    The description of the IP access settings.

  • :ip_rules (Array<Types::IpRule>) —

    The updated IP rules of the IP access settings.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

Returns:

See Also:



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

def update_ip_access_settings: (

#update_network_settings(params = {}) ⇒ Types::UpdateNetworkSettingsResponse

Updates network settings.

Examples:

Request syntax with placeholder values


resp = client.update_network_settings({
  network_settings_arn: "ARN", # required
  vpc_id: "VpcId",
  subnet_ids: ["SubnetId"],
  security_group_ids: ["SecurityGroupId"],
  client_token: "ClientToken",
})

Response structure


resp.network_settings.network_settings_arn #=> String
resp.network_settings.associated_portal_arns #=> Array
resp.network_settings.associated_portal_arns[0] #=> String
resp.network_settings.vpc_id #=> String
resp.network_settings.subnet_ids #=> Array
resp.network_settings.subnet_ids[0] #=> String
resp.network_settings.security_group_ids #=> Array
resp.network_settings.security_group_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :network_settings_arn (required, String) —

    The ARN of the network settings.

  • :vpc_id (String) —

    The VPC that streaming instances will connect to.

  • :subnet_ids (Array<String>) —

    The subnets in which network interfaces are created to connect streaming instances to your VPC. At least two of these subnets must be in different availability zones.

  • :security_group_ids (Array<String>) —

    One or more security groups used to control access from streaming instances to your VPC.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

Returns:

See Also:



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

def update_network_settings: (

#update_portal(params = {}) ⇒ Types::UpdatePortalResponse

Updates a web portal.

Examples:

Request syntax with placeholder values


resp = client.update_portal({
  portal_arn: "ARN", # required
  display_name: "DisplayName",
  authentication_type: "Standard", # accepts Standard, IAM_Identity_Center
  instance_type: "standard.regular", # accepts standard.regular, standard.large, standard.xlarge
  max_concurrent_sessions: 1,
  portal_custom_domain: "PortalCustomDomain",
})

Response structure


resp.portal.portal_arn #=> String
resp.portal.renderer_type #=> String, one of "AppStream"
resp.portal.browser_type #=> String, one of "Chrome"
resp.portal.portal_status #=> String, one of "Incomplete", "Pending", "Active"
resp.portal.portal_endpoint #=> String
resp.portal.display_name #=> String
resp.portal.creation_date #=> Time
resp.portal.browser_settings_arn #=> String
resp.portal.data_protection_settings_arn #=> String
resp.portal. #=> String
resp.portal.network_settings_arn #=> String
resp.portal.session_logger_arn #=> String
resp.portal.trust_store_arn #=> String
resp.portal.status_reason #=> String
resp.portal.user_access_logging_settings_arn #=> String
resp.portal.authentication_type #=> String, one of "Standard", "IAM_Identity_Center"
resp.portal.ip_access_settings_arn #=> String
resp.portal.customer_managed_key #=> String
resp.portal.additional_encryption_context #=> Hash
resp.portal.additional_encryption_context["StringType"] #=> String
resp.portal.instance_type #=> String, one of "standard.regular", "standard.large", "standard.xlarge"
resp.portal.max_concurrent_sessions #=> Integer
resp.portal.portal_custom_domain #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

  • :display_name (String) —

    The name of the web portal. This is not visible to users who log into the web portal.

  • :authentication_type (String) —

    The type of authentication integration points used when signing into the web portal. Defaults to Standard.

    Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

    IAM Identity Center web portals are authenticated through IAM Identity Center. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

  • :instance_type (String) —

    The type and resources of the underlying instance.

  • :max_concurrent_sessions (Integer) —

    The maximum number of concurrent sessions for the portal.

  • :portal_custom_domain (String) —

    The custom domain of the web portal that users access in order to start streaming sessions.

Returns:

See Also:



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

def update_portal: (

#update_session_logger(params = {}) ⇒ Types::UpdateSessionLoggerResponse

Updates the details of a session logger.

Examples:

Example: Update Session Logger Event Filter


# Updates a session logger to capture specific events instead of all events

resp = client.update_session_logger({
  event_filter: {
    include: [
      "SessionStart", 
      "SessionEnd", 
      "UrlLoad", 
      "WebsiteInteract", 
    ], 
  }, 
  session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012", 
})

resp.to_h outputs the following:
{
  session_logger: {
    creation_date: Time.parse("2024-01-15T10:30:00Z"), 
    display_name: "Updated Session Logger with Specific Events", 
    event_filter: {
      include: [
        "SessionStart", 
        "SessionEnd", 
        "UrlLoad", 
        "WebsiteInteract", 
      ], 
    }, 
    log_configuration: {
      s3: {
        bucket: "my-session-logs-bucket", 
        bucket_owner: "123456789012", 
        folder_structure: "Flat", 
        key_prefix: "updated/session-logs/each/event", 
        log_file_format: "Json", 
      }, 
    }, 
    session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/12345678-1234-1234-1234-123456789012", 
  }, 
}

Example: Update Session Logger Configuration


# Updates the log configuration of a session logger

resp = client.update_session_logger({
  log_configuration: {
    s3: {
      bucket: "updated-my-session-logs-bucket-2", 
      bucket_owner: "123456789012", 
      folder_structure: "Flat", 
      key_prefix: "updated/key/prefix", 
      log_file_format: "Json", 
    }, 
  }, 
  session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321", 
})

resp.to_h outputs the following:
{
  session_logger: {
    additional_encryption_context: {
      "EncryptionContextKey" => "EncryptionContextValue", 
    }, 
    creation_date: Time.parse("2024-01-15T14:45:00Z"), 
    customer_managed_key: "arn:aws:kms:us-west-2:123456789012:key/12345678-1234-1234-1234-123456789012", 
    display_name: "Updated Session Logger with Log Config", 
    event_filter: {
      all: {
      }, 
    }, 
    log_configuration: {
      s3: {
        bucket: "updated-my-session-logs-bucket-2", 
        bucket_owner: "123456789012", 
        folder_structure: "Flat", 
        key_prefix: "updated/key/prefix", 
        log_file_format: "Json", 
      }, 
    }, 
    session_logger_arn: "arn:aws:workspaces-web:us-west-2:123456789012:sessionLogger/87654321-4321-4321-4321-210987654321", 
  }, 
}

Request syntax with placeholder values


resp = client.update_session_logger({
  session_logger_arn: "ARN", # required
  event_filter: {
    all: {
    },
    include: ["WebsiteInteract"], # accepts WebsiteInteract, FileDownloadFromSecureBrowserToRemoteDisk, FileTransferFromRemoteToLocalDisk, FileTransferFromLocalToRemoteDisk, FileUploadFromRemoteDiskToSecureBrowser, ContentPasteToWebsite, ContentTransferFromLocalToRemoteClipboard, ContentCopyFromWebsite, UrlLoad, TabOpen, TabClose, PrintJobSubmit, SessionConnect, SessionStart, SessionDisconnect, SessionEnd, UrlBlockByContentFilter
  },
  log_configuration: {
    s3: {
      bucket: "S3Bucket", # required
      key_prefix: "S3KeyPrefix",
      bucket_owner: "S3BucketOwner",
      log_file_format: "JSONLines", # required, accepts JSONLines, Json
      folder_structure: "Flat", # required, accepts Flat, NestedByDate
    },
  },
  display_name: "DisplayNameSafe",
})

Response structure


resp.session_logger.session_logger_arn #=> String
resp.session_logger.event_filter.include #=> Array
resp.session_logger.event_filter.include[0] #=> String, one of "WebsiteInteract", "FileDownloadFromSecureBrowserToRemoteDisk", "FileTransferFromRemoteToLocalDisk", "FileTransferFromLocalToRemoteDisk", "FileUploadFromRemoteDiskToSecureBrowser", "ContentPasteToWebsite", "ContentTransferFromLocalToRemoteClipboard", "ContentCopyFromWebsite", "UrlLoad", "TabOpen", "TabClose", "PrintJobSubmit", "SessionConnect", "SessionStart", "SessionDisconnect", "SessionEnd", "UrlBlockByContentFilter"
resp.session_logger.log_configuration.s3.bucket #=> String
resp.session_logger.log_configuration.s3.key_prefix #=> String
resp.session_logger.log_configuration.s3.bucket_owner #=> String
resp.session_logger.log_configuration.s3.log_file_format #=> String, one of "JSONLines", "Json"
resp.session_logger.log_configuration.s3.folder_structure #=> String, one of "Flat", "NestedByDate"
resp.session_logger.customer_managed_key #=> String
resp.session_logger.additional_encryption_context #=> Hash
resp.session_logger.additional_encryption_context["StringType"] #=> String
resp.session_logger.associated_portal_arns #=> Array
resp.session_logger.associated_portal_arns[0] #=> String
resp.session_logger.display_name #=> String
resp.session_logger.creation_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :session_logger_arn (required, String) —

    The ARN of the session logger to update.

  • :event_filter (Types::EventFilter) —

    The updated eventFilter.

  • :log_configuration (Types::LogConfiguration) —

    The updated logConfiguration.

  • :display_name (String) —

    The updated display name.

Returns:

See Also:



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

def update_session_logger: (

#update_trust_store(params = {}) ⇒ Types::UpdateTrustStoreResponse

Updates the trust store.

Examples:

Request syntax with placeholder values


resp = client.update_trust_store({
  trust_store_arn: "ARN", # required
  certificates_to_add: ["data"],
  certificates_to_delete: ["CertificateThumbprint"],
  client_token: "ClientToken",
})

Response structure


resp.trust_store_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :trust_store_arn (required, String) —

    The ARN of the trust store.

  • :certificates_to_add (Array<String, StringIO, File>) —

    A list of CA certificates to add to the trust store.

  • :certificates_to_delete (Array<String>) —

    A list of CA certificates to delete from a trust store.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

Returns:

See Also:



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

def update_trust_store: (

#update_user_access_logging_settings(params = {}) ⇒ Types::UpdateUserAccessLoggingSettingsResponse

Updates the user access logging settings.

Examples:

Request syntax with placeholder values


resp = client.update_user_access_logging_settings({
  user_access_logging_settings_arn: "ARN", # required
  kinesis_stream_arn: "KinesisStreamArn",
  client_token: "ClientToken",
})

Response structure


resp.user_access_logging_settings.user_access_logging_settings_arn #=> String
resp.user_access_logging_settings.associated_portal_arns #=> Array
resp.user_access_logging_settings.associated_portal_arns[0] #=> String
resp.user_access_logging_settings.kinesis_stream_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :user_access_logging_settings_arn (required, String) —

    The ARN of the user access logging settings.

  • :kinesis_stream_arn (String) —

    The ARN of the Kinesis stream.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

Returns:

See Also:



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

def update_user_access_logging_settings: (

#update_user_settings(params = {}) ⇒ Types::UpdateUserSettingsResponse

Updates the user settings.

Examples:

Request syntax with placeholder values


resp = client.({
  user_settings_arn: "ARN", # required
  copy_allowed: "Disabled", # accepts Disabled, Enabled
  paste_allowed: "Disabled", # accepts Disabled, Enabled
  download_allowed: "Disabled", # accepts Disabled, Enabled
  upload_allowed: "Disabled", # accepts Disabled, Enabled
  print_allowed: "Disabled", # accepts Disabled, Enabled
  disconnect_timeout_in_minutes: 1,
  idle_disconnect_timeout_in_minutes: 1,
  client_token: "ClientToken",
  cookie_synchronization_configuration: {
    allowlist: [ # required
      {
        domain: "CookieDomain", # required
        name: "CookieName",
        path: "CookiePath",
      },
    ],
    blocklist: [
      {
        domain: "CookieDomain", # required
        name: "CookieName",
        path: "CookiePath",
      },
    ],
  },
  deep_link_allowed: "Disabled", # accepts Disabled, Enabled
  toolbar_configuration: {
    toolbar_type: "Floating", # accepts Floating, Docked
    visual_mode: "Dark", # accepts Dark, Light
    hidden_toolbar_items: ["Windows"], # accepts Windows, DualMonitor, FullScreen, Webcam, Microphone
    max_display_resolution: "size4096X2160", # accepts size4096X2160, size3840X2160, size3440X1440, size2560X1440, size1920X1080, size1280X720, size1024X768, size800X600
  },
  branding_configuration_input: {
    logo: {
      blob: "data",
      s3_uri: "S3Uri",
    },
    wallpaper: {
      blob: "data",
      s3_uri: "S3Uri",
    },
    favicon: {
      blob: "data",
      s3_uri: "S3Uri",
    },
    localized_strings: {
      "de-DE" => {
        browser_tab_title: "LocalizedBrandingStringsBrowserTabTitleString", # required
        welcome_text: "LocalizedBrandingStringsWelcomeTextString", # required
        login_title: "LocalizedBrandingStringsLoginTitleString",
        login_description: "LocalizedBrandingStringsLoginDescriptionString",
        login_button_text: "LocalizedBrandingStringsLoginButtonTextString",
        contact_link: "ContactLinkUrl",
        contact_button_text: "LocalizedBrandingStringsContactButtonTextString",
        loading_text: "LocalizedBrandingStringsLoadingTextString",
      },
    },
    color_theme: "Light", # accepts Light, Dark
    terms_of_service: "Markdown",
  },
  web_authn_allowed: "Disabled", # accepts Disabled, Enabled
})

Response structure


resp.. #=> String
resp..associated_portal_arns #=> Array
resp..associated_portal_arns[0] #=> String
resp..copy_allowed #=> String, one of "Disabled", "Enabled"
resp..paste_allowed #=> String, one of "Disabled", "Enabled"
resp..download_allowed #=> String, one of "Disabled", "Enabled"
resp..upload_allowed #=> String, one of "Disabled", "Enabled"
resp..print_allowed #=> String, one of "Disabled", "Enabled"
resp..disconnect_timeout_in_minutes #=> Integer
resp..idle_disconnect_timeout_in_minutes #=> Integer
resp..cookie_synchronization_configuration.allowlist #=> Array
resp..cookie_synchronization_configuration.allowlist[0].domain #=> String
resp..cookie_synchronization_configuration.allowlist[0].name #=> String
resp..cookie_synchronization_configuration.allowlist[0].path #=> String
resp..cookie_synchronization_configuration.blocklist #=> Array
resp..cookie_synchronization_configuration.blocklist[0].domain #=> String
resp..cookie_synchronization_configuration.blocklist[0].name #=> String
resp..cookie_synchronization_configuration.blocklist[0].path #=> String
resp..customer_managed_key #=> String
resp..additional_encryption_context #=> Hash
resp..additional_encryption_context["StringType"] #=> String
resp..deep_link_allowed #=> String, one of "Disabled", "Enabled"
resp..toolbar_configuration.toolbar_type #=> String, one of "Floating", "Docked"
resp..toolbar_configuration.visual_mode #=> String, one of "Dark", "Light"
resp..toolbar_configuration.hidden_toolbar_items #=> Array
resp..toolbar_configuration.hidden_toolbar_items[0] #=> String, one of "Windows", "DualMonitor", "FullScreen", "Webcam", "Microphone"
resp..toolbar_configuration.max_display_resolution #=> String, one of "size4096X2160", "size3840X2160", "size3440X1440", "size2560X1440", "size1920X1080", "size1280X720", "size1024X768", "size800X600"
resp..branding_configuration..mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
resp..branding_configuration..file_extension #=> String
resp..branding_configuration..last_upload_timestamp #=> Time
resp..branding_configuration.wallpaper.mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
resp..branding_configuration.wallpaper.file_extension #=> String
resp..branding_configuration.wallpaper.last_upload_timestamp #=> Time
resp..branding_configuration.favicon.mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
resp..branding_configuration.favicon.file_extension #=> String
resp..branding_configuration.favicon.last_upload_timestamp #=> Time
resp..branding_configuration.localized_strings #=> Hash
resp..branding_configuration.localized_strings["Locale"].browser_tab_title #=> String
resp..branding_configuration.localized_strings["Locale"].welcome_text #=> String
resp..branding_configuration.localized_strings["Locale"]. #=> String
resp..branding_configuration.localized_strings["Locale"]. #=> String
resp..branding_configuration.localized_strings["Locale"]. #=> String
resp..branding_configuration.localized_strings["Locale"].contact_link #=> String
resp..branding_configuration.localized_strings["Locale"].contact_button_text #=> String
resp..branding_configuration.localized_strings["Locale"].loading_text #=> String
resp..branding_configuration.color_theme #=> String, one of "Light", "Dark"
resp..branding_configuration.terms_of_service #=> String
resp..web_authn_allowed #=> String, one of "Disabled", "Enabled"

Parameters:

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

    ({})

Options Hash (params):

  • :user_settings_arn (required, String) —

    The ARN of the user settings.

  • :copy_allowed (String) —

    Specifies whether the user can copy text from the streaming session to the local device.

  • :paste_allowed (String) —

    Specifies whether the user can paste text from the local device to the streaming session.

  • :download_allowed (String) —

    Specifies whether the user can download files from the streaming session to the local device.

  • :upload_allowed (String) —

    Specifies whether the user can upload files from the local device to the streaming session.

  • :print_allowed (String) —

    Specifies whether the user can print to the local device.

  • :disconnect_timeout_in_minutes (Integer) —

    The amount of time that a streaming session remains active after users disconnect.

  • :idle_disconnect_timeout_in_minutes (Integer) —

    The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the disconnect timeout interval begins.

  • :client_token (String) —

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

    If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

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

  • :cookie_synchronization_configuration (Types::CookieSynchronizationConfiguration) —

    The configuration that specifies which cookies should be synchronized from the end user's local browser to the remote browser.

    If the allowlist and blocklist are empty, the configuration becomes null.

  • :deep_link_allowed (String) —

    Specifies whether the user can use deep links that open automatically when connecting to a session.

  • :toolbar_configuration (Types::ToolbarConfiguration) —

    The configuration of the toolbar. This allows administrators to select the toolbar type and visual mode, set maximum display resolution for sessions, and choose which items are visible to end users during their sessions. If administrators do not modify these settings, end users retain control over their toolbar preferences.

  • :branding_configuration_input (Types::BrandingConfigurationUpdateInput) —

    The branding configuration that customizes the appearance of the web portal for end users. When updating user settings without an existing branding configuration, all fields (logo, favicon, localized strings, and color theme) are required except for wallpaper and terms of service. When updating user settings with an existing branding configuration, all fields are optional.

  • :web_authn_allowed (String) —

    Specifies whether the user can use WebAuthn redirection for passwordless login to websites within the streaming session.

Returns:

See Also:



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

def update_user_settings: (

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


4532
4533
4534
 
# File 'lib/aws-sdk-workspacesweb/client.rb', line 4532

def waiter_names
  []
end