Class: Aws::WorkSpacesWeb::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb

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.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

  • :credentials (required, Aws::CredentialProvider) —

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

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

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

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

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

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

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

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

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

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

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

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

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

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

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

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

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

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

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

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

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

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

    The log formatter.

  • :log_level (Symbol) — default: :info —

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

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

  • :retry_backoff (Proc) —

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

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

  • :retry_limit (Integer) — default: 3 —

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

  • :retry_max_delay (Integer) — default: 0 —

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

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

    Specifies which retry algorithm to use. Values are:

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

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

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

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

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

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

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

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

  • :use_dualstack_endpoint (Boolean) —

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

  • :use_fips_endpoint (Boolean) —

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

  • :validate_params (Boolean) — default: true —

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

  • :endpoint_provider (Aws::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.



440
441
442
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 440

def initialize(*args)
  super
end

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({
  browser_settings_arn: "ARN", # required
  portal_arn: "ARN", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :browser_settings_arn (required, String) —

    The ARN of the browser settings.

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

See Also:



475
476
477
478
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 475

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

#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({
  ip_access_settings_arn: "ARN", # required
  portal_arn: "ARN", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :ip_access_settings_arn (required, String) —

    The ARN of the IP access settings.

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

See Also:



509
510
511
512
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 509

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

#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({
  network_settings_arn: "ARN", # required
  portal_arn: "ARN", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :network_settings_arn (required, String) —

    The ARN of the network settings.

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

See Also:



543
544
545
546
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 543

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

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



577
578
579
580
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 577

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

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



611
612
613
614
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 611

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

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



645
646
647
648
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 645

def (params = {}, options = {})
  req = build_request(:associate_user_settings, params)
  req.send_request(options)
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({
  additional_encryption_context: {
    "StringType" => "StringType",
  },
  browser_policy: "BrowserPolicy", # required
  client_token: "ClientToken",
  customer_managed_key: "keyArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.browser_settings_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    Additional encryption context of the browser settings.

  • :browser_policy (required, 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.**

  • :customer_managed_key (String) —

    The custom managed key of the browser settings.

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

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

Returns:

See Also:



711
712
713
714
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 711

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

#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({
  client_token: "ClientToken",
  identity_provider_details: { # required
    "StringType" => "StringType",
  },
  identity_provider_name: "IdentityProviderName", # required
  identity_provider_type: "SAML", # required, accepts SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
  portal_arn: "ARN", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.identity_provider_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

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

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

  • :identity_provider_name (required, String) —

    The identity provider name.

  • :identity_provider_type (required, String) —

    The identity provider type.

  • :portal_arn (required, String) —

    The ARN of the web portal.

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

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

Returns:

See Also:



846
847
848
849
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 846

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

#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({
  additional_encryption_context: {
    "StringType" => "StringType",
  },
  client_token: "ClientToken",
  customer_managed_key: "keyArn",
  description: "Description",
  display_name: "DisplayName",
  ip_rules: [ # required
    {
      description: "Description",
      ip_range: "IpRange", # required
    },
  ],
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.ip_access_settings_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    Additional encryption context 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.**

  • :customer_managed_key (String) —

    The custom managed key of the IP access settings.

  • :description (String) —

    The description of the IP access settings.

  • :display_name (String) —

    The display name of the IP access settings.

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

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

Returns:

See Also:



922
923
924
925
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 922

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

#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({
  client_token: "ClientToken",
  security_group_ids: ["SecurityGroupId"], # required
  subnet_ids: ["SubnetId"], # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  vpc_id: "VpcId", # required
})

Response structure


resp.network_settings_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

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

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

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

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

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

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

  • :vpc_id (required, String) —

    The VPC that streaming instances will connect to.

Returns:

See Also:



987
988
989
990
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 987

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

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

Creates a web portal.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

    The additional encryption context of the 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 (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

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

  • :customer_managed_key (String) —

    The customer managed key 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.

  • :instance_type (String) —

    The type and resources of the underlying instance.

  • :max_concurrent_sessions (Integer) —

    The maximum number of concurrent sessions for the portal.

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

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

Returns:

See Also:



1076
1077
1078
1079
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1076

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

#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
  client_token: "ClientToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

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.

  • :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 trust store. A tag is a key-value pair.

Returns:

See Also:



1133
1134
1135
1136
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1133

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

#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({
  client_token: "ClientToken",
  kinesis_stream_arn: "KinesisStreamArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.user_access_logging_settings_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

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

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

Returns:

See Also:



1186
1187
1188
1189
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1186

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

#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.({
  additional_encryption_context: {
    "StringType" => "StringType",
  },
  client_token: "ClientToken",
  cookie_synchronization_configuration: {
    allowlist: [ # required
      {
        domain: "CookieDomain", # required
        name: "CookieName",
        path: "CookiePath",
      },
    ],
    blocklist: [
      {
        domain: "CookieDomain", # required
        name: "CookieName",
        path: "CookiePath",
      },
    ],
  },
  copy_allowed: "Disabled", # required, accepts Disabled, Enabled
  customer_managed_key: "keyArn",
  deep_link_allowed: "Disabled", # accepts Disabled, Enabled
  disconnect_timeout_in_minutes: 1,
  download_allowed: "Disabled", # required, accepts Disabled, Enabled
  idle_disconnect_timeout_in_minutes: 1,
  paste_allowed: "Disabled", # required, accepts Disabled, Enabled
  print_allowed: "Disabled", # required, accepts Disabled, Enabled
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  upload_allowed: "Disabled", # required, accepts Disabled, Enabled
})

Response structure


resp. #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    The additional encryption context of the user 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.**

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

  • :copy_allowed (required, String) —

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

  • :customer_managed_key (String) —

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

  • :deep_link_allowed (String) —

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

  • :disconnect_timeout_in_minutes (Integer) —

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

  • :download_allowed (required, String) —

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

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

  • :paste_allowed (required, String) —

    Specifies whether the user can paste text 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.

  • :upload_allowed (required, String) —

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

Returns:

See Also:



1308
1309
1310
1311
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1308

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

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



1330
1331
1332
1333
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1330

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

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



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

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

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



1374
1375
1376
1377
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1374

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

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



1396
1397
1398
1399
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1396

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

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



1418
1419
1420
1421
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1418

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

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



1440
1441
1442
1443
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1440

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

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



1462
1463
1464
1465
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1462

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

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



1484
1485
1486
1487
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1484

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

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



1506
1507
1508
1509
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1506

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

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



1528
1529
1530
1531
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1528

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

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



1550
1551
1552
1553
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1550

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

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



1572
1573
1574
1575
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1572

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

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



1594
1595
1596
1597
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1594

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

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



1616
1617
1618
1619
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1616

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

#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.additional_encryption_context #=> Hash
resp.browser_settings.additional_encryption_context["StringType"] #=> 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.browser_settings_arn #=> String
resp.browser_settings.customer_managed_key #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :browser_settings_arn (required, String) —

    The ARN of the browser settings.

Returns:

See Also:



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

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

#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_details #=> Hash
resp.identity_provider.identity_provider_details["StringType"] #=> String
resp.identity_provider.identity_provider_name #=> String
resp.identity_provider.identity_provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"

Parameters:

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

    ({})

Options Hash (params):

  • :identity_provider_arn (required, String) —

    The ARN of the identity provider.

Returns:

See Also:



1682
1683
1684
1685
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1682

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

#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.additional_encryption_context #=> Hash
resp.ip_access_settings.additional_encryption_context["StringType"] #=> String
resp.ip_access_settings.associated_portal_arns #=> Array
resp.ip_access_settings.associated_portal_arns[0] #=> String
resp.ip_access_settings.creation_date #=> Time
resp.ip_access_settings.customer_managed_key #=> String
resp.ip_access_settings.description #=> String
resp.ip_access_settings.display_name #=> String
resp.ip_access_settings.ip_access_settings_arn #=> String
resp.ip_access_settings.ip_rules #=> Array
resp.ip_access_settings.ip_rules[0].description #=> String
resp.ip_access_settings.ip_rules[0].ip_range #=> 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:



1721
1722
1723
1724
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1721

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

#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.associated_portal_arns #=> Array
resp.network_settings.associated_portal_arns[0] #=> String
resp.network_settings.network_settings_arn #=> String
resp.network_settings.security_group_ids #=> Array
resp.network_settings.security_group_ids[0] #=> String
resp.network_settings.subnet_ids #=> Array
resp.network_settings.subnet_ids[0] #=> String
resp.network_settings.vpc_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :network_settings_arn (required, String) —

    The ARN of the network settings.

Returns:

See Also:



1756
1757
1758
1759
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1756

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

See Also:



1803
1804
1805
1806
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1803

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

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



1833
1834
1835
1836
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1833

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

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



1863
1864
1865
1866
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1863

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

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

Gets the trust store certificate.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :thumbprint (required, String) —

    The thumbprint of the trust store certificate.

  • :trust_store_arn (required, String) —

    The ARN of the trust store certificate.

Returns:

See Also:



1902
1903
1904
1905
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1902

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

#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.associated_portal_arns #=> Array
resp.user_access_logging_settings.associated_portal_arns[0] #=> String
resp.user_access_logging_settings.kinesis_stream_arn #=> String
resp.user_access_logging_settings.user_access_logging_settings_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:



1933
1934
1935
1936
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1933

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

#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..additional_encryption_context #=> Hash
resp..additional_encryption_context["StringType"] #=> String
resp..associated_portal_arns #=> Array
resp..associated_portal_arns[0] #=> String
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..copy_allowed #=> String, one of "Disabled", "Enabled"
resp..customer_managed_key #=> String
resp..deep_link_allowed #=> String, one of "Disabled", "Enabled"
resp..disconnect_timeout_in_minutes #=> Integer
resp..download_allowed #=> String, one of "Disabled", "Enabled"
resp..idle_disconnect_timeout_in_minutes #=> Integer
resp..paste_allowed #=> String, one of "Disabled", "Enabled"
resp..print_allowed #=> String, one of "Disabled", "Enabled"
resp..upload_allowed #=> String, one of "Disabled", "Enabled"
resp.. #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :user_settings_arn (required, String) —

    The ARN of the user settings.

Returns:

See Also:



1982
1983
1984
1985
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 1982

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

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

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

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



2020
2021
2022
2023
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2020

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

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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

  • :portal_arn (required, String) —

    The ARN of the web portal.

Returns:

See Also:



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

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

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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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



2105
2106
2107
2108
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2105

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

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

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

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



2144
2145
2146
2147
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2144

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

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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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



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

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

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



2227
2228
2229
2230
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2227

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

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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

  • :trust_store_arn (required, String) —

    The ARN of the trust store

Returns:

See Also:



2275
2276
2277
2278
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2275

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

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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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



2313
2314
2315
2316
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2313

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

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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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



2352
2353
2354
2355
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2352

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

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

Response structure


resp.next_token #=> String
resp. #=> Array
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].copy_allowed #=> String, one of "Disabled", "Enabled"
resp.[0].deep_link_allowed #=> String, one of "Disabled", "Enabled"
resp.[0].disconnect_timeout_in_minutes #=> Integer
resp.[0].download_allowed #=> String, one of "Disabled", "Enabled"
resp.[0].idle_disconnect_timeout_in_minutes #=> Integer
resp.[0].paste_allowed #=> String, one of "Disabled", "Enabled"
resp.[0].print_allowed #=> String, one of "Disabled", "Enabled"
resp.[0].upload_allowed #=> String, one of "Disabled", "Enabled"
resp.[0]. #=> String

Parameters:

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

    ({})

Options Hash (params):

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



2406
2407
2408
2409
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2406

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

#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({
  client_token: "ClientToken",
  resource_arn: "ARN", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

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

  • :resource_arn (required, String) —

    The ARN of the resource.

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

    The tags of the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2451
2452
2453
2454
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2451

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

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



2477
2478
2479
2480
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2477

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

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

Updates browser settings.

Examples:

Request syntax with placeholder values


resp = client.update_browser_settings({
  browser_policy: "BrowserPolicy",
  browser_settings_arn: "ARN", # required
  client_token: "ClientToken",
})

Response structure


resp.browser_settings.additional_encryption_context #=> Hash
resp.browser_settings.additional_encryption_context["StringType"] #=> 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.browser_settings_arn #=> String
resp.browser_settings.customer_managed_key #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :browser_policy (String) —

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

  • :browser_settings_arn (required, String) —

    The ARN of the browser 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:



2530
2531
2532
2533
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2530

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

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

Updates the identity provider.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

  • :identity_provider_arn (required, String) —

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

  • :identity_provider_name (String) —

    The name of the identity provider.

  • :identity_provider_type (String) —

    The type of the identity provider.

Returns:

See Also:



2658
2659
2660
2661
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2658

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

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

Updates IP access settings.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

  • :description (String) —

    The description of the IP access settings.

  • :display_name (String) —

    The display name of the IP access settings.

  • :ip_access_settings_arn (required, String) —

    The ARN of the IP access settings.

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

    The updated IP rules of the IP access settings.

Returns:

See Also:



2728
2729
2730
2731
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2728

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

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

Updates network settings.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

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

  • :network_settings_arn (required, String) —

    The ARN of the network settings.

  • :security_group_ids (Array<String>) —

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

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

  • :vpc_id (String) —

    The VPC that streaming instances will connect to.

Returns:

See Also:



2792
2793
2794
2795
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2792

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

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

Updates a web portal.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :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 (successor to Single Sign-On). Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

  • :display_name (String) —

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

  • :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_arn (required, String) —

    The ARN of the web portal.

Returns:

See Also:



2869
2870
2871
2872
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2869

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

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

Updates the trust store.

Examples:

Request syntax with placeholder values


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

Response structure


resp.trust_store_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

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

  • :trust_store_arn (required, String) —

    The ARN of the trust store.

Returns:

See Also:



2919
2920
2921
2922
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2919

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

#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({
  client_token: "ClientToken",
  kinesis_stream_arn: "KinesisStreamArn",
  user_access_logging_settings_arn: "ARN", # required
})

