aws-sdk-workspacesweb 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2188 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:workspacesweb)
34
+
35
+ module Aws::WorkSpacesWeb
36
+ # An API client for WorkSpacesWeb. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::WorkSpacesWeb::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :workspacesweb
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::RestJson)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
87
+ #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
102
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
103
+ # from an EC2 IMDS on an EC2 instance.
104
+ #
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
107
+ #
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
110
+ #
111
+ # When `:credentials` are not configured directly, the following
112
+ # locations will be searched for credentials:
113
+ #
114
+ # * `Aws.config[:credentials]`
115
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
116
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
117
+ # * `~/.aws/credentials`
118
+ # * `~/.aws/config`
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts. Instance profile credential
123
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
124
+ # to true.
125
+ #
126
+ # @option options [required, String] :region
127
+ # The AWS region to connect to. The configured `:region` is
128
+ # used to determine the service `:endpoint`. When not passed,
129
+ # a default `:region` is searched for in the following locations:
130
+ #
131
+ # * `Aws.config[:region]`
132
+ # * `ENV['AWS_REGION']`
133
+ # * `ENV['AMAZON_REGION']`
134
+ # * `ENV['AWS_DEFAULT_REGION']`
135
+ # * `~/.aws/credentials`
136
+ # * `~/.aws/config`
137
+ #
138
+ # @option options [String] :access_key_id
139
+ #
140
+ # @option options [Boolean] :active_endpoint_cache (false)
141
+ # When set to `true`, a thread polling for endpoints will be running in
142
+ # the background every 60 secs (default). Defaults to `false`.
143
+ #
144
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
145
+ # Used only in `adaptive` retry mode. When true, the request will sleep
146
+ # until there is sufficent client side capacity to retry the request.
147
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
148
+ # not retry instead of sleeping.
149
+ #
150
+ # @option options [Boolean] :client_side_monitoring (false)
151
+ # When `true`, client-side metrics will be collected for all API requests from
152
+ # this client.
153
+ #
154
+ # @option options [String] :client_side_monitoring_client_id ("")
155
+ # Allows you to provide an identifier for this client which will be attached to
156
+ # all generated client side metrics. Defaults to an empty string.
157
+ #
158
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
159
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
160
+ # side monitoring agent is running on, where client metrics will be published via UDP.
161
+ #
162
+ # @option options [Integer] :client_side_monitoring_port (31000)
163
+ # Required for publishing client metrics. The port that the client side monitoring
164
+ # agent is running on, where client metrics will be published via UDP.
165
+ #
166
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
167
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
168
+ # will use the Client Side Monitoring Agent Publisher.
169
+ #
170
+ # @option options [Boolean] :convert_params (true)
171
+ # When `true`, an attempt is made to coerce request parameters into
172
+ # the required types.
173
+ #
174
+ # @option options [Boolean] :correct_clock_skew (true)
175
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
176
+ # a clock skew correction and retry requests with skewed client clocks.
177
+ #
178
+ # @option options [Boolean] :disable_host_prefix_injection (false)
179
+ # Set to true to disable SDK automatically adding host prefix
180
+ # to default service endpoint when available.
181
+ #
182
+ # @option options [String] :endpoint
183
+ # The client endpoint is normally constructed from the `:region`
184
+ # option. You should only configure an `:endpoint` when connecting
185
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
186
+ #
187
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
188
+ # Used for the maximum size limit of the LRU cache storing endpoints data
189
+ # for endpoint discovery enabled operations. Defaults to 1000.
190
+ #
191
+ # @option options [Integer] :endpoint_cache_max_threads (10)
192
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
193
+ #
194
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
195
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
196
+ # Use this option to config the time interval in seconds for making
197
+ # requests fetching endpoints information. Defaults to 60 sec.
198
+ #
199
+ # @option options [Boolean] :endpoint_discovery (false)
200
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
201
+ #
202
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
203
+ # The log formatter.
204
+ #
205
+ # @option options [Symbol] :log_level (:info)
206
+ # The log level to send messages to the `:logger` at.
207
+ #
208
+ # @option options [Logger] :logger
209
+ # The Logger instance to send log messages to. If this option
210
+ # is not set, logging will be disabled.
211
+ #
212
+ # @option options [Integer] :max_attempts (3)
213
+ # An integer representing the maximum number attempts that will be made for
214
+ # a single request, including the initial attempt. For example,
215
+ # setting this value to 5 will result in a request being retried up to
216
+ # 4 times. Used in `standard` and `adaptive` retry modes.
217
+ #
218
+ # @option options [String] :profile ("default")
219
+ # Used when loading credentials from the shared credentials file
220
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
221
+ #
222
+ # @option options [Proc] :retry_backoff
223
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
224
+ # This option is only used in the `legacy` retry mode.
225
+ #
226
+ # @option options [Float] :retry_base_delay (0.3)
227
+ # The base delay in seconds used by the default backoff function. This option
228
+ # is only used in the `legacy` retry mode.
229
+ #
230
+ # @option options [Symbol] :retry_jitter (:none)
231
+ # A delay randomiser function used by the default backoff function.
232
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
233
+ # otherwise a Proc that takes and returns a number. This option is only used
234
+ # in the `legacy` retry mode.
235
+ #
236
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
237
+ #
238
+ # @option options [Integer] :retry_limit (3)
239
+ # The maximum number of times to retry failed requests. Only
240
+ # ~ 500 level server errors and certain ~ 400 level client errors
241
+ # are retried. Generally, these are throttling errors, data
242
+ # checksum errors, networking errors, timeout errors, auth errors,
243
+ # endpoint discovery, and errors from expired credentials.
244
+ # This option is only used in the `legacy` retry mode.
245
+ #
246
+ # @option options [Integer] :retry_max_delay (0)
247
+ # The maximum number of seconds to delay between retries (0 for no limit)
248
+ # used by the default backoff function. This option is only used in the
249
+ # `legacy` retry mode.
250
+ #
251
+ # @option options [String] :retry_mode ("legacy")
252
+ # Specifies which retry algorithm to use. Values are:
253
+ #
254
+ # * `legacy` - The pre-existing retry behavior. This is default value if
255
+ # no retry mode is provided.
256
+ #
257
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
258
+ # This includes support for retry quotas, which limit the number of
259
+ # unsuccessful retries a client can make.
260
+ #
261
+ # * `adaptive` - An experimental retry mode that includes all the
262
+ # functionality of `standard` mode along with automatic client side
263
+ # throttling. This is a provisional mode that may change behavior
264
+ # in the future.
265
+ #
266
+ #
267
+ # @option options [String] :secret_access_key
268
+ #
269
+ # @option options [String] :session_token
270
+ #
271
+ # @option options [Boolean] :stub_responses (false)
272
+ # Causes the client to return stubbed responses. By default
273
+ # fake responses are generated and returned. You can specify
274
+ # the response data to return or errors to raise by calling
275
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
276
+ #
277
+ # ** Please note ** When response stubbing is enabled, no HTTP
278
+ # requests are made, and retries are disabled.
279
+ #
280
+ # @option options [Boolean] :use_dualstack_endpoint
281
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
282
+ # will be used if available.
283
+ #
284
+ # @option options [Boolean] :use_fips_endpoint
285
+ # When set to `true`, fips compatible endpoints will be used if available.
286
+ # When a `fips` region is used, the region is normalized and this config
287
+ # is set to `true`.
288
+ #
289
+ # @option options [Boolean] :validate_params (true)
290
+ # When `true`, request parameters are validated before
291
+ # sending the request.
292
+ #
293
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
294
+ # requests through. Formatted like 'http://proxy.com:123'.
295
+ #
296
+ # @option options [Float] :http_open_timeout (15) The number of
297
+ # seconds to wait when opening a HTTP session before raising a
298
+ # `Timeout::Error`.
299
+ #
300
+ # @option options [Integer] :http_read_timeout (60) The default
301
+ # number of seconds to wait for response data. This value can
302
+ # safely be set per-request on the session.
303
+ #
304
+ # @option options [Float] :http_idle_timeout (5) The number of
305
+ # seconds a connection is allowed to sit idle before it is
306
+ # considered stale. Stale connections are closed and removed
307
+ # from the pool before making a request.
308
+ #
309
+ # @option options [Float] :http_continue_timeout (1) The number of
310
+ # seconds to wait for a 100-continue response before sending the
311
+ # request body. This option has no effect unless the request has
312
+ # "Expect" header set to "100-continue". Defaults to `nil` which
313
+ # disables this behaviour. This value can safely be set per
314
+ # request on the session.
315
+ #
316
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
317
+ # HTTP debug output will be sent to the `:logger`.
318
+ #
319
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
320
+ # SSL peer certificates are verified when establishing a
321
+ # connection.
322
+ #
323
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
324
+ # certificate authority bundle file that should be used when
325
+ # verifying peer certificates. If you do not pass
326
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
327
+ # will be used if available.
328
+ #
329
+ # @option options [String] :ssl_ca_directory Full path of the
330
+ # directory that contains the unbundled SSL certificate
331
+ # authority files for verifying peer certificates. If you do
332
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
333
+ # system default will be used if available.
334
+ #
335
+ def initialize(*args)
336
+ super
337
+ end
338
+
339
+ # @!group API Operations
340
+
341
+ # Associates a browser settings resource with a web portal.
342
+ #
343
+ # @option params [required, String] :browser_settings_arn
344
+ # The ARN of the browser settings.
345
+ #
346
+ # @option params [required, String] :portal_arn
347
+ # The ARN of the web portal.
348
+ #
349
+ # @return [Types::AssociateBrowserSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
350
+ #
351
+ # * {Types::AssociateBrowserSettingsResponse#browser_settings_arn #browser_settings_arn} => String
352
+ # * {Types::AssociateBrowserSettingsResponse#portal_arn #portal_arn} => String
353
+ #
354
+ # @example Request syntax with placeholder values
355
+ #
356
+ # resp = client.associate_browser_settings({
357
+ # browser_settings_arn: "ARN", # required
358
+ # portal_arn: "ARN", # required
359
+ # })
360
+ #
361
+ # @example Response structure
362
+ #
363
+ # resp.browser_settings_arn #=> String
364
+ # resp.portal_arn #=> String
365
+ #
366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AssociateBrowserSettings AWS API Documentation
367
+ #
368
+ # @overload associate_browser_settings(params = {})
369
+ # @param [Hash] params ({})
370
+ def associate_browser_settings(params = {}, options = {})
371
+ req = build_request(:associate_browser_settings, params)
372
+ req.send_request(options)
373
+ end
374
+
375
+ # Associates a network settings resource with a web portal.
376
+ #
377
+ # @option params [required, String] :network_settings_arn
378
+ # The ARN of the network settings.
379
+ #
380
+ # @option params [required, String] :portal_arn
381
+ # The ARN of the web portal.
382
+ #
383
+ # @return [Types::AssociateNetworkSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
384
+ #
385
+ # * {Types::AssociateNetworkSettingsResponse#network_settings_arn #network_settings_arn} => String
386
+ # * {Types::AssociateNetworkSettingsResponse#portal_arn #portal_arn} => String
387
+ #
388
+ # @example Request syntax with placeholder values
389
+ #
390
+ # resp = client.associate_network_settings({
391
+ # network_settings_arn: "ARN", # required
392
+ # portal_arn: "ARN", # required
393
+ # })
394
+ #
395
+ # @example Response structure
396
+ #
397
+ # resp.network_settings_arn #=> String
398
+ # resp.portal_arn #=> String
399
+ #
400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AssociateNetworkSettings AWS API Documentation
401
+ #
402
+ # @overload associate_network_settings(params = {})
403
+ # @param [Hash] params ({})
404
+ def associate_network_settings(params = {}, options = {})
405
+ req = build_request(:associate_network_settings, params)
406
+ req.send_request(options)
407
+ end
408
+
409
+ # Associates a trust store with a web portal.
410
+ #
411
+ # @option params [required, String] :portal_arn
412
+ # The ARN of the web portal.
413
+ #
414
+ # @option params [required, String] :trust_store_arn
415
+ # The ARN of the trust store.
416
+ #
417
+ # @return [Types::AssociateTrustStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
418
+ #
419
+ # * {Types::AssociateTrustStoreResponse#portal_arn #portal_arn} => String
420
+ # * {Types::AssociateTrustStoreResponse#trust_store_arn #trust_store_arn} => String
421
+ #
422
+ # @example Request syntax with placeholder values
423
+ #
424
+ # resp = client.associate_trust_store({
425
+ # portal_arn: "ARN", # required
426
+ # trust_store_arn: "ARN", # required
427
+ # })
428
+ #
429
+ # @example Response structure
430
+ #
431
+ # resp.portal_arn #=> String
432
+ # resp.trust_store_arn #=> String
433
+ #
434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AssociateTrustStore AWS API Documentation
435
+ #
436
+ # @overload associate_trust_store(params = {})
437
+ # @param [Hash] params ({})
438
+ def associate_trust_store(params = {}, options = {})
439
+ req = build_request(:associate_trust_store, params)
440
+ req.send_request(options)
441
+ end
442
+
443
+ # Associates a user settings resource with a web portal.
444
+ #
445
+ # @option params [required, String] :portal_arn
446
+ # The ARN of the web portal.
447
+ #
448
+ # @option params [required, String] :user_settings_arn
449
+ # The ARN of the user settings.
450
+ #
451
+ # @return [Types::AssociateUserSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
452
+ #
453
+ # * {Types::AssociateUserSettingsResponse#portal_arn #portal_arn} => String
454
+ # * {Types::AssociateUserSettingsResponse#user_settings_arn #user_settings_arn} => String
455
+ #
456
+ # @example Request syntax with placeholder values
457
+ #
458
+ # resp = client.associate_user_settings({
459
+ # portal_arn: "ARN", # required
460
+ # user_settings_arn: "ARN", # required
461
+ # })
462
+ #
463
+ # @example Response structure
464
+ #
465
+ # resp.portal_arn #=> String
466
+ # resp.user_settings_arn #=> String
467
+ #
468
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AssociateUserSettings AWS API Documentation
469
+ #
470
+ # @overload associate_user_settings(params = {})
471
+ # @param [Hash] params ({})
472
+ def associate_user_settings(params = {}, options = {})
473
+ req = build_request(:associate_user_settings, params)
474
+ req.send_request(options)
475
+ end
476
+
477
+ # Creates a browser settings resource that can be associated with a web
478
+ # portal. Once associated with a web portal, browser settings control
479
+ # how the browser will behave once a user starts a streaming session for
480
+ # the web portal.
481
+ #
482
+ # @option params [Hash<String,String>] :additional_encryption_context
483
+ # Additional encryption context of the browser settings.
484
+ #
485
+ # @option params [required, String] :browser_policy
486
+ # A JSON string containing Chrome Enterprise policies that will be
487
+ # applied to all streaming sessions.
488
+ #
489
+ # @option params [String] :client_token
490
+ # A unique, case-sensitive identifier that you provide to ensure the
491
+ # idempotency of the request. Idempotency ensures that an API request
492
+ # completes only once. With an idempotent request, if the original
493
+ # request completes successfully, subsequent retries with the same
494
+ # client token returns the result from the original successful request.
495
+ #
496
+ # If you do not specify a client token, one is automatically generated
497
+ # by the AWS SDK.
498
+ #
499
+ # **A suitable default value is auto-generated.** You should normally
500
+ # not need to pass this option.**
501
+ #
502
+ # @option params [String] :customer_managed_key
503
+ # The custom managed key of the browser settings.
504
+ #
505
+ # @option params [Array<Types::Tag>] :tags
506
+ # The tags to add to the browser settings resource. A tag is a key-value
507
+ # pair.
508
+ #
509
+ # @return [Types::CreateBrowserSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
510
+ #
511
+ # * {Types::CreateBrowserSettingsResponse#browser_settings_arn #browser_settings_arn} => String
512
+ #
513
+ # @example Request syntax with placeholder values
514
+ #
515
+ # resp = client.create_browser_settings({
516
+ # additional_encryption_context: {
517
+ # "StringType" => "StringType",
518
+ # },
519
+ # browser_policy: "BrowserPolicy", # required
520
+ # client_token: "ClientToken",
521
+ # customer_managed_key: "keyArn",
522
+ # tags: [
523
+ # {
524
+ # key: "TagKey", # required
525
+ # value: "TagValue", # required
526
+ # },
527
+ # ],
528
+ # })
529
+ #
530
+ # @example Response structure
531
+ #
532
+ # resp.browser_settings_arn #=> String
533
+ #
534
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateBrowserSettings AWS API Documentation
535
+ #
536
+ # @overload create_browser_settings(params = {})
537
+ # @param [Hash] params ({})
538
+ def create_browser_settings(params = {}, options = {})
539
+ req = build_request(:create_browser_settings, params)
540
+ req.send_request(options)
541
+ end
542
+
543
+ # Creates an identity provider resource that is then associated with a
544
+ # web portal.
545
+ #
546
+ # @option params [String] :client_token
547
+ # A unique, case-sensitive identifier that you provide to ensure the
548
+ # idempotency of the request. Idempotency ensures that an API request
549
+ # completes only once. With an idempotent request, if the original
550
+ # request completes successfully, subsequent retries with the same
551
+ # client token returns the result from the original successful request.
552
+ #
553
+ # If you do not specify a client token, one is automatically generated
554
+ # by the AWS SDK.
555
+ #
556
+ # **A suitable default value is auto-generated.** You should normally
557
+ # not need to pass this option.**
558
+ #
559
+ # @option params [required, Hash<String,String>] :identity_provider_details
560
+ # The identity provider details. The following list describes the
561
+ # provider detail keys for each identity provider type.
562
+ #
563
+ # * For Google and Login with Amazon:
564
+ #
565
+ # * `client_id`
566
+ #
567
+ # * `client_secret`
568
+ #
569
+ # * `authorize_scopes`
570
+ #
571
+ # * For Facebook:
572
+ #
573
+ # * `client_id`
574
+ #
575
+ # * `client_secret`
576
+ #
577
+ # * `authorize_scopes`
578
+ #
579
+ # * `api_version`
580
+ #
581
+ # * For Sign in with Apple:
582
+ #
583
+ # * `client_id`
584
+ #
585
+ # * `team_id`
586
+ #
587
+ # * `key_id`
588
+ #
589
+ # * `private_key`
590
+ #
591
+ # * `authorize_scopes`
592
+ #
593
+ # * For OIDC providers:
594
+ #
595
+ # * `client_id`
596
+ #
597
+ # * `client_secret`
598
+ #
599
+ # * `attributes_request_method`
600
+ #
601
+ # * `oidc_issuer`
602
+ #
603
+ # * `authorize_scopes`
604
+ #
605
+ # * `authorize_url` *if not available from discovery URL specified by
606
+ # `oidc_issuer` key*
607
+ #
608
+ # * `token_url` *if not available from discovery URL specified by
609
+ # `oidc_issuer` key*
610
+ #
611
+ # * `attributes_url` *if not available from discovery URL specified by
612
+ # `oidc_issuer` key*
613
+ #
614
+ # * `jwks_uri` *if not available from discovery URL specified by
615
+ # `oidc_issuer` key*
616
+ #
617
+ # * For SAML providers:
618
+ #
619
+ # * `MetadataFile` OR `MetadataURL`
620
+ #
621
+ # * `IDPSignout` *optional*
622
+ #
623
+ # @option params [required, String] :identity_provider_name
624
+ # The identity provider name.
625
+ #
626
+ # @option params [required, String] :identity_provider_type
627
+ # The identity provider type.
628
+ #
629
+ # @option params [required, String] :portal_arn
630
+ # The ARN of the web portal.
631
+ #
632
+ # @return [Types::CreateIdentityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
633
+ #
634
+ # * {Types::CreateIdentityProviderResponse#identity_provider_arn #identity_provider_arn} => String
635
+ #
636
+ # @example Request syntax with placeholder values
637
+ #
638
+ # resp = client.create_identity_provider({
639
+ # client_token: "ClientToken",
640
+ # identity_provider_details: { # required
641
+ # "StringType" => "StringType",
642
+ # },
643
+ # identity_provider_name: "IdentityProviderName", # required
644
+ # identity_provider_type: "SAML", # required, accepts SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
645
+ # portal_arn: "ARN", # required
646
+ # })
647
+ #
648
+ # @example Response structure
649
+ #
650
+ # resp.identity_provider_arn #=> String
651
+ #
652
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateIdentityProvider AWS API Documentation
653
+ #
654
+ # @overload create_identity_provider(params = {})
655
+ # @param [Hash] params ({})
656
+ def create_identity_provider(params = {}, options = {})
657
+ req = build_request(:create_identity_provider, params)
658
+ req.send_request(options)
659
+ end
660
+
661
+ # Creates a network settings resource that can be associated with a web
662
+ # portal. Once associated with a web portal, network settings define how
663
+ # streaming instances will connect with your specified VPC.
664
+ #
665
+ # @option params [String] :client_token
666
+ # A unique, case-sensitive identifier that you provide to ensure the
667
+ # idempotency of the request. Idempotency ensures that an API request
668
+ # completes only once. With an idempotent request, if the original
669
+ # request completes successfully, subsequent retries with the same
670
+ # client token returns the result from the original successful request.
671
+ #
672
+ # If you do not specify a client token, one is automatically generated
673
+ # by the AWS SDK.
674
+ #
675
+ # **A suitable default value is auto-generated.** You should normally
676
+ # not need to pass this option.**
677
+ #
678
+ # @option params [required, Array<String>] :security_group_ids
679
+ # One or more security groups used to control access from streaming
680
+ # instances to your VPC.
681
+ #
682
+ # @option params [required, Array<String>] :subnet_ids
683
+ # The subnets in which network interfaces are created to connect
684
+ # streaming instances to your VPC. At least two of these subnets must be
685
+ # in different availability zones.
686
+ #
687
+ # @option params [Array<Types::Tag>] :tags
688
+ # The tags to add to the network settings resource. A tag is a key-value
689
+ # pair.
690
+ #
691
+ # @option params [required, String] :vpc_id
692
+ # The VPC that streaming instances will connect to.
693
+ #
694
+ # @return [Types::CreateNetworkSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
695
+ #
696
+ # * {Types::CreateNetworkSettingsResponse#network_settings_arn #network_settings_arn} => String
697
+ #
698
+ # @example Request syntax with placeholder values
699
+ #
700
+ # resp = client.create_network_settings({
701
+ # client_token: "ClientToken",
702
+ # security_group_ids: ["SecurityGroupId"], # required
703
+ # subnet_ids: ["SubnetId"], # required
704
+ # tags: [
705
+ # {
706
+ # key: "TagKey", # required
707
+ # value: "TagValue", # required
708
+ # },
709
+ # ],
710
+ # vpc_id: "VpcId", # required
711
+ # })
712
+ #
713
+ # @example Response structure
714
+ #
715
+ # resp.network_settings_arn #=> String
716
+ #
717
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateNetworkSettings AWS API Documentation
718
+ #
719
+ # @overload create_network_settings(params = {})
720
+ # @param [Hash] params ({})
721
+ def create_network_settings(params = {}, options = {})
722
+ req = build_request(:create_network_settings, params)
723
+ req.send_request(options)
724
+ end
725
+
726
+ # Creates a web portal.
727
+ #
728
+ # @option params [Hash<String,String>] :additional_encryption_context
729
+ # The additional encryption context of the portal.
730
+ #
731
+ # @option params [String] :client_token
732
+ # A unique, case-sensitive identifier that you provide to ensure the
733
+ # idempotency of the request. Idempotency ensures that an API request
734
+ # completes only once. With an idempotent request, if the original
735
+ # request completes successfully, subsequent retries with the same
736
+ # client token returns the result from the original successful request.
737
+ #
738
+ # If you do not specify a client token, one is automatically generated
739
+ # by the AWS SDK.
740
+ #
741
+ # **A suitable default value is auto-generated.** You should normally
742
+ # not need to pass this option.**
743
+ #
744
+ # @option params [String] :customer_managed_key
745
+ # The customer managed key of the web portal.
746
+ #
747
+ # @option params [String] :display_name
748
+ # The name of the web portal. This is not visible to users who log into
749
+ # the web portal.
750
+ #
751
+ # @option params [Array<Types::Tag>] :tags
752
+ # The tags to add to the web portal. A tag is a key-value pair.
753
+ #
754
+ # @return [Types::CreatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
755
+ #
756
+ # * {Types::CreatePortalResponse#portal_arn #portal_arn} => String
757
+ # * {Types::CreatePortalResponse#portal_endpoint #portal_endpoint} => String
758
+ #
759
+ # @example Request syntax with placeholder values
760
+ #
761
+ # resp = client.create_portal({
762
+ # additional_encryption_context: {
763
+ # "StringType" => "StringType",
764
+ # },
765
+ # client_token: "ClientToken",
766
+ # customer_managed_key: "keyArn",
767
+ # display_name: "DisplayName",
768
+ # tags: [
769
+ # {
770
+ # key: "TagKey", # required
771
+ # value: "TagValue", # required
772
+ # },
773
+ # ],
774
+ # })
775
+ #
776
+ # @example Response structure
777
+ #
778
+ # resp.portal_arn #=> String
779
+ # resp.portal_endpoint #=> String
780
+ #
781
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreatePortal AWS API Documentation
782
+ #
783
+ # @overload create_portal(params = {})
784
+ # @param [Hash] params ({})
785
+ def create_portal(params = {}, options = {})
786
+ req = build_request(:create_portal, params)
787
+ req.send_request(options)
788
+ end
789
+
790
+ # Creates a trust store that can be associated with a web portal. A
791
+ # trust store contains certificate authority (CA) certificates. Once
792
+ # associated with a web portal, the browser in a streaming session will
793
+ # recognize certificates that have been issued using any of the CAs in
794
+ # the trust store. If your organization has internal websites that use
795
+ # certificates issued by private CAs, you should add the private CA
796
+ # certificate to the trust store.
797
+ #
798
+ # @option params [required, Array<String, StringIO, File>] :certificate_list
799
+ # A list of CA certificates to be added to the trust store.
800
+ #
801
+ # @option params [String] :client_token
802
+ # A unique, case-sensitive identifier that you provide to ensure the
803
+ # idempotency of the request. Idempotency ensures that an API request
804
+ # completes only once. With an idempotent request, if the original
805
+ # request completes successfully, subsequent retries with the same
806
+ # client token returns the result from the original successful request.
807
+ #
808
+ # If you do not specify a client token, one is automatically generated
809
+ # by the AWS SDK.
810
+ #
811
+ # **A suitable default value is auto-generated.** You should normally
812
+ # not need to pass this option.**
813
+ #
814
+ # @option params [Array<Types::Tag>] :tags
815
+ # The tags to add to the trust store. A tag is a key-value pair.
816
+ #
817
+ # @return [Types::CreateTrustStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
818
+ #
819
+ # * {Types::CreateTrustStoreResponse#trust_store_arn #trust_store_arn} => String
820
+ #
821
+ # @example Request syntax with placeholder values
822
+ #
823
+ # resp = client.create_trust_store({
824
+ # certificate_list: ["data"], # required
825
+ # client_token: "ClientToken",
826
+ # tags: [
827
+ # {
828
+ # key: "TagKey", # required
829
+ # value: "TagValue", # required
830
+ # },
831
+ # ],
832
+ # })
833
+ #
834
+ # @example Response structure
835
+ #
836
+ # resp.trust_store_arn #=> String
837
+ #
838
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateTrustStore AWS API Documentation
839
+ #
840
+ # @overload create_trust_store(params = {})
841
+ # @param [Hash] params ({})
842
+ def create_trust_store(params = {}, options = {})
843
+ req = build_request(:create_trust_store, params)
844
+ req.send_request(options)
845
+ end
846
+
847
+ # Creates a user settings resource that can be associated with a web
848
+ # portal. Once associated with a web portal, user settings control how
849
+ # users can transfer data between a streaming session and the their
850
+ # local devices.
851
+ #
852
+ # @option params [String] :client_token
853
+ # A unique, case-sensitive identifier that you provide to ensure the
854
+ # idempotency of the request. Idempotency ensures that an API request
855
+ # completes only once. With an idempotent request, if the original
856
+ # request completes successfully, subsequent retries with the same
857
+ # client token returns the result from the original successful request.
858
+ #
859
+ # If you do not specify a client token, one is automatically generated
860
+ # by the AWS SDK.
861
+ #
862
+ # **A suitable default value is auto-generated.** You should normally
863
+ # not need to pass this option.**
864
+ #
865
+ # @option params [required, String] :copy_allowed
866
+ # Specifies whether the user can copy text from the streaming session to
867
+ # the local device.
868
+ #
869
+ # @option params [required, String] :download_allowed
870
+ # Specifies whether the user can download files from the streaming
871
+ # session to the local device.
872
+ #
873
+ # @option params [required, String] :paste_allowed
874
+ # Specifies whether the user can paste text from the local device to the
875
+ # streaming session.
876
+ #
877
+ # @option params [required, String] :print_allowed
878
+ # Specifies whether the user can print to the local device.
879
+ #
880
+ # @option params [Array<Types::Tag>] :tags
881
+ # The tags to add to the user settings resource. A tag is a key-value
882
+ # pair.
883
+ #
884
+ # @option params [required, String] :upload_allowed
885
+ # Specifies whether the user can upload files from the local device to
886
+ # the streaming session.
887
+ #
888
+ # @return [Types::CreateUserSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
889
+ #
890
+ # * {Types::CreateUserSettingsResponse#user_settings_arn #user_settings_arn} => String
891
+ #
892
+ # @example Request syntax with placeholder values
893
+ #
894
+ # resp = client.create_user_settings({
895
+ # client_token: "ClientToken",
896
+ # copy_allowed: "Disabled", # required, accepts Disabled, Enabled
897
+ # download_allowed: "Disabled", # required, accepts Disabled, Enabled
898
+ # paste_allowed: "Disabled", # required, accepts Disabled, Enabled
899
+ # print_allowed: "Disabled", # required, accepts Disabled, Enabled
900
+ # tags: [
901
+ # {
902
+ # key: "TagKey", # required
903
+ # value: "TagValue", # required
904
+ # },
905
+ # ],
906
+ # upload_allowed: "Disabled", # required, accepts Disabled, Enabled
907
+ # })
908
+ #
909
+ # @example Response structure
910
+ #
911
+ # resp.user_settings_arn #=> String
912
+ #
913
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateUserSettings AWS API Documentation
914
+ #
915
+ # @overload create_user_settings(params = {})
916
+ # @param [Hash] params ({})
917
+ def create_user_settings(params = {}, options = {})
918
+ req = build_request(:create_user_settings, params)
919
+ req.send_request(options)
920
+ end
921
+
922
+ # Deletes browser settings.
923
+ #
924
+ # @option params [required, String] :browser_settings_arn
925
+ # The ARN of the browser settings.
926
+ #
927
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
928
+ #
929
+ # @example Request syntax with placeholder values
930
+ #
931
+ # resp = client.delete_browser_settings({
932
+ # browser_settings_arn: "ARN", # required
933
+ # })
934
+ #
935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteBrowserSettings AWS API Documentation
936
+ #
937
+ # @overload delete_browser_settings(params = {})
938
+ # @param [Hash] params ({})
939
+ def delete_browser_settings(params = {}, options = {})
940
+ req = build_request(:delete_browser_settings, params)
941
+ req.send_request(options)
942
+ end
943
+
944
+ # Deletes the identity provider.
945
+ #
946
+ # @option params [required, String] :identity_provider_arn
947
+ # The ARN of the identity provider.
948
+ #
949
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
950
+ #
951
+ # @example Request syntax with placeholder values
952
+ #
953
+ # resp = client.delete_identity_provider({
954
+ # identity_provider_arn: "ARN", # required
955
+ # })
956
+ #
957
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteIdentityProvider AWS API Documentation
958
+ #
959
+ # @overload delete_identity_provider(params = {})
960
+ # @param [Hash] params ({})
961
+ def delete_identity_provider(params = {}, options = {})
962
+ req = build_request(:delete_identity_provider, params)
963
+ req.send_request(options)
964
+ end
965
+
966
+ # Deletes network settings.
967
+ #
968
+ # @option params [required, String] :network_settings_arn
969
+ # The ARN of the network settings.
970
+ #
971
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
972
+ #
973
+ # @example Request syntax with placeholder values
974
+ #
975
+ # resp = client.delete_network_settings({
976
+ # network_settings_arn: "ARN", # required
977
+ # })
978
+ #
979
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteNetworkSettings AWS API Documentation
980
+ #
981
+ # @overload delete_network_settings(params = {})
982
+ # @param [Hash] params ({})
983
+ def delete_network_settings(params = {}, options = {})
984
+ req = build_request(:delete_network_settings, params)
985
+ req.send_request(options)
986
+ end
987
+
988
+ # Deletes a web portal.
989
+ #
990
+ # @option params [required, String] :portal_arn
991
+ # The ARN of the web portal.
992
+ #
993
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
994
+ #
995
+ # @example Request syntax with placeholder values
996
+ #
997
+ # resp = client.delete_portal({
998
+ # portal_arn: "ARN", # required
999
+ # })
1000
+ #
1001
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeletePortal AWS API Documentation
1002
+ #
1003
+ # @overload delete_portal(params = {})
1004
+ # @param [Hash] params ({})
1005
+ def delete_portal(params = {}, options = {})
1006
+ req = build_request(:delete_portal, params)
1007
+ req.send_request(options)
1008
+ end
1009
+
1010
+ # Deletes the trust store.
1011
+ #
1012
+ # @option params [required, String] :trust_store_arn
1013
+ # The ARN of the trust store.
1014
+ #
1015
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1016
+ #
1017
+ # @example Request syntax with placeholder values
1018
+ #
1019
+ # resp = client.delete_trust_store({
1020
+ # trust_store_arn: "ARN", # required
1021
+ # })
1022
+ #
1023
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteTrustStore AWS API Documentation
1024
+ #
1025
+ # @overload delete_trust_store(params = {})
1026
+ # @param [Hash] params ({})
1027
+ def delete_trust_store(params = {}, options = {})
1028
+ req = build_request(:delete_trust_store, params)
1029
+ req.send_request(options)
1030
+ end
1031
+
1032
+ # Deletes user settings.
1033
+ #
1034
+ # @option params [required, String] :user_settings_arn
1035
+ # The ARN of the user settings.
1036
+ #
1037
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1038
+ #
1039
+ # @example Request syntax with placeholder values
1040
+ #
1041
+ # resp = client.delete_user_settings({
1042
+ # user_settings_arn: "ARN", # required
1043
+ # })
1044
+ #
1045
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteUserSettings AWS API Documentation
1046
+ #
1047
+ # @overload delete_user_settings(params = {})
1048
+ # @param [Hash] params ({})
1049
+ def delete_user_settings(params = {}, options = {})
1050
+ req = build_request(:delete_user_settings, params)
1051
+ req.send_request(options)
1052
+ end
1053
+
1054
+ # Disassociates browser settings from a web portal.
1055
+ #
1056
+ # @option params [required, String] :portal_arn
1057
+ # The ARN of the web portal.
1058
+ #
1059
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1060
+ #
1061
+ # @example Request syntax with placeholder values
1062
+ #
1063
+ # resp = client.disassociate_browser_settings({
1064
+ # portal_arn: "ARN", # required
1065
+ # })
1066
+ #
1067
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DisassociateBrowserSettings AWS API Documentation
1068
+ #
1069
+ # @overload disassociate_browser_settings(params = {})
1070
+ # @param [Hash] params ({})
1071
+ def disassociate_browser_settings(params = {}, options = {})
1072
+ req = build_request(:disassociate_browser_settings, params)
1073
+ req.send_request(options)
1074
+ end
1075
+
1076
+ # Disassociates network settings from a web portal.
1077
+ #
1078
+ # @option params [required, String] :portal_arn
1079
+ # The ARN of the web portal.
1080
+ #
1081
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1082
+ #
1083
+ # @example Request syntax with placeholder values
1084
+ #
1085
+ # resp = client.disassociate_network_settings({
1086
+ # portal_arn: "ARN", # required
1087
+ # })
1088
+ #
1089
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DisassociateNetworkSettings AWS API Documentation
1090
+ #
1091
+ # @overload disassociate_network_settings(params = {})
1092
+ # @param [Hash] params ({})
1093
+ def disassociate_network_settings(params = {}, options = {})
1094
+ req = build_request(:disassociate_network_settings, params)
1095
+ req.send_request(options)
1096
+ end
1097
+
1098
+ # Disassociates a trust store from a web portal.
1099
+ #
1100
+ # @option params [required, String] :portal_arn
1101
+ # The ARN of the web portal.
1102
+ #
1103
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1104
+ #
1105
+ # @example Request syntax with placeholder values
1106
+ #
1107
+ # resp = client.disassociate_trust_store({
1108
+ # portal_arn: "ARN", # required
1109
+ # })
1110
+ #
1111
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DisassociateTrustStore AWS API Documentation
1112
+ #
1113
+ # @overload disassociate_trust_store(params = {})
1114
+ # @param [Hash] params ({})
1115
+ def disassociate_trust_store(params = {}, options = {})
1116
+ req = build_request(:disassociate_trust_store, params)
1117
+ req.send_request(options)
1118
+ end
1119
+
1120
+ # Disassociates user settings from a web portal.
1121
+ #
1122
+ # @option params [required, String] :portal_arn
1123
+ # The ARN of the web portal.
1124
+ #
1125
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1126
+ #
1127
+ # @example Request syntax with placeholder values
1128
+ #
1129
+ # resp = client.disassociate_user_settings({
1130
+ # portal_arn: "ARN", # required
1131
+ # })
1132
+ #
1133
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DisassociateUserSettings AWS API Documentation
1134
+ #
1135
+ # @overload disassociate_user_settings(params = {})
1136
+ # @param [Hash] params ({})
1137
+ def disassociate_user_settings(params = {}, options = {})
1138
+ req = build_request(:disassociate_user_settings, params)
1139
+ req.send_request(options)
1140
+ end
1141
+
1142
+ # Gets browser settings.
1143
+ #
1144
+ # @option params [required, String] :browser_settings_arn
1145
+ # The ARN of the browser settings.
1146
+ #
1147
+ # @return [Types::GetBrowserSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1148
+ #
1149
+ # * {Types::GetBrowserSettingsResponse#browser_settings #browser_settings} => Types::BrowserSettings
1150
+ #
1151
+ # @example Request syntax with placeholder values
1152
+ #
1153
+ # resp = client.get_browser_settings({
1154
+ # browser_settings_arn: "ARN", # required
1155
+ # })
1156
+ #
1157
+ # @example Response structure
1158
+ #
1159
+ # resp.browser_settings.associated_portal_arns #=> Array
1160
+ # resp.browser_settings.associated_portal_arns[0] #=> String
1161
+ # resp.browser_settings.browser_policy #=> String
1162
+ # resp.browser_settings.browser_settings_arn #=> String
1163
+ #
1164
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetBrowserSettings AWS API Documentation
1165
+ #
1166
+ # @overload get_browser_settings(params = {})
1167
+ # @param [Hash] params ({})
1168
+ def get_browser_settings(params = {}, options = {})
1169
+ req = build_request(:get_browser_settings, params)
1170
+ req.send_request(options)
1171
+ end
1172
+
1173
+ # Gets the identity provider.
1174
+ #
1175
+ # @option params [required, String] :identity_provider_arn
1176
+ # The ARN of the identity provider.
1177
+ #
1178
+ # @return [Types::GetIdentityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1179
+ #
1180
+ # * {Types::GetIdentityProviderResponse#identity_provider #identity_provider} => Types::IdentityProvider
1181
+ #
1182
+ # @example Request syntax with placeholder values
1183
+ #
1184
+ # resp = client.get_identity_provider({
1185
+ # identity_provider_arn: "ARN", # required
1186
+ # })
1187
+ #
1188
+ # @example Response structure
1189
+ #
1190
+ # resp.identity_provider.identity_provider_arn #=> String
1191
+ # resp.identity_provider.identity_provider_details #=> Hash
1192
+ # resp.identity_provider.identity_provider_details["StringType"] #=> String
1193
+ # resp.identity_provider.identity_provider_name #=> String
1194
+ # resp.identity_provider.identity_provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"
1195
+ #
1196
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetIdentityProvider AWS API Documentation
1197
+ #
1198
+ # @overload get_identity_provider(params = {})
1199
+ # @param [Hash] params ({})
1200
+ def get_identity_provider(params = {}, options = {})
1201
+ req = build_request(:get_identity_provider, params)
1202
+ req.send_request(options)
1203
+ end
1204
+
1205
+ # Gets the network settings.
1206
+ #
1207
+ # @option params [required, String] :network_settings_arn
1208
+ # The ARN of the network settings.
1209
+ #
1210
+ # @return [Types::GetNetworkSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1211
+ #
1212
+ # * {Types::GetNetworkSettingsResponse#network_settings #network_settings} => Types::NetworkSettings
1213
+ #
1214
+ # @example Request syntax with placeholder values
1215
+ #
1216
+ # resp = client.get_network_settings({
1217
+ # network_settings_arn: "ARN", # required
1218
+ # })
1219
+ #
1220
+ # @example Response structure
1221
+ #
1222
+ # resp.network_settings.associated_portal_arns #=> Array
1223
+ # resp.network_settings.associated_portal_arns[0] #=> String
1224
+ # resp.network_settings.network_settings_arn #=> String
1225
+ # resp.network_settings.security_group_ids #=> Array
1226
+ # resp.network_settings.security_group_ids[0] #=> String
1227
+ # resp.network_settings.subnet_ids #=> Array
1228
+ # resp.network_settings.subnet_ids[0] #=> String
1229
+ # resp.network_settings.vpc_id #=> String
1230
+ #
1231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetNetworkSettings AWS API Documentation
1232
+ #
1233
+ # @overload get_network_settings(params = {})
1234
+ # @param [Hash] params ({})
1235
+ def get_network_settings(params = {}, options = {})
1236
+ req = build_request(:get_network_settings, params)
1237
+ req.send_request(options)
1238
+ end
1239
+
1240
+ # Gets the web portal.
1241
+ #
1242
+ # @option params [required, String] :portal_arn
1243
+ # The ARN of the web portal.
1244
+ #
1245
+ # @return [Types::GetPortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1246
+ #
1247
+ # * {Types::GetPortalResponse#portal #portal} => Types::Portal
1248
+ #
1249
+ # @example Request syntax with placeholder values
1250
+ #
1251
+ # resp = client.get_portal({
1252
+ # portal_arn: "ARN", # required
1253
+ # })
1254
+ #
1255
+ # @example Response structure
1256
+ #
1257
+ # resp.portal.browser_settings_arn #=> String
1258
+ # resp.portal.browser_type #=> String, one of "Chrome"
1259
+ # resp.portal.creation_date #=> Time
1260
+ # resp.portal.display_name #=> String
1261
+ # resp.portal.network_settings_arn #=> String
1262
+ # resp.portal.portal_arn #=> String
1263
+ # resp.portal.portal_endpoint #=> String
1264
+ # resp.portal.portal_status #=> String, one of "Incomplete", "Pending", "Active"
1265
+ # resp.portal.renderer_type #=> String, one of "AppStream"
1266
+ # resp.portal.status_reason #=> String
1267
+ # resp.portal.trust_store_arn #=> String
1268
+ # resp.portal.user_settings_arn #=> String
1269
+ #
1270
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetPortal AWS API Documentation
1271
+ #
1272
+ # @overload get_portal(params = {})
1273
+ # @param [Hash] params ({})
1274
+ def get_portal(params = {}, options = {})
1275
+ req = build_request(:get_portal, params)
1276
+ req.send_request(options)
1277
+ end
1278
+
1279
+ # Gets the service provider metadata.
1280
+ #
1281
+ # @option params [required, String] :portal_arn
1282
+ # The ARN of the web portal.
1283
+ #
1284
+ # @return [Types::GetPortalServiceProviderMetadataResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1285
+ #
1286
+ # * {Types::GetPortalServiceProviderMetadataResponse#portal_arn #portal_arn} => String
1287
+ # * {Types::GetPortalServiceProviderMetadataResponse#service_provider_saml_metadata #service_provider_saml_metadata} => String
1288
+ #
1289
+ # @example Request syntax with placeholder values
1290
+ #
1291
+ # resp = client.get_portal_service_provider_metadata({
1292
+ # portal_arn: "ARN", # required
1293
+ # })
1294
+ #
1295
+ # @example Response structure
1296
+ #
1297
+ # resp.portal_arn #=> String
1298
+ # resp.service_provider_saml_metadata #=> String
1299
+ #
1300
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetPortalServiceProviderMetadata AWS API Documentation
1301
+ #
1302
+ # @overload get_portal_service_provider_metadata(params = {})
1303
+ # @param [Hash] params ({})
1304
+ def get_portal_service_provider_metadata(params = {}, options = {})
1305
+ req = build_request(:get_portal_service_provider_metadata, params)
1306
+ req.send_request(options)
1307
+ end
1308
+
1309
+ # Gets the trust store.
1310
+ #
1311
+ # @option params [required, String] :trust_store_arn
1312
+ # The ARN of the trust store.
1313
+ #
1314
+ # @return [Types::GetTrustStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1315
+ #
1316
+ # * {Types::GetTrustStoreResponse#trust_store #trust_store} => Types::TrustStore
1317
+ #
1318
+ # @example Request syntax with placeholder values
1319
+ #
1320
+ # resp = client.get_trust_store({
1321
+ # trust_store_arn: "ARN", # required
1322
+ # })
1323
+ #
1324
+ # @example Response structure
1325
+ #
1326
+ # resp.trust_store.associated_portal_arns #=> Array
1327
+ # resp.trust_store.associated_portal_arns[0] #=> String
1328
+ # resp.trust_store.trust_store_arn #=> String
1329
+ #
1330
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetTrustStore AWS API Documentation
1331
+ #
1332
+ # @overload get_trust_store(params = {})
1333
+ # @param [Hash] params ({})
1334
+ def get_trust_store(params = {}, options = {})
1335
+ req = build_request(:get_trust_store, params)
1336
+ req.send_request(options)
1337
+ end
1338
+
1339
+ # Gets the trust store certificate.
1340
+ #
1341
+ # @option params [required, String] :thumbprint
1342
+ # The thumbprint of the trust store certificate.
1343
+ #
1344
+ # @option params [required, String] :trust_store_arn
1345
+ # The ARN of the trust store certificate.
1346
+ #
1347
+ # @return [Types::GetTrustStoreCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1348
+ #
1349
+ # * {Types::GetTrustStoreCertificateResponse#certificate #certificate} => Types::Certificate
1350
+ # * {Types::GetTrustStoreCertificateResponse#trust_store_arn #trust_store_arn} => String
1351
+ #
1352
+ # @example Request syntax with placeholder values
1353
+ #
1354
+ # resp = client.get_trust_store_certificate({
1355
+ # thumbprint: "CertificateThumbprint", # required
1356
+ # trust_store_arn: "ARN", # required
1357
+ # })
1358
+ #
1359
+ # @example Response structure
1360
+ #
1361
+ # resp.certificate.body #=> String
1362
+ # resp.certificate.issuer #=> String
1363
+ # resp.certificate.not_valid_after #=> Time
1364
+ # resp.certificate.not_valid_before #=> Time
1365
+ # resp.certificate.subject #=> String
1366
+ # resp.certificate.thumbprint #=> String
1367
+ # resp.trust_store_arn #=> String
1368
+ #
1369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetTrustStoreCertificate AWS API Documentation
1370
+ #
1371
+ # @overload get_trust_store_certificate(params = {})
1372
+ # @param [Hash] params ({})
1373
+ def get_trust_store_certificate(params = {}, options = {})
1374
+ req = build_request(:get_trust_store_certificate, params)
1375
+ req.send_request(options)
1376
+ end
1377
+
1378
+ # Gets user settings.
1379
+ #
1380
+ # @option params [required, String] :user_settings_arn
1381
+ # The ARN of the user settings.
1382
+ #
1383
+ # @return [Types::GetUserSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1384
+ #
1385
+ # * {Types::GetUserSettingsResponse#user_settings #user_settings} => Types::UserSettings
1386
+ #
1387
+ # @example Request syntax with placeholder values
1388
+ #
1389
+ # resp = client.get_user_settings({
1390
+ # user_settings_arn: "ARN", # required
1391
+ # })
1392
+ #
1393
+ # @example Response structure
1394
+ #
1395
+ # resp.user_settings.associated_portal_arns #=> Array
1396
+ # resp.user_settings.associated_portal_arns[0] #=> String
1397
+ # resp.user_settings.copy_allowed #=> String, one of "Disabled", "Enabled"
1398
+ # resp.user_settings.download_allowed #=> String, one of "Disabled", "Enabled"
1399
+ # resp.user_settings.paste_allowed #=> String, one of "Disabled", "Enabled"
1400
+ # resp.user_settings.print_allowed #=> String, one of "Disabled", "Enabled"
1401
+ # resp.user_settings.upload_allowed #=> String, one of "Disabled", "Enabled"
1402
+ # resp.user_settings.user_settings_arn #=> String
1403
+ #
1404
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetUserSettings AWS API Documentation
1405
+ #
1406
+ # @overload get_user_settings(params = {})
1407
+ # @param [Hash] params ({})
1408
+ def get_user_settings(params = {}, options = {})
1409
+ req = build_request(:get_user_settings, params)
1410
+ req.send_request(options)
1411
+ end
1412
+
1413
+ # Retrieves a list of browser settings.
1414
+ #
1415
+ # @option params [Integer] :max_results
1416
+ # The maximum number of results to be included in the next page.
1417
+ #
1418
+ # @option params [String] :next_token
1419
+ # The pagination token used to retrieve the next page of results for
1420
+ # this operation.
1421
+ #
1422
+ # @return [Types::ListBrowserSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1423
+ #
1424
+ # * {Types::ListBrowserSettingsResponse#browser_settings #browser_settings} => Array&lt;Types::BrowserSettingsSummary&gt;
1425
+ # * {Types::ListBrowserSettingsResponse#next_token #next_token} => String
1426
+ #
1427
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1428
+ #
1429
+ # @example Request syntax with placeholder values
1430
+ #
1431
+ # resp = client.list_browser_settings({
1432
+ # max_results: 1,
1433
+ # next_token: "PaginationToken",
1434
+ # })
1435
+ #
1436
+ # @example Response structure
1437
+ #
1438
+ # resp.browser_settings #=> Array
1439
+ # resp.browser_settings[0].browser_settings_arn #=> String
1440
+ # resp.next_token #=> String
1441
+ #
1442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListBrowserSettings AWS API Documentation
1443
+ #
1444
+ # @overload list_browser_settings(params = {})
1445
+ # @param [Hash] params ({})
1446
+ def list_browser_settings(params = {}, options = {})
1447
+ req = build_request(:list_browser_settings, params)
1448
+ req.send_request(options)
1449
+ end
1450
+
1451
+ # Retrieves a list of identity providers for a specific web portal.
1452
+ #
1453
+ # @option params [Integer] :max_results
1454
+ # The maximum number of results to be included in the next page.
1455
+ #
1456
+ # @option params [String] :next_token
1457
+ # The pagination token used to retrieve the next page of results for
1458
+ # this operation.
1459
+ #
1460
+ # @option params [required, String] :portal_arn
1461
+ # The ARN of the web portal.
1462
+ #
1463
+ # @return [Types::ListIdentityProvidersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1464
+ #
1465
+ # * {Types::ListIdentityProvidersResponse#identity_providers #identity_providers} => Array&lt;Types::IdentityProviderSummary&gt;
1466
+ # * {Types::ListIdentityProvidersResponse#next_token #next_token} => String
1467
+ #
1468
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1469
+ #
1470
+ # @example Request syntax with placeholder values
1471
+ #
1472
+ # resp = client.list_identity_providers({
1473
+ # max_results: 1,
1474
+ # next_token: "PaginationToken",
1475
+ # portal_arn: "ARN", # required
1476
+ # })
1477
+ #
1478
+ # @example Response structure
1479
+ #
1480
+ # resp.identity_providers #=> Array
1481
+ # resp.identity_providers[0].identity_provider_arn #=> String
1482
+ # resp.identity_providers[0].identity_provider_name #=> String
1483
+ # resp.identity_providers[0].identity_provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"
1484
+ # resp.next_token #=> String
1485
+ #
1486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListIdentityProviders AWS API Documentation
1487
+ #
1488
+ # @overload list_identity_providers(params = {})
1489
+ # @param [Hash] params ({})
1490
+ def list_identity_providers(params = {}, options = {})
1491
+ req = build_request(:list_identity_providers, params)
1492
+ req.send_request(options)
1493
+ end
1494
+
1495
+ # Retrieves a list of network settings.
1496
+ #
1497
+ # @option params [Integer] :max_results
1498
+ # The maximum number of results to be included in the next page.
1499
+ #
1500
+ # @option params [String] :next_token
1501
+ # The pagination token used to retrieve the next page of results for
1502
+ # this operation.
1503
+ #
1504
+ # @return [Types::ListNetworkSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1505
+ #
1506
+ # * {Types::ListNetworkSettingsResponse#network_settings #network_settings} => Array&lt;Types::NetworkSettingsSummary&gt;
1507
+ # * {Types::ListNetworkSettingsResponse#next_token #next_token} => String
1508
+ #
1509
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1510
+ #
1511
+ # @example Request syntax with placeholder values
1512
+ #
1513
+ # resp = client.list_network_settings({
1514
+ # max_results: 1,
1515
+ # next_token: "PaginationToken",
1516
+ # })
1517
+ #
1518
+ # @example Response structure
1519
+ #
1520
+ # resp.network_settings #=> Array
1521
+ # resp.network_settings[0].network_settings_arn #=> String
1522
+ # resp.network_settings[0].vpc_id #=> String
1523
+ # resp.next_token #=> String
1524
+ #
1525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListNetworkSettings AWS API Documentation
1526
+ #
1527
+ # @overload list_network_settings(params = {})
1528
+ # @param [Hash] params ({})
1529
+ def list_network_settings(params = {}, options = {})
1530
+ req = build_request(:list_network_settings, params)
1531
+ req.send_request(options)
1532
+ end
1533
+
1534
+ # Retrieves a list or web portals.
1535
+ #
1536
+ # @option params [Integer] :max_results
1537
+ # The maximum number of results to be included in the next page.
1538
+ #
1539
+ # @option params [String] :next_token
1540
+ # The pagination token used to retrieve the next page of results for
1541
+ # this operation.
1542
+ #
1543
+ # @return [Types::ListPortalsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1544
+ #
1545
+ # * {Types::ListPortalsResponse#next_token #next_token} => String
1546
+ # * {Types::ListPortalsResponse#portals #portals} => Array&lt;Types::PortalSummary&gt;
1547
+ #
1548
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1549
+ #
1550
+ # @example Request syntax with placeholder values
1551
+ #
1552
+ # resp = client.list_portals({
1553
+ # max_results: 1,
1554
+ # next_token: "PaginationToken",
1555
+ # })
1556
+ #
1557
+ # @example Response structure
1558
+ #
1559
+ # resp.next_token #=> String
1560
+ # resp.portals #=> Array
1561
+ # resp.portals[0].browser_settings_arn #=> String
1562
+ # resp.portals[0].browser_type #=> String, one of "Chrome"
1563
+ # resp.portals[0].creation_date #=> Time
1564
+ # resp.portals[0].display_name #=> String
1565
+ # resp.portals[0].network_settings_arn #=> String
1566
+ # resp.portals[0].portal_arn #=> String
1567
+ # resp.portals[0].portal_endpoint #=> String
1568
+ # resp.portals[0].portal_status #=> String, one of "Incomplete", "Pending", "Active"
1569
+ # resp.portals[0].renderer_type #=> String, one of "AppStream"
1570
+ # resp.portals[0].trust_store_arn #=> String
1571
+ # resp.portals[0].user_settings_arn #=> String
1572
+ #
1573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListPortals AWS API Documentation
1574
+ #
1575
+ # @overload list_portals(params = {})
1576
+ # @param [Hash] params ({})
1577
+ def list_portals(params = {}, options = {})
1578
+ req = build_request(:list_portals, params)
1579
+ req.send_request(options)
1580
+ end
1581
+
1582
+ # Retrieves a list of tags for a resource.
1583
+ #
1584
+ # @option params [required, String] :resource_arn
1585
+ # The ARN of the resource.
1586
+ #
1587
+ # @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1588
+ #
1589
+ # * {Types::ListTagsForResourceResponse#tags #tags} => Array&lt;Types::Tag&gt;
1590
+ #
1591
+ # @example Request syntax with placeholder values
1592
+ #
1593
+ # resp = client.list_tags_for_resource({
1594
+ # resource_arn: "ARN", # required
1595
+ # })
1596
+ #
1597
+ # @example Response structure
1598
+ #
1599
+ # resp.tags #=> Array
1600
+ # resp.tags[0].key #=> String
1601
+ # resp.tags[0].value #=> String
1602
+ #
1603
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListTagsForResource AWS API Documentation
1604
+ #
1605
+ # @overload list_tags_for_resource(params = {})
1606
+ # @param [Hash] params ({})
1607
+ def list_tags_for_resource(params = {}, options = {})
1608
+ req = build_request(:list_tags_for_resource, params)
1609
+ req.send_request(options)
1610
+ end
1611
+
1612
+ # Retrieves a list of trust store certificates.
1613
+ #
1614
+ # @option params [Integer] :max_results
1615
+ # The maximum number of results to be included in the next page.
1616
+ #
1617
+ # @option params [String] :next_token
1618
+ # The pagination token used to retrieve the next page of results for
1619
+ # this operation.
1620
+ #
1621
+ # @option params [required, String] :trust_store_arn
1622
+ # The ARN of the trust store
1623
+ #
1624
+ # @return [Types::ListTrustStoreCertificatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1625
+ #
1626
+ # * {Types::ListTrustStoreCertificatesResponse#certificate_list #certificate_list} => Array&lt;Types::CertificateSummary&gt;
1627
+ # * {Types::ListTrustStoreCertificatesResponse#next_token #next_token} => String
1628
+ # * {Types::ListTrustStoreCertificatesResponse#trust_store_arn #trust_store_arn} => String
1629
+ #
1630
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1631
+ #
1632
+ # @example Request syntax with placeholder values
1633
+ #
1634
+ # resp = client.list_trust_store_certificates({
1635
+ # max_results: 1,
1636
+ # next_token: "PaginationToken",
1637
+ # trust_store_arn: "ARN", # required
1638
+ # })
1639
+ #
1640
+ # @example Response structure
1641
+ #
1642
+ # resp.certificate_list #=> Array
1643
+ # resp.certificate_list[0].issuer #=> String
1644
+ # resp.certificate_list[0].not_valid_after #=> Time
1645
+ # resp.certificate_list[0].not_valid_before #=> Time
1646
+ # resp.certificate_list[0].subject #=> String
1647
+ # resp.certificate_list[0].thumbprint #=> String
1648
+ # resp.next_token #=> String
1649
+ # resp.trust_store_arn #=> String
1650
+ #
1651
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListTrustStoreCertificates AWS API Documentation
1652
+ #
1653
+ # @overload list_trust_store_certificates(params = {})
1654
+ # @param [Hash] params ({})
1655
+ def list_trust_store_certificates(params = {}, options = {})
1656
+ req = build_request(:list_trust_store_certificates, params)
1657
+ req.send_request(options)
1658
+ end
1659
+
1660
+ # Retrieves a list of trust stores.
1661
+ #
1662
+ # @option params [Integer] :max_results
1663
+ # The maximum number of results to be included in the next page.
1664
+ #
1665
+ # @option params [String] :next_token
1666
+ # The pagination token used to retrieve the next page of results for
1667
+ # this operation.
1668
+ #
1669
+ # @return [Types::ListTrustStoresResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1670
+ #
1671
+ # * {Types::ListTrustStoresResponse#next_token #next_token} => String
1672
+ # * {Types::ListTrustStoresResponse#trust_stores #trust_stores} => Array&lt;Types::TrustStoreSummary&gt;
1673
+ #
1674
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1675
+ #
1676
+ # @example Request syntax with placeholder values
1677
+ #
1678
+ # resp = client.list_trust_stores({
1679
+ # max_results: 1,
1680
+ # next_token: "PaginationToken",
1681
+ # })
1682
+ #
1683
+ # @example Response structure
1684
+ #
1685
+ # resp.next_token #=> String
1686
+ # resp.trust_stores #=> Array
1687
+ # resp.trust_stores[0].trust_store_arn #=> String
1688
+ #
1689
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListTrustStores AWS API Documentation
1690
+ #
1691
+ # @overload list_trust_stores(params = {})
1692
+ # @param [Hash] params ({})
1693
+ def list_trust_stores(params = {}, options = {})
1694
+ req = build_request(:list_trust_stores, params)
1695
+ req.send_request(options)
1696
+ end
1697
+
1698
+ # Retrieves a list of user settings.
1699
+ #
1700
+ # @option params [Integer] :max_results
1701
+ # The maximum number of results to be included in the next page.
1702
+ #
1703
+ # @option params [String] :next_token
1704
+ # The pagination token used to retrieve the next page of results for
1705
+ # this operation.
1706
+ #
1707
+ # @return [Types::ListUserSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1708
+ #
1709
+ # * {Types::ListUserSettingsResponse#next_token #next_token} => String
1710
+ # * {Types::ListUserSettingsResponse#user_settings #user_settings} => Array&lt;Types::UserSettingsSummary&gt;
1711
+ #
1712
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1713
+ #
1714
+ # @example Request syntax with placeholder values
1715
+ #
1716
+ # resp = client.list_user_settings({
1717
+ # max_results: 1,
1718
+ # next_token: "PaginationToken",
1719
+ # })
1720
+ #
1721
+ # @example Response structure
1722
+ #
1723
+ # resp.next_token #=> String
1724
+ # resp.user_settings #=> Array
1725
+ # resp.user_settings[0].copy_allowed #=> String, one of "Disabled", "Enabled"
1726
+ # resp.user_settings[0].download_allowed #=> String, one of "Disabled", "Enabled"
1727
+ # resp.user_settings[0].paste_allowed #=> String, one of "Disabled", "Enabled"
1728
+ # resp.user_settings[0].print_allowed #=> String, one of "Disabled", "Enabled"
1729
+ # resp.user_settings[0].upload_allowed #=> String, one of "Disabled", "Enabled"
1730
+ # resp.user_settings[0].user_settings_arn #=> String
1731
+ #
1732
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListUserSettings AWS API Documentation
1733
+ #
1734
+ # @overload list_user_settings(params = {})
1735
+ # @param [Hash] params ({})
1736
+ def list_user_settings(params = {}, options = {})
1737
+ req = build_request(:list_user_settings, params)
1738
+ req.send_request(options)
1739
+ end
1740
+
1741
+ # Adds or overwrites one or more tags for the specified resource.
1742
+ #
1743
+ # @option params [String] :client_token
1744
+ # A unique, case-sensitive identifier that you provide to ensure the
1745
+ # idempotency of the request. Idempotency ensures that an API request
1746
+ # completes only once. With an idempotent request, if the original
1747
+ # request completes successfully, subsequent retries with the same
1748
+ # client token returns the result from the original successful request.
1749
+ #
1750
+ # If you do not specify a client token, one is automatically generated
1751
+ # by the AWS SDK.
1752
+ #
1753
+ # **A suitable default value is auto-generated.** You should normally
1754
+ # not need to pass this option.**
1755
+ #
1756
+ # @option params [required, String] :resource_arn
1757
+ # The ARN of the resource.
1758
+ #
1759
+ # @option params [required, Array<Types::Tag>] :tags
1760
+ # The tags of the resource.
1761
+ #
1762
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1763
+ #
1764
+ # @example Request syntax with placeholder values
1765
+ #
1766
+ # resp = client.tag_resource({
1767
+ # client_token: "ClientToken",
1768
+ # resource_arn: "ARN", # required
1769
+ # tags: [ # required
1770
+ # {
1771
+ # key: "TagKey", # required
1772
+ # value: "TagValue", # required
1773
+ # },
1774
+ # ],
1775
+ # })
1776
+ #
1777
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/TagResource AWS API Documentation
1778
+ #
1779
+ # @overload tag_resource(params = {})
1780
+ # @param [Hash] params ({})
1781
+ def tag_resource(params = {}, options = {})
1782
+ req = build_request(:tag_resource, params)
1783
+ req.send_request(options)
1784
+ end
1785
+
1786
+ # Removes one or more tags from the specified resource.
1787
+ #
1788
+ # @option params [required, String] :resource_arn
1789
+ # The ARN of the resource.
1790
+ #
1791
+ # @option params [required, Array<String>] :tag_keys
1792
+ # The list of tag keys to remove from the resource.
1793
+ #
1794
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1795
+ #
1796
+ # @example Request syntax with placeholder values
1797
+ #
1798
+ # resp = client.untag_resource({
1799
+ # resource_arn: "ARN", # required
1800
+ # tag_keys: ["TagKey"], # required
1801
+ # })
1802
+ #
1803
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UntagResource AWS API Documentation
1804
+ #
1805
+ # @overload untag_resource(params = {})
1806
+ # @param [Hash] params ({})
1807
+ def untag_resource(params = {}, options = {})
1808
+ req = build_request(:untag_resource, params)
1809
+ req.send_request(options)
1810
+ end
1811
+
1812
+ # Updates browser settings.
1813
+ #
1814
+ # @option params [String] :browser_policy
1815
+ # A JSON string containing Chrome Enterprise policies that will be
1816
+ # applied to all streaming sessions.
1817
+ #
1818
+ # @option params [required, String] :browser_settings_arn
1819
+ # The ARN of the browser settings.
1820
+ #
1821
+ # @option params [String] :client_token
1822
+ # A unique, case-sensitive identifier that you provide to ensure the
1823
+ # idempotency of the request. Idempotency ensures that an API request
1824
+ # completes only once. With an idempotent request, if the original
1825
+ # request completes successfully, subsequent retries with the same
1826
+ # client token return the result from the original successful request.
1827
+ #
1828
+ # If you do not specify a client token, one is automatically generated
1829
+ # by the AWS SDK.
1830
+ #
1831
+ # **A suitable default value is auto-generated.** You should normally
1832
+ # not need to pass this option.**
1833
+ #
1834
+ # @return [Types::UpdateBrowserSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1835
+ #
1836
+ # * {Types::UpdateBrowserSettingsResponse#browser_settings #browser_settings} => Types::BrowserSettings
1837
+ #
1838
+ # @example Request syntax with placeholder values
1839
+ #
1840
+ # resp = client.update_browser_settings({
1841
+ # browser_policy: "BrowserPolicy",
1842
+ # browser_settings_arn: "ARN", # required
1843
+ # client_token: "ClientToken",
1844
+ # })
1845
+ #
1846
+ # @example Response structure
1847
+ #
1848
+ # resp.browser_settings.associated_portal_arns #=> Array
1849
+ # resp.browser_settings.associated_portal_arns[0] #=> String
1850
+ # resp.browser_settings.browser_policy #=> String
1851
+ # resp.browser_settings.browser_settings_arn #=> String
1852
+ #
1853
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateBrowserSettings AWS API Documentation
1854
+ #
1855
+ # @overload update_browser_settings(params = {})
1856
+ # @param [Hash] params ({})
1857
+ def update_browser_settings(params = {}, options = {})
1858
+ req = build_request(:update_browser_settings, params)
1859
+ req.send_request(options)
1860
+ end
1861
+
1862
+ # Updates the identity provider.
1863
+ #
1864
+ # @option params [String] :client_token
1865
+ # A unique, case-sensitive identifier that you provide to ensure the
1866
+ # idempotency of the request. Idempotency ensures that an API request
1867
+ # completes only once. With an idempotent request, if the original
1868
+ # request completes successfully, subsequent retries with the same
1869
+ # client token return the result from the original successful request.
1870
+ #
1871
+ # If you do not specify a client token, one is automatically generated
1872
+ # by the AWS SDK.
1873
+ #
1874
+ # **A suitable default value is auto-generated.** You should normally
1875
+ # not need to pass this option.**
1876
+ #
1877
+ # @option params [required, String] :identity_provider_arn
1878
+ # The ARN of the identity provider.
1879
+ #
1880
+ # @option params [Hash<String,String>] :identity_provider_details
1881
+ # The details of the identity provider.
1882
+ #
1883
+ # @option params [String] :identity_provider_name
1884
+ # The name of the identity provider.
1885
+ #
1886
+ # @option params [String] :identity_provider_type
1887
+ # The type of the identity provider.
1888
+ #
1889
+ # @return [Types::UpdateIdentityProviderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1890
+ #
1891
+ # * {Types::UpdateIdentityProviderResponse#identity_provider #identity_provider} => Types::IdentityProvider
1892
+ #
1893
+ # @example Request syntax with placeholder values
1894
+ #
1895
+ # resp = client.update_identity_provider({
1896
+ # client_token: "ClientToken",
1897
+ # identity_provider_arn: "ARN", # required
1898
+ # identity_provider_details: {
1899
+ # "StringType" => "StringType",
1900
+ # },
1901
+ # identity_provider_name: "IdentityProviderName",
1902
+ # identity_provider_type: "SAML", # accepts SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
1903
+ # })
1904
+ #
1905
+ # @example Response structure
1906
+ #
1907
+ # resp.identity_provider.identity_provider_arn #=> String
1908
+ # resp.identity_provider.identity_provider_details #=> Hash
1909
+ # resp.identity_provider.identity_provider_details["StringType"] #=> String
1910
+ # resp.identity_provider.identity_provider_name #=> String
1911
+ # resp.identity_provider.identity_provider_type #=> String, one of "SAML", "Facebook", "Google", "LoginWithAmazon", "SignInWithApple", "OIDC"
1912
+ #
1913
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateIdentityProvider AWS API Documentation
1914
+ #
1915
+ # @overload update_identity_provider(params = {})
1916
+ # @param [Hash] params ({})
1917
+ def update_identity_provider(params = {}, options = {})
1918
+ req = build_request(:update_identity_provider, params)
1919
+ req.send_request(options)
1920
+ end
1921
+
1922
+ # Updates network settings.
1923
+ #
1924
+ # @option params [String] :client_token
1925
+ # A unique, case-sensitive identifier that you provide to ensure the
1926
+ # idempotency of the request. Idempotency ensures that an API request
1927
+ # completes only once. With an idempotent request, if the original
1928
+ # request completes successfully, subsequent retries with the same
1929
+ # client token return the result from the original successful request.
1930
+ #
1931
+ # If you do not specify a client token, one is automatically generated
1932
+ # by the AWS SDK.
1933
+ #
1934
+ # **A suitable default value is auto-generated.** You should normally
1935
+ # not need to pass this option.**
1936
+ #
1937
+ # @option params [required, String] :network_settings_arn
1938
+ # The ARN of the network settings.
1939
+ #
1940
+ # @option params [Array<String>] :security_group_ids
1941
+ # One or more security groups used to control access from streaming
1942
+ # instances to your VPC.
1943
+ #
1944
+ # @option params [Array<String>] :subnet_ids
1945
+ # The subnets in which network interfaces are created to connect
1946
+ # streaming instances to your VPC. At least two of these subnets must be
1947
+ # in different availability zones.
1948
+ #
1949
+ # @option params [String] :vpc_id
1950
+ # The VPC that streaming instances will connect to.
1951
+ #
1952
+ # @return [Types::UpdateNetworkSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1953
+ #
1954
+ # * {Types::UpdateNetworkSettingsResponse#network_settings #network_settings} => Types::NetworkSettings
1955
+ #
1956
+ # @example Request syntax with placeholder values
1957
+ #
1958
+ # resp = client.update_network_settings({
1959
+ # client_token: "ClientToken",
1960
+ # network_settings_arn: "ARN", # required
1961
+ # security_group_ids: ["SecurityGroupId"],
1962
+ # subnet_ids: ["SubnetId"],
1963
+ # vpc_id: "VpcId",
1964
+ # })
1965
+ #
1966
+ # @example Response structure
1967
+ #
1968
+ # resp.network_settings.associated_portal_arns #=> Array
1969
+ # resp.network_settings.associated_portal_arns[0] #=> String
1970
+ # resp.network_settings.network_settings_arn #=> String
1971
+ # resp.network_settings.security_group_ids #=> Array
1972
+ # resp.network_settings.security_group_ids[0] #=> String
1973
+ # resp.network_settings.subnet_ids #=> Array
1974
+ # resp.network_settings.subnet_ids[0] #=> String
1975
+ # resp.network_settings.vpc_id #=> String
1976
+ #
1977
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateNetworkSettings AWS API Documentation
1978
+ #
1979
+ # @overload update_network_settings(params = {})
1980
+ # @param [Hash] params ({})
1981
+ def update_network_settings(params = {}, options = {})
1982
+ req = build_request(:update_network_settings, params)
1983
+ req.send_request(options)
1984
+ end
1985
+
1986
+ # Updates a web portal.
1987
+ #
1988
+ # @option params [String] :display_name
1989
+ # The name of the web portal. This is not visible to users who log into
1990
+ # the web portal.
1991
+ #
1992
+ # @option params [required, String] :portal_arn
1993
+ # The ARN of the web portal.
1994
+ #
1995
+ # @return [Types::UpdatePortalResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1996
+ #
1997
+ # * {Types::UpdatePortalResponse#portal #portal} => Types::Portal
1998
+ #
1999
+ # @example Request syntax with placeholder values
2000
+ #
2001
+ # resp = client.update_portal({
2002
+ # display_name: "DisplayName",
2003
+ # portal_arn: "ARN", # required
2004
+ # })
2005
+ #
2006
+ # @example Response structure
2007
+ #
2008
+ # resp.portal.browser_settings_arn #=> String
2009
+ # resp.portal.browser_type #=> String, one of "Chrome"
2010
+ # resp.portal.creation_date #=> Time
2011
+ # resp.portal.display_name #=> String
2012
+ # resp.portal.network_settings_arn #=> String
2013
+ # resp.portal.portal_arn #=> String
2014
+ # resp.portal.portal_endpoint #=> String
2015
+ # resp.portal.portal_status #=> String, one of "Incomplete", "Pending", "Active"
2016
+ # resp.portal.renderer_type #=> String, one of "AppStream"
2017
+ # resp.portal.status_reason #=> String
2018
+ # resp.portal.trust_store_arn #=> String
2019
+ # resp.portal.user_settings_arn #=> String
2020
+ #
2021
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdatePortal AWS API Documentation
2022
+ #
2023
+ # @overload update_portal(params = {})
2024
+ # @param [Hash] params ({})
2025
+ def update_portal(params = {}, options = {})
2026
+ req = build_request(:update_portal, params)
2027
+ req.send_request(options)
2028
+ end
2029
+
2030
+ # Updates the trust store.
2031
+ #
2032
+ # @option params [Array<String, StringIO, File>] :certificates_to_add
2033
+ # A list of CA certificates to add to the trust store.
2034
+ #
2035
+ # @option params [Array<String>] :certificates_to_delete
2036
+ # A list of CA certificates to delete from a trust store.
2037
+ #
2038
+ # @option params [String] :client_token
2039
+ # A unique, case-sensitive identifier that you provide to ensure the
2040
+ # idempotency of the request. Idempotency ensures that an API request
2041
+ # completes only once. With an idempotent request, if the original
2042
+ # request completes successfully, subsequent retries with the same
2043
+ # client token return the result from the original successful request.
2044
+ #
2045
+ # If you do not specify a client token, one is automatically generated
2046
+ # by the AWS SDK.
2047
+ #
2048
+ # **A suitable default value is auto-generated.** You should normally
2049
+ # not need to pass this option.**
2050
+ #
2051
+ # @option params [required, String] :trust_store_arn
2052
+ # The ARN of the trust store.
2053
+ #
2054
+ # @return [Types::UpdateTrustStoreResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2055
+ #
2056
+ # * {Types::UpdateTrustStoreResponse#trust_store_arn #trust_store_arn} => String
2057
+ #
2058
+ # @example Request syntax with placeholder values
2059
+ #
2060
+ # resp = client.update_trust_store({
2061
+ # certificates_to_add: ["data"],
2062
+ # certificates_to_delete: ["CertificateThumbprint"],
2063
+ # client_token: "ClientToken",
2064
+ # trust_store_arn: "ARN", # required
2065
+ # })
2066
+ #
2067
+ # @example Response structure
2068
+ #
2069
+ # resp.trust_store_arn #=> String
2070
+ #
2071
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateTrustStore AWS API Documentation
2072
+ #
2073
+ # @overload update_trust_store(params = {})
2074
+ # @param [Hash] params ({})
2075
+ def update_trust_store(params = {}, options = {})
2076
+ req = build_request(:update_trust_store, params)
2077
+ req.send_request(options)
2078
+ end
2079
+
2080
+ # Updates the user settings.
2081
+ #
2082
+ # @option params [String] :client_token
2083
+ # A unique, case-sensitive identifier that you provide to ensure the
2084
+ # idempotency of the request. Idempotency ensures that an API request
2085
+ # completes only once. With an idempotent request, if the original
2086
+ # request completes successfully, subsequent retries with the same
2087
+ # client token return the result from the original successful request.
2088
+ #
2089
+ # If you do not specify a client token, one is automatically generated
2090
+ # by the AWS SDK.
2091
+ #
2092
+ # **A suitable default value is auto-generated.** You should normally
2093
+ # not need to pass this option.**
2094
+ #
2095
+ # @option params [String] :copy_allowed
2096
+ # Specifies whether the user can copy text from the streaming session to
2097
+ # the local device.
2098
+ #
2099
+ # @option params [String] :download_allowed
2100
+ # Specifies whether the user can download files from the streaming
2101
+ # session to the local device.
2102
+ #
2103
+ # @option params [String] :paste_allowed
2104
+ # Specifies whether the user can paste text from the local device to the
2105
+ # streaming session.
2106
+ #
2107
+ # @option params [String] :print_allowed
2108
+ # Specifies whether the user can print to the local device.
2109
+ #
2110
+ # @option params [String] :upload_allowed
2111
+ # Specifies whether the user can upload files from the local device to
2112
+ # the streaming session.
2113
+ #
2114
+ # @option params [required, String] :user_settings_arn
2115
+ # The ARN of the user settings.
2116
+ #
2117
+ # @return [Types::UpdateUserSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2118
+ #
2119
+ # * {Types::UpdateUserSettingsResponse#user_settings #user_settings} => Types::UserSettings
2120
+ #
2121
+ # @example Request syntax with placeholder values
2122
+ #
2123
+ # resp = client.update_user_settings({
2124
+ # client_token: "ClientToken",
2125
+ # copy_allowed: "Disabled", # accepts Disabled, Enabled
2126
+ # download_allowed: "Disabled", # accepts Disabled, Enabled
2127
+ # paste_allowed: "Disabled", # accepts Disabled, Enabled
2128
+ # print_allowed: "Disabled", # accepts Disabled, Enabled
2129
+ # upload_allowed: "Disabled", # accepts Disabled, Enabled
2130
+ # user_settings_arn: "ARN", # required
2131
+ # })
2132
+ #
2133
+ # @example Response structure
2134
+ #
2135
+ # resp.user_settings.associated_portal_arns #=> Array
2136
+ # resp.user_settings.associated_portal_arns[0] #=> String
2137
+ # resp.user_settings.copy_allowed #=> String, one of "Disabled", "Enabled"
2138
+ # resp.user_settings.download_allowed #=> String, one of "Disabled", "Enabled"
2139
+ # resp.user_settings.paste_allowed #=> String, one of "Disabled", "Enabled"
2140
+ # resp.user_settings.print_allowed #=> String, one of "Disabled", "Enabled"
2141
+ # resp.user_settings.upload_allowed #=> String, one of "Disabled", "Enabled"
2142
+ # resp.user_settings.user_settings_arn #=> String
2143
+ #
2144
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateUserSettings AWS API Documentation
2145
+ #
2146
+ # @overload update_user_settings(params = {})
2147
+ # @param [Hash] params ({})
2148
+ def update_user_settings(params = {}, options = {})
2149
+ req = build_request(:update_user_settings, params)
2150
+ req.send_request(options)
2151
+ end
2152
+
2153
+ # @!endgroup
2154
+
2155
+ # @param params ({})
2156
+ # @api private
2157
+ def build_request(operation_name, params = {})
2158
+ handlers = @handlers.for(operation_name)
2159
+ context = Seahorse::Client::RequestContext.new(
2160
+ operation_name: operation_name,
2161
+ operation: config.api.operation(operation_name),
2162
+ client: self,
2163
+ params: params,
2164
+ config: config)
2165
+ context[:gem_name] = 'aws-sdk-workspacesweb'
2166
+ context[:gem_version] = '1.0.0'
2167
+ Seahorse::Client::Request.new(handlers, context)
2168
+ end
2169
+
2170
+ # @api private
2171
+ # @deprecated
2172
+ def waiter_names
2173
+ []
2174
+ end
2175
+
2176
+ class << self
2177
+
2178
+ # @api private
2179
+ attr_reader :identifier
2180
+
2181
+ # @api private
2182
+ def errors_module
2183
+ Errors
2184
+ end
2185
+
2186
+ end
2187
+ end
2188
+ end