Response structure


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
resp.user_access_logging_settings.user_access_logging_settings_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

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

  • :kinesis_stream_arn (String) —

    The ARN of the Kinesis stream.

  • :user_access_logging_settings_arn (required, String) —

    The ARN of the user access logging settings.

Returns:

See Also:



2968
2969
2970
2971
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 2968

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

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

Updates the user settings.

Examples:

Request syntax with placeholder values


resp = client.({
  client_token: "ClientToken",
  cookie_synchronization_configuration: {
    allowlist: [ # required
      {
        domain: "CookieDomain", # required
        name: "CookieName",
        path: "CookiePath",
      },
    ],
    blocklist: [
      {
        domain: "CookieDomain", # required
        name: "CookieName",
        path: "CookiePath",
      },
    ],
  },
  copy_allowed: "Disabled", # accepts Disabled, Enabled
  deep_link_allowed: "Disabled", # accepts Disabled, Enabled
  disconnect_timeout_in_minutes: 1,
  download_allowed: "Disabled", # accepts Disabled, Enabled
  idle_disconnect_timeout_in_minutes: 1,
  paste_allowed: "Disabled", # accepts Disabled, Enabled
  print_allowed: "Disabled", # accepts Disabled, Enabled
  upload_allowed: "Disabled", # accepts Disabled, Enabled
  user_settings_arn: "ARN", # required
})

Response structure


resp..additional_encryption_context #=> Hash
resp..additional_encryption_context["StringType"] #=> String
resp..associated_portal_arns #=> Array
resp..associated_portal_arns[0] #=> String
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..copy_allowed #=> String, one of "Disabled", "Enabled"
resp..customer_managed_key #=> String
resp..deep_link_allowed #=> String, one of "Disabled", "Enabled"
resp..disconnect_timeout_in_minutes #=> Integer
resp..download_allowed #=> String, one of "Disabled", "Enabled"
resp..idle_disconnect_timeout_in_minutes #=> Integer
resp..paste_allowed #=> String, one of "Disabled", "Enabled"
resp..print_allowed #=> String, one of "Disabled", "Enabled"
resp..upload_allowed #=> String, one of "Disabled", "Enabled"
resp.. #=> String

Parameters:

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

    ({})

Options Hash (params):

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

  • :copy_allowed (String) —

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

  • :deep_link_allowed (String) —

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

  • :disconnect_timeout_in_minutes (Integer) —

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

  • :download_allowed (String) —

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

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

  • :paste_allowed (String) —

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

  • :print_allowed (String) —

    Specifies whether the user can print to the local device.

  • :upload_allowed (String) —

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

  • :user_settings_arn (required, String) —

    The ARN of the user settings.

Returns:

See Also:



3094
3095
3096
3097
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/client.rb', line 3094

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