aws-sdk-workspacesweb 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,2772 @@
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
+ module Aws::WorkSpacesWeb
11
+ module Types
12
+
13
+ # Access is denied.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # @note When making an API call, you may pass AssociateBrowserSettingsRequest
27
+ # data as a hash:
28
+ #
29
+ # {
30
+ # browser_settings_arn: "ARN", # required
31
+ # portal_arn: "ARN", # required
32
+ # }
33
+ #
34
+ # @!attribute [rw] browser_settings_arn
35
+ # The ARN of the browser settings.
36
+ # @return [String]
37
+ #
38
+ # @!attribute [rw] portal_arn
39
+ # The ARN of the web portal.
40
+ # @return [String]
41
+ #
42
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AssociateBrowserSettingsRequest AWS API Documentation
43
+ #
44
+ class AssociateBrowserSettingsRequest < Struct.new(
45
+ :browser_settings_arn,
46
+ :portal_arn)
47
+ SENSITIVE = []
48
+ include Aws::Structure
49
+ end
50
+
51
+ # @!attribute [rw] browser_settings_arn
52
+ # The ARN of the browser settings.
53
+ # @return [String]
54
+ #
55
+ # @!attribute [rw] portal_arn
56
+ # The ARN of the web portal.
57
+ # @return [String]
58
+ #
59
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AssociateBrowserSettingsResponse AWS API Documentation
60
+ #
61
+ class AssociateBrowserSettingsResponse < Struct.new(
62
+ :browser_settings_arn,
63
+ :portal_arn)
64
+ SENSITIVE = []
65
+ include Aws::Structure
66
+ end
67
+
68
+ # @note When making an API call, you may pass AssociateNetworkSettingsRequest
69
+ # data as a hash:
70
+ #
71
+ # {
72
+ # network_settings_arn: "ARN", # required
73
+ # portal_arn: "ARN", # required
74
+ # }
75
+ #
76
+ # @!attribute [rw] network_settings_arn
77
+ # The ARN of the network settings.
78
+ # @return [String]
79
+ #
80
+ # @!attribute [rw] portal_arn
81
+ # The ARN of the web portal.
82
+ # @return [String]
83
+ #
84
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AssociateNetworkSettingsRequest AWS API Documentation
85
+ #
86
+ class AssociateNetworkSettingsRequest < Struct.new(
87
+ :network_settings_arn,
88
+ :portal_arn)
89
+ SENSITIVE = []
90
+ include Aws::Structure
91
+ end
92
+
93
+ # @!attribute [rw] network_settings_arn
94
+ # The ARN of the network settings.
95
+ # @return [String]
96
+ #
97
+ # @!attribute [rw] portal_arn
98
+ # The ARN of the web portal.
99
+ # @return [String]
100
+ #
101
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AssociateNetworkSettingsResponse AWS API Documentation
102
+ #
103
+ class AssociateNetworkSettingsResponse < Struct.new(
104
+ :network_settings_arn,
105
+ :portal_arn)
106
+ SENSITIVE = []
107
+ include Aws::Structure
108
+ end
109
+
110
+ # @note When making an API call, you may pass AssociateTrustStoreRequest
111
+ # data as a hash:
112
+ #
113
+ # {
114
+ # portal_arn: "ARN", # required
115
+ # trust_store_arn: "ARN", # required
116
+ # }
117
+ #
118
+ # @!attribute [rw] portal_arn
119
+ # The ARN of the web portal.
120
+ # @return [String]
121
+ #
122
+ # @!attribute [rw] trust_store_arn
123
+ # The ARN of the trust store.
124
+ # @return [String]
125
+ #
126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AssociateTrustStoreRequest AWS API Documentation
127
+ #
128
+ class AssociateTrustStoreRequest < Struct.new(
129
+ :portal_arn,
130
+ :trust_store_arn)
131
+ SENSITIVE = []
132
+ include Aws::Structure
133
+ end
134
+
135
+ # @!attribute [rw] portal_arn
136
+ # The ARN of the web portal.
137
+ # @return [String]
138
+ #
139
+ # @!attribute [rw] trust_store_arn
140
+ # The ARN of the trust store.
141
+ # @return [String]
142
+ #
143
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AssociateTrustStoreResponse AWS API Documentation
144
+ #
145
+ class AssociateTrustStoreResponse < Struct.new(
146
+ :portal_arn,
147
+ :trust_store_arn)
148
+ SENSITIVE = []
149
+ include Aws::Structure
150
+ end
151
+
152
+ # @note When making an API call, you may pass AssociateUserSettingsRequest
153
+ # data as a hash:
154
+ #
155
+ # {
156
+ # portal_arn: "ARN", # required
157
+ # user_settings_arn: "ARN", # required
158
+ # }
159
+ #
160
+ # @!attribute [rw] portal_arn
161
+ # The ARN of the web portal.
162
+ # @return [String]
163
+ #
164
+ # @!attribute [rw] user_settings_arn
165
+ # The ARN of the user settings.
166
+ # @return [String]
167
+ #
168
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AssociateUserSettingsRequest AWS API Documentation
169
+ #
170
+ class AssociateUserSettingsRequest < Struct.new(
171
+ :portal_arn,
172
+ :user_settings_arn)
173
+ SENSITIVE = []
174
+ include Aws::Structure
175
+ end
176
+
177
+ # @!attribute [rw] portal_arn
178
+ # The ARN of the web portal.
179
+ # @return [String]
180
+ #
181
+ # @!attribute [rw] user_settings_arn
182
+ # The ARN of the user settings.
183
+ # @return [String]
184
+ #
185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AssociateUserSettingsResponse AWS API Documentation
186
+ #
187
+ class AssociateUserSettingsResponse < Struct.new(
188
+ :portal_arn,
189
+ :user_settings_arn)
190
+ SENSITIVE = []
191
+ include Aws::Structure
192
+ end
193
+
194
+ # The browser settings resource that can be associated with a web
195
+ # portal. Once associated with a web portal, browser settings control
196
+ # how the browser will behave once a user starts a streaming session for
197
+ # the web portal.
198
+ #
199
+ # @!attribute [rw] associated_portal_arns
200
+ # A list of web portal ARNs that this browser settings is associated
201
+ # with.
202
+ # @return [Array<String>]
203
+ #
204
+ # @!attribute [rw] browser_policy
205
+ # A JSON string containing Chrome Enterprise policies that will be
206
+ # applied to all streaming sessions.
207
+ # @return [String]
208
+ #
209
+ # @!attribute [rw] browser_settings_arn
210
+ # The ARN of the browser settings.
211
+ # @return [String]
212
+ #
213
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/BrowserSettings AWS API Documentation
214
+ #
215
+ class BrowserSettings < Struct.new(
216
+ :associated_portal_arns,
217
+ :browser_policy,
218
+ :browser_settings_arn)
219
+ SENSITIVE = []
220
+ include Aws::Structure
221
+ end
222
+
223
+ # The summary for browser settings.
224
+ #
225
+ # @!attribute [rw] browser_settings_arn
226
+ # The ARN of the browser settings.
227
+ # @return [String]
228
+ #
229
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/BrowserSettingsSummary AWS API Documentation
230
+ #
231
+ class BrowserSettingsSummary < Struct.new(
232
+ :browser_settings_arn)
233
+ SENSITIVE = []
234
+ include Aws::Structure
235
+ end
236
+
237
+ # The certificate.
238
+ #
239
+ # @!attribute [rw] body
240
+ # The body of the certificate.
241
+ # @return [String]
242
+ #
243
+ # @!attribute [rw] issuer
244
+ # The entity that issued the certificate.
245
+ # @return [String]
246
+ #
247
+ # @!attribute [rw] not_valid_after
248
+ # The certificate is not valid after this date.
249
+ # @return [Time]
250
+ #
251
+ # @!attribute [rw] not_valid_before
252
+ # The certificate is not valid before this date.
253
+ # @return [Time]
254
+ #
255
+ # @!attribute [rw] subject
256
+ # The entity the certificate belongs to.
257
+ # @return [String]
258
+ #
259
+ # @!attribute [rw] thumbprint
260
+ # A hexadecimal identifier for the certificate.
261
+ # @return [String]
262
+ #
263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/Certificate AWS API Documentation
264
+ #
265
+ class Certificate < Struct.new(
266
+ :body,
267
+ :issuer,
268
+ :not_valid_after,
269
+ :not_valid_before,
270
+ :subject,
271
+ :thumbprint)
272
+ SENSITIVE = []
273
+ include Aws::Structure
274
+ end
275
+
276
+ # The summary of the certificate.
277
+ #
278
+ # @!attribute [rw] issuer
279
+ # The entity that issued the certificate.
280
+ # @return [String]
281
+ #
282
+ # @!attribute [rw] not_valid_after
283
+ # The certificate is not valid after this date.
284
+ # @return [Time]
285
+ #
286
+ # @!attribute [rw] not_valid_before
287
+ # The certificate is not valid before this date.
288
+ # @return [Time]
289
+ #
290
+ # @!attribute [rw] subject
291
+ # The entity the certificate belongs to.
292
+ # @return [String]
293
+ #
294
+ # @!attribute [rw] thumbprint
295
+ # A hexadecimal identifier for the certificate.
296
+ # @return [String]
297
+ #
298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CertificateSummary AWS API Documentation
299
+ #
300
+ class CertificateSummary < Struct.new(
301
+ :issuer,
302
+ :not_valid_after,
303
+ :not_valid_before,
304
+ :subject,
305
+ :thumbprint)
306
+ SENSITIVE = []
307
+ include Aws::Structure
308
+ end
309
+
310
+ # There is a conflict.
311
+ #
312
+ # @!attribute [rw] message
313
+ # @return [String]
314
+ #
315
+ # @!attribute [rw] resource_id
316
+ # Identifier of the resource affected.
317
+ # @return [String]
318
+ #
319
+ # @!attribute [rw] resource_type
320
+ # Type of the resource affected.
321
+ # @return [String]
322
+ #
323
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ConflictException AWS API Documentation
324
+ #
325
+ class ConflictException < Struct.new(
326
+ :message,
327
+ :resource_id,
328
+ :resource_type)
329
+ SENSITIVE = []
330
+ include Aws::Structure
331
+ end
332
+
333
+ # @note When making an API call, you may pass CreateBrowserSettingsRequest
334
+ # data as a hash:
335
+ #
336
+ # {
337
+ # additional_encryption_context: {
338
+ # "StringType" => "StringType",
339
+ # },
340
+ # browser_policy: "BrowserPolicy", # required
341
+ # client_token: "ClientToken",
342
+ # customer_managed_key: "keyArn",
343
+ # tags: [
344
+ # {
345
+ # key: "TagKey", # required
346
+ # value: "TagValue", # required
347
+ # },
348
+ # ],
349
+ # }
350
+ #
351
+ # @!attribute [rw] additional_encryption_context
352
+ # Additional encryption context of the browser settings.
353
+ # @return [Hash<String,String>]
354
+ #
355
+ # @!attribute [rw] browser_policy
356
+ # A JSON string containing Chrome Enterprise policies that will be
357
+ # applied to all streaming sessions.
358
+ # @return [String]
359
+ #
360
+ # @!attribute [rw] client_token
361
+ # A unique, case-sensitive identifier that you provide to ensure the
362
+ # idempotency of the request. Idempotency ensures that an API request
363
+ # completes only once. With an idempotent request, if the original
364
+ # request completes successfully, subsequent retries with the same
365
+ # client token returns the result from the original successful
366
+ # request.
367
+ #
368
+ # If you do not specify a client token, one is automatically generated
369
+ # by the AWS SDK.
370
+ #
371
+ # **A suitable default value is auto-generated.** You should normally
372
+ # not need to pass this option.
373
+ # @return [String]
374
+ #
375
+ # @!attribute [rw] customer_managed_key
376
+ # The custom managed key of the browser settings.
377
+ # @return [String]
378
+ #
379
+ # @!attribute [rw] tags
380
+ # The tags to add to the browser settings resource. A tag is a
381
+ # key-value pair.
382
+ # @return [Array<Types::Tag>]
383
+ #
384
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateBrowserSettingsRequest AWS API Documentation
385
+ #
386
+ class CreateBrowserSettingsRequest < Struct.new(
387
+ :additional_encryption_context,
388
+ :browser_policy,
389
+ :client_token,
390
+ :customer_managed_key,
391
+ :tags)
392
+ SENSITIVE = []
393
+ include Aws::Structure
394
+ end
395
+
396
+ # @!attribute [rw] browser_settings_arn
397
+ # The ARN of the browser settings.
398
+ # @return [String]
399
+ #
400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateBrowserSettingsResponse AWS API Documentation
401
+ #
402
+ class CreateBrowserSettingsResponse < Struct.new(
403
+ :browser_settings_arn)
404
+ SENSITIVE = []
405
+ include Aws::Structure
406
+ end
407
+
408
+ # @note When making an API call, you may pass CreateIdentityProviderRequest
409
+ # data as a hash:
410
+ #
411
+ # {
412
+ # client_token: "ClientToken",
413
+ # identity_provider_details: { # required
414
+ # "StringType" => "StringType",
415
+ # },
416
+ # identity_provider_name: "IdentityProviderName", # required
417
+ # identity_provider_type: "SAML", # required, accepts SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
418
+ # portal_arn: "ARN", # required
419
+ # }
420
+ #
421
+ # @!attribute [rw] client_token
422
+ # A unique, case-sensitive identifier that you provide to ensure the
423
+ # idempotency of the request. Idempotency ensures that an API request
424
+ # completes only once. With an idempotent request, if the original
425
+ # request completes successfully, subsequent retries with the same
426
+ # client token returns the result from the original successful
427
+ # request.
428
+ #
429
+ # If you do not specify a client token, one is automatically generated
430
+ # by the AWS SDK.
431
+ #
432
+ # **A suitable default value is auto-generated.** You should normally
433
+ # not need to pass this option.
434
+ # @return [String]
435
+ #
436
+ # @!attribute [rw] identity_provider_details
437
+ # The identity provider details. The following list describes the
438
+ # provider detail keys for each identity provider type.
439
+ #
440
+ # * For Google and Login with Amazon:
441
+ #
442
+ # * `client_id`
443
+ #
444
+ # * `client_secret`
445
+ #
446
+ # * `authorize_scopes`
447
+ #
448
+ # * For Facebook:
449
+ #
450
+ # * `client_id`
451
+ #
452
+ # * `client_secret`
453
+ #
454
+ # * `authorize_scopes`
455
+ #
456
+ # * `api_version`
457
+ #
458
+ # * For Sign in with Apple:
459
+ #
460
+ # * `client_id`
461
+ #
462
+ # * `team_id`
463
+ #
464
+ # * `key_id`
465
+ #
466
+ # * `private_key`
467
+ #
468
+ # * `authorize_scopes`
469
+ #
470
+ # * For OIDC providers:
471
+ #
472
+ # * `client_id`
473
+ #
474
+ # * `client_secret`
475
+ #
476
+ # * `attributes_request_method`
477
+ #
478
+ # * `oidc_issuer`
479
+ #
480
+ # * `authorize_scopes`
481
+ #
482
+ # * `authorize_url` *if not available from discovery URL specified
483
+ # by `oidc_issuer` key*
484
+ #
485
+ # * `token_url` *if not available from discovery URL specified by
486
+ # `oidc_issuer` key*
487
+ #
488
+ # * `attributes_url` *if not available from discovery URL specified
489
+ # by `oidc_issuer` key*
490
+ #
491
+ # * `jwks_uri` *if not available from discovery URL specified by
492
+ # `oidc_issuer` key*
493
+ #
494
+ # * For SAML providers:
495
+ #
496
+ # * `MetadataFile` OR `MetadataURL`
497
+ #
498
+ # * `IDPSignout` *optional*
499
+ # @return [Hash<String,String>]
500
+ #
501
+ # @!attribute [rw] identity_provider_name
502
+ # The identity provider name.
503
+ # @return [String]
504
+ #
505
+ # @!attribute [rw] identity_provider_type
506
+ # The identity provider type.
507
+ # @return [String]
508
+ #
509
+ # @!attribute [rw] portal_arn
510
+ # The ARN of the web portal.
511
+ # @return [String]
512
+ #
513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateIdentityProviderRequest AWS API Documentation
514
+ #
515
+ class CreateIdentityProviderRequest < Struct.new(
516
+ :client_token,
517
+ :identity_provider_details,
518
+ :identity_provider_name,
519
+ :identity_provider_type,
520
+ :portal_arn)
521
+ SENSITIVE = []
522
+ include Aws::Structure
523
+ end
524
+
525
+ # @!attribute [rw] identity_provider_arn
526
+ # The ARN of the identity provider.
527
+ # @return [String]
528
+ #
529
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateIdentityProviderResponse AWS API Documentation
530
+ #
531
+ class CreateIdentityProviderResponse < Struct.new(
532
+ :identity_provider_arn)
533
+ SENSITIVE = []
534
+ include Aws::Structure
535
+ end
536
+
537
+ # @note When making an API call, you may pass CreateNetworkSettingsRequest
538
+ # data as a hash:
539
+ #
540
+ # {
541
+ # client_token: "ClientToken",
542
+ # security_group_ids: ["SecurityGroupId"], # required
543
+ # subnet_ids: ["SubnetId"], # required
544
+ # tags: [
545
+ # {
546
+ # key: "TagKey", # required
547
+ # value: "TagValue", # required
548
+ # },
549
+ # ],
550
+ # vpc_id: "VpcId", # required
551
+ # }
552
+ #
553
+ # @!attribute [rw] client_token
554
+ # A unique, case-sensitive identifier that you provide to ensure the
555
+ # idempotency of the request. Idempotency ensures that an API request
556
+ # completes only once. With an idempotent request, if the original
557
+ # request completes successfully, subsequent retries with the same
558
+ # client token returns the result from the original successful
559
+ # request.
560
+ #
561
+ # If you do not specify a client token, one is automatically generated
562
+ # by the AWS SDK.
563
+ #
564
+ # **A suitable default value is auto-generated.** You should normally
565
+ # not need to pass this option.
566
+ # @return [String]
567
+ #
568
+ # @!attribute [rw] security_group_ids
569
+ # One or more security groups used to control access from streaming
570
+ # instances to your VPC.
571
+ # @return [Array<String>]
572
+ #
573
+ # @!attribute [rw] subnet_ids
574
+ # The subnets in which network interfaces are created to connect
575
+ # streaming instances to your VPC. At least two of these subnets must
576
+ # be in different availability zones.
577
+ # @return [Array<String>]
578
+ #
579
+ # @!attribute [rw] tags
580
+ # The tags to add to the network settings resource. A tag is a
581
+ # key-value pair.
582
+ # @return [Array<Types::Tag>]
583
+ #
584
+ # @!attribute [rw] vpc_id
585
+ # The VPC that streaming instances will connect to.
586
+ # @return [String]
587
+ #
588
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateNetworkSettingsRequest AWS API Documentation
589
+ #
590
+ class CreateNetworkSettingsRequest < Struct.new(
591
+ :client_token,
592
+ :security_group_ids,
593
+ :subnet_ids,
594
+ :tags,
595
+ :vpc_id)
596
+ SENSITIVE = []
597
+ include Aws::Structure
598
+ end
599
+
600
+ # @!attribute [rw] network_settings_arn
601
+ # The ARN of the network settings.
602
+ # @return [String]
603
+ #
604
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateNetworkSettingsResponse AWS API Documentation
605
+ #
606
+ class CreateNetworkSettingsResponse < Struct.new(
607
+ :network_settings_arn)
608
+ SENSITIVE = []
609
+ include Aws::Structure
610
+ end
611
+
612
+ # @note When making an API call, you may pass CreatePortalRequest
613
+ # data as a hash:
614
+ #
615
+ # {
616
+ # additional_encryption_context: {
617
+ # "StringType" => "StringType",
618
+ # },
619
+ # client_token: "ClientToken",
620
+ # customer_managed_key: "keyArn",
621
+ # display_name: "DisplayName",
622
+ # tags: [
623
+ # {
624
+ # key: "TagKey", # required
625
+ # value: "TagValue", # required
626
+ # },
627
+ # ],
628
+ # }
629
+ #
630
+ # @!attribute [rw] additional_encryption_context
631
+ # The additional encryption context of the portal.
632
+ # @return [Hash<String,String>]
633
+ #
634
+ # @!attribute [rw] client_token
635
+ # A unique, case-sensitive identifier that you provide to ensure the
636
+ # idempotency of the request. Idempotency ensures that an API request
637
+ # completes only once. With an idempotent request, if the original
638
+ # request completes successfully, subsequent retries with the same
639
+ # client token returns the result from the original successful
640
+ # request.
641
+ #
642
+ # If you do not specify a client token, one is automatically generated
643
+ # by the AWS SDK.
644
+ #
645
+ # **A suitable default value is auto-generated.** You should normally
646
+ # not need to pass this option.
647
+ # @return [String]
648
+ #
649
+ # @!attribute [rw] customer_managed_key
650
+ # The customer managed key of the web portal.
651
+ # @return [String]
652
+ #
653
+ # @!attribute [rw] display_name
654
+ # The name of the web portal. This is not visible to users who log
655
+ # into the web portal.
656
+ # @return [String]
657
+ #
658
+ # @!attribute [rw] tags
659
+ # The tags to add to the web portal. A tag is a key-value pair.
660
+ # @return [Array<Types::Tag>]
661
+ #
662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreatePortalRequest AWS API Documentation
663
+ #
664
+ class CreatePortalRequest < Struct.new(
665
+ :additional_encryption_context,
666
+ :client_token,
667
+ :customer_managed_key,
668
+ :display_name,
669
+ :tags)
670
+ SENSITIVE = []
671
+ include Aws::Structure
672
+ end
673
+
674
+ # @!attribute [rw] portal_arn
675
+ # The ARN of the web portal.
676
+ # @return [String]
677
+ #
678
+ # @!attribute [rw] portal_endpoint
679
+ # The endpoint URL of the web portal that users access in order to
680
+ # start streaming sessions.
681
+ # @return [String]
682
+ #
683
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreatePortalResponse AWS API Documentation
684
+ #
685
+ class CreatePortalResponse < Struct.new(
686
+ :portal_arn,
687
+ :portal_endpoint)
688
+ SENSITIVE = []
689
+ include Aws::Structure
690
+ end
691
+
692
+ # @note When making an API call, you may pass CreateTrustStoreRequest
693
+ # data as a hash:
694
+ #
695
+ # {
696
+ # certificate_list: ["data"], # required
697
+ # client_token: "ClientToken",
698
+ # tags: [
699
+ # {
700
+ # key: "TagKey", # required
701
+ # value: "TagValue", # required
702
+ # },
703
+ # ],
704
+ # }
705
+ #
706
+ # @!attribute [rw] certificate_list
707
+ # A list of CA certificates to be added to the trust store.
708
+ # @return [Array<String>]
709
+ #
710
+ # @!attribute [rw] client_token
711
+ # A unique, case-sensitive identifier that you provide to ensure the
712
+ # idempotency of the request. Idempotency ensures that an API request
713
+ # completes only once. With an idempotent request, if the original
714
+ # request completes successfully, subsequent retries with the same
715
+ # client token returns the result from the original successful
716
+ # request.
717
+ #
718
+ # If you do not specify a client token, one is automatically generated
719
+ # by the AWS SDK.
720
+ #
721
+ # **A suitable default value is auto-generated.** You should normally
722
+ # not need to pass this option.
723
+ # @return [String]
724
+ #
725
+ # @!attribute [rw] tags
726
+ # The tags to add to the trust store. A tag is a key-value pair.
727
+ # @return [Array<Types::Tag>]
728
+ #
729
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateTrustStoreRequest AWS API Documentation
730
+ #
731
+ class CreateTrustStoreRequest < Struct.new(
732
+ :certificate_list,
733
+ :client_token,
734
+ :tags)
735
+ SENSITIVE = []
736
+ include Aws::Structure
737
+ end
738
+
739
+ # @!attribute [rw] trust_store_arn
740
+ # The ARN of the trust store.
741
+ # @return [String]
742
+ #
743
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateTrustStoreResponse AWS API Documentation
744
+ #
745
+ class CreateTrustStoreResponse < Struct.new(
746
+ :trust_store_arn)
747
+ SENSITIVE = []
748
+ include Aws::Structure
749
+ end
750
+
751
+ # @note When making an API call, you may pass CreateUserSettingsRequest
752
+ # data as a hash:
753
+ #
754
+ # {
755
+ # client_token: "ClientToken",
756
+ # copy_allowed: "Disabled", # required, accepts Disabled, Enabled
757
+ # download_allowed: "Disabled", # required, accepts Disabled, Enabled
758
+ # paste_allowed: "Disabled", # required, accepts Disabled, Enabled
759
+ # print_allowed: "Disabled", # required, accepts Disabled, Enabled
760
+ # tags: [
761
+ # {
762
+ # key: "TagKey", # required
763
+ # value: "TagValue", # required
764
+ # },
765
+ # ],
766
+ # upload_allowed: "Disabled", # required, accepts Disabled, Enabled
767
+ # }
768
+ #
769
+ # @!attribute [rw] client_token
770
+ # A unique, case-sensitive identifier that you provide to ensure the
771
+ # idempotency of the request. Idempotency ensures that an API request
772
+ # completes only once. With an idempotent request, if the original
773
+ # request completes successfully, subsequent retries with the same
774
+ # client token returns the result from the original successful
775
+ # request.
776
+ #
777
+ # If you do not specify a client token, one is automatically generated
778
+ # by the AWS SDK.
779
+ #
780
+ # **A suitable default value is auto-generated.** You should normally
781
+ # not need to pass this option.
782
+ # @return [String]
783
+ #
784
+ # @!attribute [rw] copy_allowed
785
+ # Specifies whether the user can copy text from the streaming session
786
+ # to the local device.
787
+ # @return [String]
788
+ #
789
+ # @!attribute [rw] download_allowed
790
+ # Specifies whether the user can download files from the streaming
791
+ # session to the local device.
792
+ # @return [String]
793
+ #
794
+ # @!attribute [rw] paste_allowed
795
+ # Specifies whether the user can paste text from the local device to
796
+ # the streaming session.
797
+ # @return [String]
798
+ #
799
+ # @!attribute [rw] print_allowed
800
+ # Specifies whether the user can print to the local device.
801
+ # @return [String]
802
+ #
803
+ # @!attribute [rw] tags
804
+ # The tags to add to the user settings resource. A tag is a key-value
805
+ # pair.
806
+ # @return [Array<Types::Tag>]
807
+ #
808
+ # @!attribute [rw] upload_allowed
809
+ # Specifies whether the user can upload files from the local device to
810
+ # the streaming session.
811
+ # @return [String]
812
+ #
813
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateUserSettingsRequest AWS API Documentation
814
+ #
815
+ class CreateUserSettingsRequest < Struct.new(
816
+ :client_token,
817
+ :copy_allowed,
818
+ :download_allowed,
819
+ :paste_allowed,
820
+ :print_allowed,
821
+ :tags,
822
+ :upload_allowed)
823
+ SENSITIVE = []
824
+ include Aws::Structure
825
+ end
826
+
827
+ # @!attribute [rw] user_settings_arn
828
+ # The ARN of the user settings.
829
+ # @return [String]
830
+ #
831
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateUserSettingsResponse AWS API Documentation
832
+ #
833
+ class CreateUserSettingsResponse < Struct.new(
834
+ :user_settings_arn)
835
+ SENSITIVE = []
836
+ include Aws::Structure
837
+ end
838
+
839
+ # @note When making an API call, you may pass DeleteBrowserSettingsRequest
840
+ # data as a hash:
841
+ #
842
+ # {
843
+ # browser_settings_arn: "ARN", # required
844
+ # }
845
+ #
846
+ # @!attribute [rw] browser_settings_arn
847
+ # The ARN of the browser settings.
848
+ # @return [String]
849
+ #
850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteBrowserSettingsRequest AWS API Documentation
851
+ #
852
+ class DeleteBrowserSettingsRequest < Struct.new(
853
+ :browser_settings_arn)
854
+ SENSITIVE = []
855
+ include Aws::Structure
856
+ end
857
+
858
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteBrowserSettingsResponse AWS API Documentation
859
+ #
860
+ class DeleteBrowserSettingsResponse < Aws::EmptyStructure; end
861
+
862
+ # @note When making an API call, you may pass DeleteIdentityProviderRequest
863
+ # data as a hash:
864
+ #
865
+ # {
866
+ # identity_provider_arn: "ARN", # required
867
+ # }
868
+ #
869
+ # @!attribute [rw] identity_provider_arn
870
+ # The ARN of the identity provider.
871
+ # @return [String]
872
+ #
873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteIdentityProviderRequest AWS API Documentation
874
+ #
875
+ class DeleteIdentityProviderRequest < Struct.new(
876
+ :identity_provider_arn)
877
+ SENSITIVE = []
878
+ include Aws::Structure
879
+ end
880
+
881
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteIdentityProviderResponse AWS API Documentation
882
+ #
883
+ class DeleteIdentityProviderResponse < Aws::EmptyStructure; end
884
+
885
+ # @note When making an API call, you may pass DeleteNetworkSettingsRequest
886
+ # data as a hash:
887
+ #
888
+ # {
889
+ # network_settings_arn: "ARN", # required
890
+ # }
891
+ #
892
+ # @!attribute [rw] network_settings_arn
893
+ # The ARN of the network settings.
894
+ # @return [String]
895
+ #
896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteNetworkSettingsRequest AWS API Documentation
897
+ #
898
+ class DeleteNetworkSettingsRequest < Struct.new(
899
+ :network_settings_arn)
900
+ SENSITIVE = []
901
+ include Aws::Structure
902
+ end
903
+
904
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteNetworkSettingsResponse AWS API Documentation
905
+ #
906
+ class DeleteNetworkSettingsResponse < Aws::EmptyStructure; end
907
+
908
+ # @note When making an API call, you may pass DeletePortalRequest
909
+ # data as a hash:
910
+ #
911
+ # {
912
+ # portal_arn: "ARN", # required
913
+ # }
914
+ #
915
+ # @!attribute [rw] portal_arn
916
+ # The ARN of the web portal.
917
+ # @return [String]
918
+ #
919
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeletePortalRequest AWS API Documentation
920
+ #
921
+ class DeletePortalRequest < Struct.new(
922
+ :portal_arn)
923
+ SENSITIVE = []
924
+ include Aws::Structure
925
+ end
926
+
927
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeletePortalResponse AWS API Documentation
928
+ #
929
+ class DeletePortalResponse < Aws::EmptyStructure; end
930
+
931
+ # @note When making an API call, you may pass DeleteTrustStoreRequest
932
+ # data as a hash:
933
+ #
934
+ # {
935
+ # trust_store_arn: "ARN", # required
936
+ # }
937
+ #
938
+ # @!attribute [rw] trust_store_arn
939
+ # The ARN of the trust store.
940
+ # @return [String]
941
+ #
942
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteTrustStoreRequest AWS API Documentation
943
+ #
944
+ class DeleteTrustStoreRequest < Struct.new(
945
+ :trust_store_arn)
946
+ SENSITIVE = []
947
+ include Aws::Structure
948
+ end
949
+
950
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteTrustStoreResponse AWS API Documentation
951
+ #
952
+ class DeleteTrustStoreResponse < Aws::EmptyStructure; end
953
+
954
+ # @note When making an API call, you may pass DeleteUserSettingsRequest
955
+ # data as a hash:
956
+ #
957
+ # {
958
+ # user_settings_arn: "ARN", # required
959
+ # }
960
+ #
961
+ # @!attribute [rw] user_settings_arn
962
+ # The ARN of the user settings.
963
+ # @return [String]
964
+ #
965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteUserSettingsRequest AWS API Documentation
966
+ #
967
+ class DeleteUserSettingsRequest < Struct.new(
968
+ :user_settings_arn)
969
+ SENSITIVE = []
970
+ include Aws::Structure
971
+ end
972
+
973
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteUserSettingsResponse AWS API Documentation
974
+ #
975
+ class DeleteUserSettingsResponse < Aws::EmptyStructure; end
976
+
977
+ # @note When making an API call, you may pass DisassociateBrowserSettingsRequest
978
+ # data as a hash:
979
+ #
980
+ # {
981
+ # portal_arn: "ARN", # required
982
+ # }
983
+ #
984
+ # @!attribute [rw] portal_arn
985
+ # The ARN of the web portal.
986
+ # @return [String]
987
+ #
988
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DisassociateBrowserSettingsRequest AWS API Documentation
989
+ #
990
+ class DisassociateBrowserSettingsRequest < Struct.new(
991
+ :portal_arn)
992
+ SENSITIVE = []
993
+ include Aws::Structure
994
+ end
995
+
996
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DisassociateBrowserSettingsResponse AWS API Documentation
997
+ #
998
+ class DisassociateBrowserSettingsResponse < Aws::EmptyStructure; end
999
+
1000
+ # @note When making an API call, you may pass DisassociateNetworkSettingsRequest
1001
+ # data as a hash:
1002
+ #
1003
+ # {
1004
+ # portal_arn: "ARN", # required
1005
+ # }
1006
+ #
1007
+ # @!attribute [rw] portal_arn
1008
+ # The ARN of the web portal.
1009
+ # @return [String]
1010
+ #
1011
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DisassociateNetworkSettingsRequest AWS API Documentation
1012
+ #
1013
+ class DisassociateNetworkSettingsRequest < Struct.new(
1014
+ :portal_arn)
1015
+ SENSITIVE = []
1016
+ include Aws::Structure
1017
+ end
1018
+
1019
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DisassociateNetworkSettingsResponse AWS API Documentation
1020
+ #
1021
+ class DisassociateNetworkSettingsResponse < Aws::EmptyStructure; end
1022
+
1023
+ # @note When making an API call, you may pass DisassociateTrustStoreRequest
1024
+ # data as a hash:
1025
+ #
1026
+ # {
1027
+ # portal_arn: "ARN", # required
1028
+ # }
1029
+ #
1030
+ # @!attribute [rw] portal_arn
1031
+ # The ARN of the web portal.
1032
+ # @return [String]
1033
+ #
1034
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DisassociateTrustStoreRequest AWS API Documentation
1035
+ #
1036
+ class DisassociateTrustStoreRequest < Struct.new(
1037
+ :portal_arn)
1038
+ SENSITIVE = []
1039
+ include Aws::Structure
1040
+ end
1041
+
1042
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DisassociateTrustStoreResponse AWS API Documentation
1043
+ #
1044
+ class DisassociateTrustStoreResponse < Aws::EmptyStructure; end
1045
+
1046
+ # @note When making an API call, you may pass DisassociateUserSettingsRequest
1047
+ # data as a hash:
1048
+ #
1049
+ # {
1050
+ # portal_arn: "ARN", # required
1051
+ # }
1052
+ #
1053
+ # @!attribute [rw] portal_arn
1054
+ # The ARN of the web portal.
1055
+ # @return [String]
1056
+ #
1057
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DisassociateUserSettingsRequest AWS API Documentation
1058
+ #
1059
+ class DisassociateUserSettingsRequest < Struct.new(
1060
+ :portal_arn)
1061
+ SENSITIVE = []
1062
+ include Aws::Structure
1063
+ end
1064
+
1065
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DisassociateUserSettingsResponse AWS API Documentation
1066
+ #
1067
+ class DisassociateUserSettingsResponse < Aws::EmptyStructure; end
1068
+
1069
+ # @note When making an API call, you may pass GetBrowserSettingsRequest
1070
+ # data as a hash:
1071
+ #
1072
+ # {
1073
+ # browser_settings_arn: "ARN", # required
1074
+ # }
1075
+ #
1076
+ # @!attribute [rw] browser_settings_arn
1077
+ # The ARN of the browser settings.
1078
+ # @return [String]
1079
+ #
1080
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetBrowserSettingsRequest AWS API Documentation
1081
+ #
1082
+ class GetBrowserSettingsRequest < Struct.new(
1083
+ :browser_settings_arn)
1084
+ SENSITIVE = []
1085
+ include Aws::Structure
1086
+ end
1087
+
1088
+ # @!attribute [rw] browser_settings
1089
+ # The browser settings.
1090
+ # @return [Types::BrowserSettings]
1091
+ #
1092
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetBrowserSettingsResponse AWS API Documentation
1093
+ #
1094
+ class GetBrowserSettingsResponse < Struct.new(
1095
+ :browser_settings)
1096
+ SENSITIVE = []
1097
+ include Aws::Structure
1098
+ end
1099
+
1100
+ # @note When making an API call, you may pass GetIdentityProviderRequest
1101
+ # data as a hash:
1102
+ #
1103
+ # {
1104
+ # identity_provider_arn: "ARN", # required
1105
+ # }
1106
+ #
1107
+ # @!attribute [rw] identity_provider_arn
1108
+ # The ARN of the identity provider.
1109
+ # @return [String]
1110
+ #
1111
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetIdentityProviderRequest AWS API Documentation
1112
+ #
1113
+ class GetIdentityProviderRequest < Struct.new(
1114
+ :identity_provider_arn)
1115
+ SENSITIVE = []
1116
+ include Aws::Structure
1117
+ end
1118
+
1119
+ # @!attribute [rw] identity_provider
1120
+ # The identity provider.
1121
+ # @return [Types::IdentityProvider]
1122
+ #
1123
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetIdentityProviderResponse AWS API Documentation
1124
+ #
1125
+ class GetIdentityProviderResponse < Struct.new(
1126
+ :identity_provider)
1127
+ SENSITIVE = []
1128
+ include Aws::Structure
1129
+ end
1130
+
1131
+ # @note When making an API call, you may pass GetNetworkSettingsRequest
1132
+ # data as a hash:
1133
+ #
1134
+ # {
1135
+ # network_settings_arn: "ARN", # required
1136
+ # }
1137
+ #
1138
+ # @!attribute [rw] network_settings_arn
1139
+ # The ARN of the network settings.
1140
+ # @return [String]
1141
+ #
1142
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetNetworkSettingsRequest AWS API Documentation
1143
+ #
1144
+ class GetNetworkSettingsRequest < Struct.new(
1145
+ :network_settings_arn)
1146
+ SENSITIVE = []
1147
+ include Aws::Structure
1148
+ end
1149
+
1150
+ # @!attribute [rw] network_settings
1151
+ # The network settings.
1152
+ # @return [Types::NetworkSettings]
1153
+ #
1154
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetNetworkSettingsResponse AWS API Documentation
1155
+ #
1156
+ class GetNetworkSettingsResponse < Struct.new(
1157
+ :network_settings)
1158
+ SENSITIVE = []
1159
+ include Aws::Structure
1160
+ end
1161
+
1162
+ # @note When making an API call, you may pass GetPortalRequest
1163
+ # data as a hash:
1164
+ #
1165
+ # {
1166
+ # portal_arn: "ARN", # required
1167
+ # }
1168
+ #
1169
+ # @!attribute [rw] portal_arn
1170
+ # The ARN of the web portal.
1171
+ # @return [String]
1172
+ #
1173
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetPortalRequest AWS API Documentation
1174
+ #
1175
+ class GetPortalRequest < Struct.new(
1176
+ :portal_arn)
1177
+ SENSITIVE = []
1178
+ include Aws::Structure
1179
+ end
1180
+
1181
+ # @!attribute [rw] portal
1182
+ # The web portal.
1183
+ # @return [Types::Portal]
1184
+ #
1185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetPortalResponse AWS API Documentation
1186
+ #
1187
+ class GetPortalResponse < Struct.new(
1188
+ :portal)
1189
+ SENSITIVE = []
1190
+ include Aws::Structure
1191
+ end
1192
+
1193
+ # @note When making an API call, you may pass GetPortalServiceProviderMetadataRequest
1194
+ # data as a hash:
1195
+ #
1196
+ # {
1197
+ # portal_arn: "ARN", # required
1198
+ # }
1199
+ #
1200
+ # @!attribute [rw] portal_arn
1201
+ # The ARN of the web portal.
1202
+ # @return [String]
1203
+ #
1204
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetPortalServiceProviderMetadataRequest AWS API Documentation
1205
+ #
1206
+ class GetPortalServiceProviderMetadataRequest < Struct.new(
1207
+ :portal_arn)
1208
+ SENSITIVE = []
1209
+ include Aws::Structure
1210
+ end
1211
+
1212
+ # @!attribute [rw] portal_arn
1213
+ # The ARN of the web portal.
1214
+ # @return [String]
1215
+ #
1216
+ # @!attribute [rw] service_provider_saml_metadata
1217
+ # The service provider SAML metadata.
1218
+ # @return [String]
1219
+ #
1220
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetPortalServiceProviderMetadataResponse AWS API Documentation
1221
+ #
1222
+ class GetPortalServiceProviderMetadataResponse < Struct.new(
1223
+ :portal_arn,
1224
+ :service_provider_saml_metadata)
1225
+ SENSITIVE = []
1226
+ include Aws::Structure
1227
+ end
1228
+
1229
+ # @note When making an API call, you may pass GetTrustStoreCertificateRequest
1230
+ # data as a hash:
1231
+ #
1232
+ # {
1233
+ # thumbprint: "CertificateThumbprint", # required
1234
+ # trust_store_arn: "ARN", # required
1235
+ # }
1236
+ #
1237
+ # @!attribute [rw] thumbprint
1238
+ # The thumbprint of the trust store certificate.
1239
+ # @return [String]
1240
+ #
1241
+ # @!attribute [rw] trust_store_arn
1242
+ # The ARN of the trust store certificate.
1243
+ # @return [String]
1244
+ #
1245
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetTrustStoreCertificateRequest AWS API Documentation
1246
+ #
1247
+ class GetTrustStoreCertificateRequest < Struct.new(
1248
+ :thumbprint,
1249
+ :trust_store_arn)
1250
+ SENSITIVE = []
1251
+ include Aws::Structure
1252
+ end
1253
+
1254
+ # @!attribute [rw] certificate
1255
+ # The certificate of the trust store certificate.
1256
+ # @return [Types::Certificate]
1257
+ #
1258
+ # @!attribute [rw] trust_store_arn
1259
+ # The ARN of the trust store certificate.
1260
+ # @return [String]
1261
+ #
1262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetTrustStoreCertificateResponse AWS API Documentation
1263
+ #
1264
+ class GetTrustStoreCertificateResponse < Struct.new(
1265
+ :certificate,
1266
+ :trust_store_arn)
1267
+ SENSITIVE = []
1268
+ include Aws::Structure
1269
+ end
1270
+
1271
+ # @note When making an API call, you may pass GetTrustStoreRequest
1272
+ # data as a hash:
1273
+ #
1274
+ # {
1275
+ # trust_store_arn: "ARN", # required
1276
+ # }
1277
+ #
1278
+ # @!attribute [rw] trust_store_arn
1279
+ # The ARN of the trust store.
1280
+ # @return [String]
1281
+ #
1282
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetTrustStoreRequest AWS API Documentation
1283
+ #
1284
+ class GetTrustStoreRequest < Struct.new(
1285
+ :trust_store_arn)
1286
+ SENSITIVE = []
1287
+ include Aws::Structure
1288
+ end
1289
+
1290
+ # @!attribute [rw] trust_store
1291
+ # The trust store.
1292
+ # @return [Types::TrustStore]
1293
+ #
1294
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetTrustStoreResponse AWS API Documentation
1295
+ #
1296
+ class GetTrustStoreResponse < Struct.new(
1297
+ :trust_store)
1298
+ SENSITIVE = []
1299
+ include Aws::Structure
1300
+ end
1301
+
1302
+ # @note When making an API call, you may pass GetUserSettingsRequest
1303
+ # data as a hash:
1304
+ #
1305
+ # {
1306
+ # user_settings_arn: "ARN", # required
1307
+ # }
1308
+ #
1309
+ # @!attribute [rw] user_settings_arn
1310
+ # The ARN of the user settings.
1311
+ # @return [String]
1312
+ #
1313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetUserSettingsRequest AWS API Documentation
1314
+ #
1315
+ class GetUserSettingsRequest < Struct.new(
1316
+ :user_settings_arn)
1317
+ SENSITIVE = []
1318
+ include Aws::Structure
1319
+ end
1320
+
1321
+ # @!attribute [rw] user_settings
1322
+ # The user settings.
1323
+ # @return [Types::UserSettings]
1324
+ #
1325
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetUserSettingsResponse AWS API Documentation
1326
+ #
1327
+ class GetUserSettingsResponse < Struct.new(
1328
+ :user_settings)
1329
+ SENSITIVE = []
1330
+ include Aws::Structure
1331
+ end
1332
+
1333
+ # The identity provider.
1334
+ #
1335
+ # @!attribute [rw] identity_provider_arn
1336
+ # The ARN of the identity provider.
1337
+ # @return [String]
1338
+ #
1339
+ # @!attribute [rw] identity_provider_details
1340
+ # The identity provider details. The following list describes the
1341
+ # provider detail keys for each identity provider type.
1342
+ #
1343
+ # * For Google and Login with Amazon:
1344
+ #
1345
+ # * `client_id`
1346
+ #
1347
+ # * `client_secret`
1348
+ #
1349
+ # * `authorize_scopes`
1350
+ #
1351
+ # * For Facebook:
1352
+ #
1353
+ # * `client_id`
1354
+ #
1355
+ # * `client_secret`
1356
+ #
1357
+ # * `authorize_scopes`
1358
+ #
1359
+ # * `api_version`
1360
+ #
1361
+ # * For Sign in with Apple:
1362
+ #
1363
+ # * `client_id`
1364
+ #
1365
+ # * `team_id`
1366
+ #
1367
+ # * `key_id`
1368
+ #
1369
+ # * `private_key`
1370
+ #
1371
+ # * `authorize_scopes`
1372
+ #
1373
+ # * For OIDC providers:
1374
+ #
1375
+ # * `client_id`
1376
+ #
1377
+ # * `client_secret`
1378
+ #
1379
+ # * `attributes_request_method`
1380
+ #
1381
+ # * `oidc_issuer`
1382
+ #
1383
+ # * `authorize_scopes`
1384
+ #
1385
+ # * `authorize_url` *if not available from discovery URL specified
1386
+ # by oidc\_issuer key*
1387
+ #
1388
+ # * `token_url` *if not available from discovery URL specified by
1389
+ # oidc\_issuer key*
1390
+ #
1391
+ # * `attributes_url` *if not available from discovery URL specified
1392
+ # by oidc\_issuer key*
1393
+ #
1394
+ # * `jwks_uri` *if not available from discovery URL specified by
1395
+ # oidc\_issuer key*
1396
+ #
1397
+ # * For SAML providers:
1398
+ #
1399
+ # * `MetadataFile` OR `MetadataURL`
1400
+ #
1401
+ # * `IDPSignout` *optional*
1402
+ # @return [Hash<String,String>]
1403
+ #
1404
+ # @!attribute [rw] identity_provider_name
1405
+ # The identity provider name.
1406
+ # @return [String]
1407
+ #
1408
+ # @!attribute [rw] identity_provider_type
1409
+ # The identity provider type.
1410
+ # @return [String]
1411
+ #
1412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/IdentityProvider AWS API Documentation
1413
+ #
1414
+ class IdentityProvider < Struct.new(
1415
+ :identity_provider_arn,
1416
+ :identity_provider_details,
1417
+ :identity_provider_name,
1418
+ :identity_provider_type)
1419
+ SENSITIVE = []
1420
+ include Aws::Structure
1421
+ end
1422
+
1423
+ # The summary of the identity provider.
1424
+ #
1425
+ # @!attribute [rw] identity_provider_arn
1426
+ # The ARN of the identity provider.
1427
+ # @return [String]
1428
+ #
1429
+ # @!attribute [rw] identity_provider_name
1430
+ # The identity provider name.
1431
+ # @return [String]
1432
+ #
1433
+ # @!attribute [rw] identity_provider_type
1434
+ # The identity provider type.
1435
+ # @return [String]
1436
+ #
1437
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/IdentityProviderSummary AWS API Documentation
1438
+ #
1439
+ class IdentityProviderSummary < Struct.new(
1440
+ :identity_provider_arn,
1441
+ :identity_provider_name,
1442
+ :identity_provider_type)
1443
+ SENSITIVE = []
1444
+ include Aws::Structure
1445
+ end
1446
+
1447
+ # There is an internal server error.
1448
+ #
1449
+ # @!attribute [rw] message
1450
+ # @return [String]
1451
+ #
1452
+ # @!attribute [rw] retry_after_seconds
1453
+ # Advice to clients on when the call can be safely retried.
1454
+ # @return [Integer]
1455
+ #
1456
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/InternalServerException AWS API Documentation
1457
+ #
1458
+ class InternalServerException < Struct.new(
1459
+ :message,
1460
+ :retry_after_seconds)
1461
+ SENSITIVE = []
1462
+ include Aws::Structure
1463
+ end
1464
+
1465
+ # @note When making an API call, you may pass ListBrowserSettingsRequest
1466
+ # data as a hash:
1467
+ #
1468
+ # {
1469
+ # max_results: 1,
1470
+ # next_token: "PaginationToken",
1471
+ # }
1472
+ #
1473
+ # @!attribute [rw] max_results
1474
+ # The maximum number of results to be included in the next page.
1475
+ # @return [Integer]
1476
+ #
1477
+ # @!attribute [rw] next_token
1478
+ # The pagination token used to retrieve the next page of results for
1479
+ # this operation.
1480
+ # @return [String]
1481
+ #
1482
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListBrowserSettingsRequest AWS API Documentation
1483
+ #
1484
+ class ListBrowserSettingsRequest < Struct.new(
1485
+ :max_results,
1486
+ :next_token)
1487
+ SENSITIVE = []
1488
+ include Aws::Structure
1489
+ end
1490
+
1491
+ # @!attribute [rw] browser_settings
1492
+ # The browser settings.
1493
+ # @return [Array<Types::BrowserSettingsSummary>]
1494
+ #
1495
+ # @!attribute [rw] next_token
1496
+ # The pagination token used to retrieve the next page of results for
1497
+ # this operation.
1498
+ # @return [String]
1499
+ #
1500
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListBrowserSettingsResponse AWS API Documentation
1501
+ #
1502
+ class ListBrowserSettingsResponse < Struct.new(
1503
+ :browser_settings,
1504
+ :next_token)
1505
+ SENSITIVE = []
1506
+ include Aws::Structure
1507
+ end
1508
+
1509
+ # @note When making an API call, you may pass ListIdentityProvidersRequest
1510
+ # data as a hash:
1511
+ #
1512
+ # {
1513
+ # max_results: 1,
1514
+ # next_token: "PaginationToken",
1515
+ # portal_arn: "ARN", # required
1516
+ # }
1517
+ #
1518
+ # @!attribute [rw] max_results
1519
+ # The maximum number of results to be included in the next page.
1520
+ # @return [Integer]
1521
+ #
1522
+ # @!attribute [rw] next_token
1523
+ # The pagination token used to retrieve the next page of results for
1524
+ # this operation.
1525
+ # @return [String]
1526
+ #
1527
+ # @!attribute [rw] portal_arn
1528
+ # The ARN of the web portal.
1529
+ # @return [String]
1530
+ #
1531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListIdentityProvidersRequest AWS API Documentation
1532
+ #
1533
+ class ListIdentityProvidersRequest < Struct.new(
1534
+ :max_results,
1535
+ :next_token,
1536
+ :portal_arn)
1537
+ SENSITIVE = []
1538
+ include Aws::Structure
1539
+ end
1540
+
1541
+ # @!attribute [rw] identity_providers
1542
+ # The identity providers.
1543
+ # @return [Array<Types::IdentityProviderSummary>]
1544
+ #
1545
+ # @!attribute [rw] next_token
1546
+ # The pagination token used to retrieve the next page of results for
1547
+ # this operation.
1548
+ # @return [String]
1549
+ #
1550
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListIdentityProvidersResponse AWS API Documentation
1551
+ #
1552
+ class ListIdentityProvidersResponse < Struct.new(
1553
+ :identity_providers,
1554
+ :next_token)
1555
+ SENSITIVE = []
1556
+ include Aws::Structure
1557
+ end
1558
+
1559
+ # @note When making an API call, you may pass ListNetworkSettingsRequest
1560
+ # data as a hash:
1561
+ #
1562
+ # {
1563
+ # max_results: 1,
1564
+ # next_token: "PaginationToken",
1565
+ # }
1566
+ #
1567
+ # @!attribute [rw] max_results
1568
+ # The maximum number of results to be included in the next page.
1569
+ # @return [Integer]
1570
+ #
1571
+ # @!attribute [rw] next_token
1572
+ # The pagination token used to retrieve the next page of results for
1573
+ # this operation.
1574
+ # @return [String]
1575
+ #
1576
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListNetworkSettingsRequest AWS API Documentation
1577
+ #
1578
+ class ListNetworkSettingsRequest < Struct.new(
1579
+ :max_results,
1580
+ :next_token)
1581
+ SENSITIVE = []
1582
+ include Aws::Structure
1583
+ end
1584
+
1585
+ # @!attribute [rw] network_settings
1586
+ # The network settings.
1587
+ # @return [Array<Types::NetworkSettingsSummary>]
1588
+ #
1589
+ # @!attribute [rw] next_token
1590
+ # The pagination token used to retrieve the next page of results for
1591
+ # this operation.
1592
+ # @return [String]
1593
+ #
1594
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListNetworkSettingsResponse AWS API Documentation
1595
+ #
1596
+ class ListNetworkSettingsResponse < Struct.new(
1597
+ :network_settings,
1598
+ :next_token)
1599
+ SENSITIVE = []
1600
+ include Aws::Structure
1601
+ end
1602
+
1603
+ # @note When making an API call, you may pass ListPortalsRequest
1604
+ # data as a hash:
1605
+ #
1606
+ # {
1607
+ # max_results: 1,
1608
+ # next_token: "PaginationToken",
1609
+ # }
1610
+ #
1611
+ # @!attribute [rw] max_results
1612
+ # The maximum number of results to be included in the next page.
1613
+ # @return [Integer]
1614
+ #
1615
+ # @!attribute [rw] next_token
1616
+ # The pagination token used to retrieve the next page of results for
1617
+ # this operation.
1618
+ # @return [String]
1619
+ #
1620
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListPortalsRequest AWS API Documentation
1621
+ #
1622
+ class ListPortalsRequest < Struct.new(
1623
+ :max_results,
1624
+ :next_token)
1625
+ SENSITIVE = []
1626
+ include Aws::Structure
1627
+ end
1628
+
1629
+ # @!attribute [rw] next_token
1630
+ # The pagination token used to retrieve the next page of results for
1631
+ # this operation.
1632
+ # @return [String]
1633
+ #
1634
+ # @!attribute [rw] portals
1635
+ # The portals in the list.
1636
+ # @return [Array<Types::PortalSummary>]
1637
+ #
1638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListPortalsResponse AWS API Documentation
1639
+ #
1640
+ class ListPortalsResponse < Struct.new(
1641
+ :next_token,
1642
+ :portals)
1643
+ SENSITIVE = []
1644
+ include Aws::Structure
1645
+ end
1646
+
1647
+ # @note When making an API call, you may pass ListTagsForResourceRequest
1648
+ # data as a hash:
1649
+ #
1650
+ # {
1651
+ # resource_arn: "ARN", # required
1652
+ # }
1653
+ #
1654
+ # @!attribute [rw] resource_arn
1655
+ # The ARN of the resource.
1656
+ # @return [String]
1657
+ #
1658
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListTagsForResourceRequest AWS API Documentation
1659
+ #
1660
+ class ListTagsForResourceRequest < Struct.new(
1661
+ :resource_arn)
1662
+ SENSITIVE = []
1663
+ include Aws::Structure
1664
+ end
1665
+
1666
+ # @!attribute [rw] tags
1667
+ # The tags of the resource.
1668
+ # @return [Array<Types::Tag>]
1669
+ #
1670
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListTagsForResourceResponse AWS API Documentation
1671
+ #
1672
+ class ListTagsForResourceResponse < Struct.new(
1673
+ :tags)
1674
+ SENSITIVE = []
1675
+ include Aws::Structure
1676
+ end
1677
+
1678
+ # @note When making an API call, you may pass ListTrustStoreCertificatesRequest
1679
+ # data as a hash:
1680
+ #
1681
+ # {
1682
+ # max_results: 1,
1683
+ # next_token: "PaginationToken",
1684
+ # trust_store_arn: "ARN", # required
1685
+ # }
1686
+ #
1687
+ # @!attribute [rw] max_results
1688
+ # The maximum number of results to be included in the next page.
1689
+ # @return [Integer]
1690
+ #
1691
+ # @!attribute [rw] next_token
1692
+ # The pagination token used to retrieve the next page of results for
1693
+ # this operation.
1694
+ # @return [String]
1695
+ #
1696
+ # @!attribute [rw] trust_store_arn
1697
+ # The ARN of the trust store
1698
+ # @return [String]
1699
+ #
1700
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListTrustStoreCertificatesRequest AWS API Documentation
1701
+ #
1702
+ class ListTrustStoreCertificatesRequest < Struct.new(
1703
+ :max_results,
1704
+ :next_token,
1705
+ :trust_store_arn)
1706
+ SENSITIVE = []
1707
+ include Aws::Structure
1708
+ end
1709
+
1710
+ # @!attribute [rw] certificate_list
1711
+ # The certificate list.
1712
+ # @return [Array<Types::CertificateSummary>]
1713
+ #
1714
+ # @!attribute [rw] next_token
1715
+ # The pagination token used to retrieve the next page of results for
1716
+ # this operation.&gt;
1717
+ # @return [String]
1718
+ #
1719
+ # @!attribute [rw] trust_store_arn
1720
+ # The ARN of the trust store.
1721
+ # @return [String]
1722
+ #
1723
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListTrustStoreCertificatesResponse AWS API Documentation
1724
+ #
1725
+ class ListTrustStoreCertificatesResponse < Struct.new(
1726
+ :certificate_list,
1727
+ :next_token,
1728
+ :trust_store_arn)
1729
+ SENSITIVE = []
1730
+ include Aws::Structure
1731
+ end
1732
+
1733
+ # @note When making an API call, you may pass ListTrustStoresRequest
1734
+ # data as a hash:
1735
+ #
1736
+ # {
1737
+ # max_results: 1,
1738
+ # next_token: "PaginationToken",
1739
+ # }
1740
+ #
1741
+ # @!attribute [rw] max_results
1742
+ # The maximum number of results to be included in the next page.
1743
+ # @return [Integer]
1744
+ #
1745
+ # @!attribute [rw] next_token
1746
+ # The pagination token used to retrieve the next page of results for
1747
+ # this operation.
1748
+ # @return [String]
1749
+ #
1750
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListTrustStoresRequest AWS API Documentation
1751
+ #
1752
+ class ListTrustStoresRequest < Struct.new(
1753
+ :max_results,
1754
+ :next_token)
1755
+ SENSITIVE = []
1756
+ include Aws::Structure
1757
+ end
1758
+
1759
+ # @!attribute [rw] next_token
1760
+ # The pagination token used to retrieve the next page of results for
1761
+ # this operation.
1762
+ # @return [String]
1763
+ #
1764
+ # @!attribute [rw] trust_stores
1765
+ # The trust stores.
1766
+ # @return [Array<Types::TrustStoreSummary>]
1767
+ #
1768
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListTrustStoresResponse AWS API Documentation
1769
+ #
1770
+ class ListTrustStoresResponse < Struct.new(
1771
+ :next_token,
1772
+ :trust_stores)
1773
+ SENSITIVE = []
1774
+ include Aws::Structure
1775
+ end
1776
+
1777
+ # @note When making an API call, you may pass ListUserSettingsRequest
1778
+ # data as a hash:
1779
+ #
1780
+ # {
1781
+ # max_results: 1,
1782
+ # next_token: "PaginationToken",
1783
+ # }
1784
+ #
1785
+ # @!attribute [rw] max_results
1786
+ # The maximum number of results to be included in the next page.
1787
+ # @return [Integer]
1788
+ #
1789
+ # @!attribute [rw] next_token
1790
+ # The pagination token used to retrieve the next page of results for
1791
+ # this operation.
1792
+ # @return [String]
1793
+ #
1794
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListUserSettingsRequest AWS API Documentation
1795
+ #
1796
+ class ListUserSettingsRequest < Struct.new(
1797
+ :max_results,
1798
+ :next_token)
1799
+ SENSITIVE = []
1800
+ include Aws::Structure
1801
+ end
1802
+
1803
+ # @!attribute [rw] next_token
1804
+ # The pagination token used to retrieve the next page of results for
1805
+ # this operation.
1806
+ # @return [String]
1807
+ #
1808
+ # @!attribute [rw] user_settings
1809
+ # The user settings.
1810
+ # @return [Array<Types::UserSettingsSummary>]
1811
+ #
1812
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListUserSettingsResponse AWS API Documentation
1813
+ #
1814
+ class ListUserSettingsResponse < Struct.new(
1815
+ :next_token,
1816
+ :user_settings)
1817
+ SENSITIVE = []
1818
+ include Aws::Structure
1819
+ end
1820
+
1821
+ # A network settings resource that can be associated with a web portal.
1822
+ # Once associated with a web portal, network settings define how
1823
+ # streaming instances will connect with your specified VPC.
1824
+ #
1825
+ # @!attribute [rw] associated_portal_arns
1826
+ # A list of web portal ARNs that this network settings is associated
1827
+ # with.
1828
+ # @return [Array<String>]
1829
+ #
1830
+ # @!attribute [rw] network_settings_arn
1831
+ # The ARN of the network settings.
1832
+ # @return [String]
1833
+ #
1834
+ # @!attribute [rw] security_group_ids
1835
+ # One or more security groups used to control access from streaming
1836
+ # instances to your VPC.
1837
+ # @return [Array<String>]
1838
+ #
1839
+ # @!attribute [rw] subnet_ids
1840
+ # The subnets in which network interfaces are created to connect
1841
+ # streaming instances to your VPC. At least two of these subnets must
1842
+ # be in different availability zones.
1843
+ # @return [Array<String>]
1844
+ #
1845
+ # @!attribute [rw] vpc_id
1846
+ # The VPC that streaming instances will connect to.
1847
+ # @return [String]
1848
+ #
1849
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/NetworkSettings AWS API Documentation
1850
+ #
1851
+ class NetworkSettings < Struct.new(
1852
+ :associated_portal_arns,
1853
+ :network_settings_arn,
1854
+ :security_group_ids,
1855
+ :subnet_ids,
1856
+ :vpc_id)
1857
+ SENSITIVE = []
1858
+ include Aws::Structure
1859
+ end
1860
+
1861
+ # The summary of network settings.
1862
+ #
1863
+ # @!attribute [rw] network_settings_arn
1864
+ # The ARN of the network settings.
1865
+ # @return [String]
1866
+ #
1867
+ # @!attribute [rw] vpc_id
1868
+ # The VPC ID of the network settings.
1869
+ # @return [String]
1870
+ #
1871
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/NetworkSettingsSummary AWS API Documentation
1872
+ #
1873
+ class NetworkSettingsSummary < Struct.new(
1874
+ :network_settings_arn,
1875
+ :vpc_id)
1876
+ SENSITIVE = []
1877
+ include Aws::Structure
1878
+ end
1879
+
1880
+ # The web portal.
1881
+ #
1882
+ # @!attribute [rw] browser_settings_arn
1883
+ # The ARN of the browser settings that is associated with this web
1884
+ # portal.
1885
+ # @return [String]
1886
+ #
1887
+ # @!attribute [rw] browser_type
1888
+ # The browser that users see when using a streaming session.
1889
+ # @return [String]
1890
+ #
1891
+ # @!attribute [rw] creation_date
1892
+ # The creation date of the web portal.
1893
+ # @return [Time]
1894
+ #
1895
+ # @!attribute [rw] display_name
1896
+ # The name of the web portal.
1897
+ # @return [String]
1898
+ #
1899
+ # @!attribute [rw] network_settings_arn
1900
+ # The ARN of the network settings that is associated with the web
1901
+ # portal.
1902
+ # @return [String]
1903
+ #
1904
+ # @!attribute [rw] portal_arn
1905
+ # The ARN of the web portal.
1906
+ # @return [String]
1907
+ #
1908
+ # @!attribute [rw] portal_endpoint
1909
+ # The endpoint URL of the web portal that users access in order to
1910
+ # start streaming sessions.
1911
+ # @return [String]
1912
+ #
1913
+ # @!attribute [rw] portal_status
1914
+ # The status of the web portal.
1915
+ # @return [String]
1916
+ #
1917
+ # @!attribute [rw] renderer_type
1918
+ # The renderer that is used in streaming sessions.
1919
+ # @return [String]
1920
+ #
1921
+ # @!attribute [rw] status_reason
1922
+ # A message that explains why the web portal is in its current status.
1923
+ # @return [String]
1924
+ #
1925
+ # @!attribute [rw] trust_store_arn
1926
+ # The ARN of the trust store that is associated with the web portal.
1927
+ # @return [String]
1928
+ #
1929
+ # @!attribute [rw] user_settings_arn
1930
+ # The ARN of the trust store that is associated with the web portal.
1931
+ # @return [String]
1932
+ #
1933
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/Portal AWS API Documentation
1934
+ #
1935
+ class Portal < Struct.new(
1936
+ :browser_settings_arn,
1937
+ :browser_type,
1938
+ :creation_date,
1939
+ :display_name,
1940
+ :network_settings_arn,
1941
+ :portal_arn,
1942
+ :portal_endpoint,
1943
+ :portal_status,
1944
+ :renderer_type,
1945
+ :status_reason,
1946
+ :trust_store_arn,
1947
+ :user_settings_arn)
1948
+ SENSITIVE = []
1949
+ include Aws::Structure
1950
+ end
1951
+
1952
+ # The summary of the portal.
1953
+ #
1954
+ # @!attribute [rw] browser_settings_arn
1955
+ # The ARN of the browser settings that is associated with the web
1956
+ # portal.
1957
+ # @return [String]
1958
+ #
1959
+ # @!attribute [rw] browser_type
1960
+ # The browser type of the web portal.
1961
+ # @return [String]
1962
+ #
1963
+ # @!attribute [rw] creation_date
1964
+ # The creation date of the web portal.
1965
+ # @return [Time]
1966
+ #
1967
+ # @!attribute [rw] display_name
1968
+ # The name of the web portal.
1969
+ # @return [String]
1970
+ #
1971
+ # @!attribute [rw] network_settings_arn
1972
+ # The ARN of the network settings that is associated with the web
1973
+ # portal.
1974
+ # @return [String]
1975
+ #
1976
+ # @!attribute [rw] portal_arn
1977
+ # The ARN of the web portal.
1978
+ # @return [String]
1979
+ #
1980
+ # @!attribute [rw] portal_endpoint
1981
+ # The endpoint URL of the web portal that users access in order to
1982
+ # start streaming sessions.
1983
+ # @return [String]
1984
+ #
1985
+ # @!attribute [rw] portal_status
1986
+ # The status of the web portal.
1987
+ # @return [String]
1988
+ #
1989
+ # @!attribute [rw] renderer_type
1990
+ # The renderer that is used in streaming sessions.
1991
+ # @return [String]
1992
+ #
1993
+ # @!attribute [rw] trust_store_arn
1994
+ # The ARN of the trust that is associated with this web portal.
1995
+ # @return [String]
1996
+ #
1997
+ # @!attribute [rw] user_settings_arn
1998
+ # The ARN of the user settings that is associated with the web portal.
1999
+ # @return [String]
2000
+ #
2001
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/PortalSummary AWS API Documentation
2002
+ #
2003
+ class PortalSummary < Struct.new(
2004
+ :browser_settings_arn,
2005
+ :browser_type,
2006
+ :creation_date,
2007
+ :display_name,
2008
+ :network_settings_arn,
2009
+ :portal_arn,
2010
+ :portal_endpoint,
2011
+ :portal_status,
2012
+ :renderer_type,
2013
+ :trust_store_arn,
2014
+ :user_settings_arn)
2015
+ SENSITIVE = []
2016
+ include Aws::Structure
2017
+ end
2018
+
2019
+ # The resource cannot be found.
2020
+ #
2021
+ # @!attribute [rw] message
2022
+ # @return [String]
2023
+ #
2024
+ # @!attribute [rw] resource_id
2025
+ # Hypothetical identifier of the resource affected.
2026
+ # @return [String]
2027
+ #
2028
+ # @!attribute [rw] resource_type
2029
+ # Hypothetical type of the resource affected.
2030
+ # @return [String]
2031
+ #
2032
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ResourceNotFoundException AWS API Documentation
2033
+ #
2034
+ class ResourceNotFoundException < Struct.new(
2035
+ :message,
2036
+ :resource_id,
2037
+ :resource_type)
2038
+ SENSITIVE = []
2039
+ include Aws::Structure
2040
+ end
2041
+
2042
+ # The service quota has been exceeded.
2043
+ #
2044
+ # @!attribute [rw] message
2045
+ # @return [String]
2046
+ #
2047
+ # @!attribute [rw] quota_code
2048
+ # The originating quota.
2049
+ # @return [String]
2050
+ #
2051
+ # @!attribute [rw] resource_id
2052
+ # Identifier of the resource affected.
2053
+ # @return [String]
2054
+ #
2055
+ # @!attribute [rw] resource_type
2056
+ # Type of the resource affected.
2057
+ # @return [String]
2058
+ #
2059
+ # @!attribute [rw] service_code
2060
+ # The originating service.
2061
+ # @return [String]
2062
+ #
2063
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ServiceQuotaExceededException AWS API Documentation
2064
+ #
2065
+ class ServiceQuotaExceededException < Struct.new(
2066
+ :message,
2067
+ :quota_code,
2068
+ :resource_id,
2069
+ :resource_type,
2070
+ :service_code)
2071
+ SENSITIVE = []
2072
+ include Aws::Structure
2073
+ end
2074
+
2075
+ # The tag.
2076
+ #
2077
+ # @note When making an API call, you may pass Tag
2078
+ # data as a hash:
2079
+ #
2080
+ # {
2081
+ # key: "TagKey", # required
2082
+ # value: "TagValue", # required
2083
+ # }
2084
+ #
2085
+ # @!attribute [rw] key
2086
+ # The key of the tag.
2087
+ # @return [String]
2088
+ #
2089
+ # @!attribute [rw] value
2090
+ # The value of the tag
2091
+ # @return [String]
2092
+ #
2093
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/Tag AWS API Documentation
2094
+ #
2095
+ class Tag < Struct.new(
2096
+ :key,
2097
+ :value)
2098
+ SENSITIVE = []
2099
+ include Aws::Structure
2100
+ end
2101
+
2102
+ # @note When making an API call, you may pass TagResourceRequest
2103
+ # data as a hash:
2104
+ #
2105
+ # {
2106
+ # client_token: "ClientToken",
2107
+ # resource_arn: "ARN", # required
2108
+ # tags: [ # required
2109
+ # {
2110
+ # key: "TagKey", # required
2111
+ # value: "TagValue", # required
2112
+ # },
2113
+ # ],
2114
+ # }
2115
+ #
2116
+ # @!attribute [rw] client_token
2117
+ # A unique, case-sensitive identifier that you provide to ensure the
2118
+ # idempotency of the request. Idempotency ensures that an API request
2119
+ # completes only once. With an idempotent request, if the original
2120
+ # request completes successfully, subsequent retries with the same
2121
+ # client token returns the result from the original successful
2122
+ # request.
2123
+ #
2124
+ # If you do not specify a client token, one is automatically generated
2125
+ # by the AWS SDK.
2126
+ #
2127
+ # **A suitable default value is auto-generated.** You should normally
2128
+ # not need to pass this option.
2129
+ # @return [String]
2130
+ #
2131
+ # @!attribute [rw] resource_arn
2132
+ # The ARN of the resource.
2133
+ # @return [String]
2134
+ #
2135
+ # @!attribute [rw] tags
2136
+ # The tags of the resource.
2137
+ # @return [Array<Types::Tag>]
2138
+ #
2139
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/TagResourceRequest AWS API Documentation
2140
+ #
2141
+ class TagResourceRequest < Struct.new(
2142
+ :client_token,
2143
+ :resource_arn,
2144
+ :tags)
2145
+ SENSITIVE = []
2146
+ include Aws::Structure
2147
+ end
2148
+
2149
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/TagResourceResponse AWS API Documentation
2150
+ #
2151
+ class TagResourceResponse < Aws::EmptyStructure; end
2152
+
2153
+ # There is a throttling error.
2154
+ #
2155
+ # @!attribute [rw] message
2156
+ # @return [String]
2157
+ #
2158
+ # @!attribute [rw] quota_code
2159
+ # The originating quota.
2160
+ # @return [String]
2161
+ #
2162
+ # @!attribute [rw] retry_after_seconds
2163
+ # Advice to clients on when the call can be safely retried.
2164
+ # @return [Integer]
2165
+ #
2166
+ # @!attribute [rw] service_code
2167
+ # The originating service.
2168
+ # @return [String]
2169
+ #
2170
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ThrottlingException AWS API Documentation
2171
+ #
2172
+ class ThrottlingException < Struct.new(
2173
+ :message,
2174
+ :quota_code,
2175
+ :retry_after_seconds,
2176
+ :service_code)
2177
+ SENSITIVE = []
2178
+ include Aws::Structure
2179
+ end
2180
+
2181
+ # There are too many tags.
2182
+ #
2183
+ # @!attribute [rw] message
2184
+ # @return [String]
2185
+ #
2186
+ # @!attribute [rw] resource_name
2187
+ # Name of the resource affected.
2188
+ # @return [String]
2189
+ #
2190
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/TooManyTagsException AWS API Documentation
2191
+ #
2192
+ class TooManyTagsException < Struct.new(
2193
+ :message,
2194
+ :resource_name)
2195
+ SENSITIVE = []
2196
+ include Aws::Structure
2197
+ end
2198
+
2199
+ # A trust store that can be associated with a web portal. A trust store
2200
+ # contains certificate authority (CA) certificates. Once associated with
2201
+ # a web portal, the browser in a streaming session will recognize
2202
+ # certificates that have been issued using any of the CAs in the trust
2203
+ # store. If your organization has internal websites that use
2204
+ # certificates issued by private CAs, you should add the private CA
2205
+ # certificate to the trust store.
2206
+ #
2207
+ # @!attribute [rw] associated_portal_arns
2208
+ # A list of web portal ARNs that this trust store is associated with.
2209
+ # @return [Array<String>]
2210
+ #
2211
+ # @!attribute [rw] trust_store_arn
2212
+ # The ARN of the trust store.
2213
+ # @return [String]
2214
+ #
2215
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/TrustStore AWS API Documentation
2216
+ #
2217
+ class TrustStore < Struct.new(
2218
+ :associated_portal_arns,
2219
+ :trust_store_arn)
2220
+ SENSITIVE = []
2221
+ include Aws::Structure
2222
+ end
2223
+
2224
+ # The summary of the trust store.
2225
+ #
2226
+ # @!attribute [rw] trust_store_arn
2227
+ # The ARN of the trust store.
2228
+ # @return [String]
2229
+ #
2230
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/TrustStoreSummary AWS API Documentation
2231
+ #
2232
+ class TrustStoreSummary < Struct.new(
2233
+ :trust_store_arn)
2234
+ SENSITIVE = []
2235
+ include Aws::Structure
2236
+ end
2237
+
2238
+ # @note When making an API call, you may pass UntagResourceRequest
2239
+ # data as a hash:
2240
+ #
2241
+ # {
2242
+ # resource_arn: "ARN", # required
2243
+ # tag_keys: ["TagKey"], # required
2244
+ # }
2245
+ #
2246
+ # @!attribute [rw] resource_arn
2247
+ # The ARN of the resource.
2248
+ # @return [String]
2249
+ #
2250
+ # @!attribute [rw] tag_keys
2251
+ # The list of tag keys to remove from the resource.
2252
+ # @return [Array<String>]
2253
+ #
2254
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UntagResourceRequest AWS API Documentation
2255
+ #
2256
+ class UntagResourceRequest < Struct.new(
2257
+ :resource_arn,
2258
+ :tag_keys)
2259
+ SENSITIVE = []
2260
+ include Aws::Structure
2261
+ end
2262
+
2263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UntagResourceResponse AWS API Documentation
2264
+ #
2265
+ class UntagResourceResponse < Aws::EmptyStructure; end
2266
+
2267
+ # @note When making an API call, you may pass UpdateBrowserSettingsRequest
2268
+ # data as a hash:
2269
+ #
2270
+ # {
2271
+ # browser_policy: "BrowserPolicy",
2272
+ # browser_settings_arn: "ARN", # required
2273
+ # client_token: "ClientToken",
2274
+ # }
2275
+ #
2276
+ # @!attribute [rw] browser_policy
2277
+ # A JSON string containing Chrome Enterprise policies that will be
2278
+ # applied to all streaming sessions.
2279
+ # @return [String]
2280
+ #
2281
+ # @!attribute [rw] browser_settings_arn
2282
+ # The ARN of the browser settings.
2283
+ # @return [String]
2284
+ #
2285
+ # @!attribute [rw] client_token
2286
+ # A unique, case-sensitive identifier that you provide to ensure the
2287
+ # idempotency of the request. Idempotency ensures that an API request
2288
+ # completes only once. With an idempotent request, if the original
2289
+ # request completes successfully, subsequent retries with the same
2290
+ # client token return the result from the original successful request.
2291
+ #
2292
+ # If you do not specify a client token, one is automatically generated
2293
+ # by the AWS SDK.
2294
+ #
2295
+ # **A suitable default value is auto-generated.** You should normally
2296
+ # not need to pass this option.
2297
+ # @return [String]
2298
+ #
2299
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateBrowserSettingsRequest AWS API Documentation
2300
+ #
2301
+ class UpdateBrowserSettingsRequest < Struct.new(
2302
+ :browser_policy,
2303
+ :browser_settings_arn,
2304
+ :client_token)
2305
+ SENSITIVE = []
2306
+ include Aws::Structure
2307
+ end
2308
+
2309
+ # @!attribute [rw] browser_settings
2310
+ # The browser settings.
2311
+ # @return [Types::BrowserSettings]
2312
+ #
2313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateBrowserSettingsResponse AWS API Documentation
2314
+ #
2315
+ class UpdateBrowserSettingsResponse < Struct.new(
2316
+ :browser_settings)
2317
+ SENSITIVE = []
2318
+ include Aws::Structure
2319
+ end
2320
+
2321
+ # @note When making an API call, you may pass UpdateIdentityProviderRequest
2322
+ # data as a hash:
2323
+ #
2324
+ # {
2325
+ # client_token: "ClientToken",
2326
+ # identity_provider_arn: "ARN", # required
2327
+ # identity_provider_details: {
2328
+ # "StringType" => "StringType",
2329
+ # },
2330
+ # identity_provider_name: "IdentityProviderName",
2331
+ # identity_provider_type: "SAML", # accepts SAML, Facebook, Google, LoginWithAmazon, SignInWithApple, OIDC
2332
+ # }
2333
+ #
2334
+ # @!attribute [rw] client_token
2335
+ # A unique, case-sensitive identifier that you provide to ensure the
2336
+ # idempotency of the request. Idempotency ensures that an API request
2337
+ # completes only once. With an idempotent request, if the original
2338
+ # request completes successfully, subsequent retries with the same
2339
+ # client token return the result from the original successful request.
2340
+ #
2341
+ # If you do not specify a client token, one is automatically generated
2342
+ # by the AWS SDK.
2343
+ #
2344
+ # **A suitable default value is auto-generated.** You should normally
2345
+ # not need to pass this option.
2346
+ # @return [String]
2347
+ #
2348
+ # @!attribute [rw] identity_provider_arn
2349
+ # The ARN of the identity provider.
2350
+ # @return [String]
2351
+ #
2352
+ # @!attribute [rw] identity_provider_details
2353
+ # The details of the identity provider.
2354
+ # @return [Hash<String,String>]
2355
+ #
2356
+ # @!attribute [rw] identity_provider_name
2357
+ # The name of the identity provider.
2358
+ # @return [String]
2359
+ #
2360
+ # @!attribute [rw] identity_provider_type
2361
+ # The type of the identity provider.
2362
+ # @return [String]
2363
+ #
2364
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateIdentityProviderRequest AWS API Documentation
2365
+ #
2366
+ class UpdateIdentityProviderRequest < Struct.new(
2367
+ :client_token,
2368
+ :identity_provider_arn,
2369
+ :identity_provider_details,
2370
+ :identity_provider_name,
2371
+ :identity_provider_type)
2372
+ SENSITIVE = []
2373
+ include Aws::Structure
2374
+ end
2375
+
2376
+ # @!attribute [rw] identity_provider
2377
+ # The identity provider.
2378
+ # @return [Types::IdentityProvider]
2379
+ #
2380
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateIdentityProviderResponse AWS API Documentation
2381
+ #
2382
+ class UpdateIdentityProviderResponse < Struct.new(
2383
+ :identity_provider)
2384
+ SENSITIVE = []
2385
+ include Aws::Structure
2386
+ end
2387
+
2388
+ # @note When making an API call, you may pass UpdateNetworkSettingsRequest
2389
+ # data as a hash:
2390
+ #
2391
+ # {
2392
+ # client_token: "ClientToken",
2393
+ # network_settings_arn: "ARN", # required
2394
+ # security_group_ids: ["SecurityGroupId"],
2395
+ # subnet_ids: ["SubnetId"],
2396
+ # vpc_id: "VpcId",
2397
+ # }
2398
+ #
2399
+ # @!attribute [rw] client_token
2400
+ # A unique, case-sensitive identifier that you provide to ensure the
2401
+ # idempotency of the request. Idempotency ensures that an API request
2402
+ # completes only once. With an idempotent request, if the original
2403
+ # request completes successfully, subsequent retries with the same
2404
+ # client token return the result from the original successful request.
2405
+ #
2406
+ # If you do not specify a client token, one is automatically generated
2407
+ # by the AWS SDK.
2408
+ #
2409
+ # **A suitable default value is auto-generated.** You should normally
2410
+ # not need to pass this option.
2411
+ # @return [String]
2412
+ #
2413
+ # @!attribute [rw] network_settings_arn
2414
+ # The ARN of the network settings.
2415
+ # @return [String]
2416
+ #
2417
+ # @!attribute [rw] security_group_ids
2418
+ # One or more security groups used to control access from streaming
2419
+ # instances to your VPC.
2420
+ # @return [Array<String>]
2421
+ #
2422
+ # @!attribute [rw] subnet_ids
2423
+ # The subnets in which network interfaces are created to connect
2424
+ # streaming instances to your VPC. At least two of these subnets must
2425
+ # be in different availability zones.
2426
+ # @return [Array<String>]
2427
+ #
2428
+ # @!attribute [rw] vpc_id
2429
+ # The VPC that streaming instances will connect to.
2430
+ # @return [String]
2431
+ #
2432
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateNetworkSettingsRequest AWS API Documentation
2433
+ #
2434
+ class UpdateNetworkSettingsRequest < Struct.new(
2435
+ :client_token,
2436
+ :network_settings_arn,
2437
+ :security_group_ids,
2438
+ :subnet_ids,
2439
+ :vpc_id)
2440
+ SENSITIVE = []
2441
+ include Aws::Structure
2442
+ end
2443
+
2444
+ # @!attribute [rw] network_settings
2445
+ # The network settings.
2446
+ # @return [Types::NetworkSettings]
2447
+ #
2448
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateNetworkSettingsResponse AWS API Documentation
2449
+ #
2450
+ class UpdateNetworkSettingsResponse < Struct.new(
2451
+ :network_settings)
2452
+ SENSITIVE = []
2453
+ include Aws::Structure
2454
+ end
2455
+
2456
+ # @note When making an API call, you may pass UpdatePortalRequest
2457
+ # data as a hash:
2458
+ #
2459
+ # {
2460
+ # display_name: "DisplayName",
2461
+ # portal_arn: "ARN", # required
2462
+ # }
2463
+ #
2464
+ # @!attribute [rw] display_name
2465
+ # The name of the web portal. This is not visible to users who log
2466
+ # into the web portal.
2467
+ # @return [String]
2468
+ #
2469
+ # @!attribute [rw] portal_arn
2470
+ # The ARN of the web portal.
2471
+ # @return [String]
2472
+ #
2473
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdatePortalRequest AWS API Documentation
2474
+ #
2475
+ class UpdatePortalRequest < Struct.new(
2476
+ :display_name,
2477
+ :portal_arn)
2478
+ SENSITIVE = []
2479
+ include Aws::Structure
2480
+ end
2481
+
2482
+ # @!attribute [rw] portal
2483
+ # The web portal.
2484
+ # @return [Types::Portal]
2485
+ #
2486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdatePortalResponse AWS API Documentation
2487
+ #
2488
+ class UpdatePortalResponse < Struct.new(
2489
+ :portal)
2490
+ SENSITIVE = []
2491
+ include Aws::Structure
2492
+ end
2493
+
2494
+ # @note When making an API call, you may pass UpdateTrustStoreRequest
2495
+ # data as a hash:
2496
+ #
2497
+ # {
2498
+ # certificates_to_add: ["data"],
2499
+ # certificates_to_delete: ["CertificateThumbprint"],
2500
+ # client_token: "ClientToken",
2501
+ # trust_store_arn: "ARN", # required
2502
+ # }
2503
+ #
2504
+ # @!attribute [rw] certificates_to_add
2505
+ # A list of CA certificates to add to the trust store.
2506
+ # @return [Array<String>]
2507
+ #
2508
+ # @!attribute [rw] certificates_to_delete
2509
+ # A list of CA certificates to delete from a trust store.
2510
+ # @return [Array<String>]
2511
+ #
2512
+ # @!attribute [rw] client_token
2513
+ # A unique, case-sensitive identifier that you provide to ensure the
2514
+ # idempotency of the request. Idempotency ensures that an API request
2515
+ # completes only once. With an idempotent request, if the original
2516
+ # request completes successfully, subsequent retries with the same
2517
+ # client token return the result from the original successful request.
2518
+ #
2519
+ # If you do not specify a client token, one is automatically generated
2520
+ # by the AWS SDK.
2521
+ #
2522
+ # **A suitable default value is auto-generated.** You should normally
2523
+ # not need to pass this option.
2524
+ # @return [String]
2525
+ #
2526
+ # @!attribute [rw] trust_store_arn
2527
+ # The ARN of the trust store.
2528
+ # @return [String]
2529
+ #
2530
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateTrustStoreRequest AWS API Documentation
2531
+ #
2532
+ class UpdateTrustStoreRequest < Struct.new(
2533
+ :certificates_to_add,
2534
+ :certificates_to_delete,
2535
+ :client_token,
2536
+ :trust_store_arn)
2537
+ SENSITIVE = []
2538
+ include Aws::Structure
2539
+ end
2540
+
2541
+ # @!attribute [rw] trust_store_arn
2542
+ # The ARN of the trust store.
2543
+ # @return [String]
2544
+ #
2545
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateTrustStoreResponse AWS API Documentation
2546
+ #
2547
+ class UpdateTrustStoreResponse < Struct.new(
2548
+ :trust_store_arn)
2549
+ SENSITIVE = []
2550
+ include Aws::Structure
2551
+ end
2552
+
2553
+ # @note When making an API call, you may pass UpdateUserSettingsRequest
2554
+ # data as a hash:
2555
+ #
2556
+ # {
2557
+ # client_token: "ClientToken",
2558
+ # copy_allowed: "Disabled", # accepts Disabled, Enabled
2559
+ # download_allowed: "Disabled", # accepts Disabled, Enabled
2560
+ # paste_allowed: "Disabled", # accepts Disabled, Enabled
2561
+ # print_allowed: "Disabled", # accepts Disabled, Enabled
2562
+ # upload_allowed: "Disabled", # accepts Disabled, Enabled
2563
+ # user_settings_arn: "ARN", # required
2564
+ # }
2565
+ #
2566
+ # @!attribute [rw] client_token
2567
+ # A unique, case-sensitive identifier that you provide to ensure the
2568
+ # idempotency of the request. Idempotency ensures that an API request
2569
+ # completes only once. With an idempotent request, if the original
2570
+ # request completes successfully, subsequent retries with the same
2571
+ # client token return the result from the original successful request.
2572
+ #
2573
+ # If you do not specify a client token, one is automatically generated
2574
+ # by the AWS SDK.
2575
+ #
2576
+ # **A suitable default value is auto-generated.** You should normally
2577
+ # not need to pass this option.
2578
+ # @return [String]
2579
+ #
2580
+ # @!attribute [rw] copy_allowed
2581
+ # Specifies whether the user can copy text from the streaming session
2582
+ # to the local device.
2583
+ # @return [String]
2584
+ #
2585
+ # @!attribute [rw] download_allowed
2586
+ # Specifies whether the user can download files from the streaming
2587
+ # session to the local device.
2588
+ # @return [String]
2589
+ #
2590
+ # @!attribute [rw] paste_allowed
2591
+ # Specifies whether the user can paste text from the local device to
2592
+ # the streaming session.
2593
+ # @return [String]
2594
+ #
2595
+ # @!attribute [rw] print_allowed
2596
+ # Specifies whether the user can print to the local device.
2597
+ # @return [String]
2598
+ #
2599
+ # @!attribute [rw] upload_allowed
2600
+ # Specifies whether the user can upload files from the local device to
2601
+ # the streaming session.
2602
+ # @return [String]
2603
+ #
2604
+ # @!attribute [rw] user_settings_arn
2605
+ # The ARN of the user settings.
2606
+ # @return [String]
2607
+ #
2608
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateUserSettingsRequest AWS API Documentation
2609
+ #
2610
+ class UpdateUserSettingsRequest < Struct.new(
2611
+ :client_token,
2612
+ :copy_allowed,
2613
+ :download_allowed,
2614
+ :paste_allowed,
2615
+ :print_allowed,
2616
+ :upload_allowed,
2617
+ :user_settings_arn)
2618
+ SENSITIVE = []
2619
+ include Aws::Structure
2620
+ end
2621
+
2622
+ # @!attribute [rw] user_settings
2623
+ # The user settings.
2624
+ # @return [Types::UserSettings]
2625
+ #
2626
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateUserSettingsResponse AWS API Documentation
2627
+ #
2628
+ class UpdateUserSettingsResponse < Struct.new(
2629
+ :user_settings)
2630
+ SENSITIVE = []
2631
+ include Aws::Structure
2632
+ end
2633
+
2634
+ # A user settings resource that can be associated with a web portal.
2635
+ # Once associated with a web portal, user settings control how users can
2636
+ # transfer data between a streaming session and the their local devices.
2637
+ #
2638
+ # @!attribute [rw] associated_portal_arns
2639
+ # A list of web portal ARNs that this user settings is associated
2640
+ # with.
2641
+ # @return [Array<String>]
2642
+ #
2643
+ # @!attribute [rw] copy_allowed
2644
+ # Specifies whether the user can copy text from the streaming session
2645
+ # to the local device.
2646
+ # @return [String]
2647
+ #
2648
+ # @!attribute [rw] download_allowed
2649
+ # Specifies whether the user can download files from the streaming
2650
+ # session to the local device.
2651
+ # @return [String]
2652
+ #
2653
+ # @!attribute [rw] paste_allowed
2654
+ # Specifies whether the user can paste text from the local device to
2655
+ # the streaming session.
2656
+ # @return [String]
2657
+ #
2658
+ # @!attribute [rw] print_allowed
2659
+ # Specifies whether the user can print to the local device.
2660
+ # @return [String]
2661
+ #
2662
+ # @!attribute [rw] upload_allowed
2663
+ # Specifies whether the user can upload files from the local device to
2664
+ # the streaming session.
2665
+ # @return [String]
2666
+ #
2667
+ # @!attribute [rw] user_settings_arn
2668
+ # The ARN of the user settings.
2669
+ # @return [String]
2670
+ #
2671
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UserSettings AWS API Documentation
2672
+ #
2673
+ class UserSettings < Struct.new(
2674
+ :associated_portal_arns,
2675
+ :copy_allowed,
2676
+ :download_allowed,
2677
+ :paste_allowed,
2678
+ :print_allowed,
2679
+ :upload_allowed,
2680
+ :user_settings_arn)
2681
+ SENSITIVE = []
2682
+ include Aws::Structure
2683
+ end
2684
+
2685
+ # The summary of user settings.
2686
+ #
2687
+ # @!attribute [rw] copy_allowed
2688
+ # Specifies whether the user can copy text from the streaming session
2689
+ # to the local device.
2690
+ # @return [String]
2691
+ #
2692
+ # @!attribute [rw] download_allowed
2693
+ # Specifies whether the user can download files from the streaming
2694
+ # session to the local device.
2695
+ # @return [String]
2696
+ #
2697
+ # @!attribute [rw] paste_allowed
2698
+ # Specifies whether the user can paste text from the local device to
2699
+ # the streaming session.
2700
+ # @return [String]
2701
+ #
2702
+ # @!attribute [rw] print_allowed
2703
+ # Specifies whether the user can print to the local device.
2704
+ # @return [String]
2705
+ #
2706
+ # @!attribute [rw] upload_allowed
2707
+ # Specifies whether the user can upload files from the local device to
2708
+ # the streaming session.
2709
+ # @return [String]
2710
+ #
2711
+ # @!attribute [rw] user_settings_arn
2712
+ # The ARN of the user settings.
2713
+ # @return [String]
2714
+ #
2715
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UserSettingsSummary AWS API Documentation
2716
+ #
2717
+ class UserSettingsSummary < Struct.new(
2718
+ :copy_allowed,
2719
+ :download_allowed,
2720
+ :paste_allowed,
2721
+ :print_allowed,
2722
+ :upload_allowed,
2723
+ :user_settings_arn)
2724
+ SENSITIVE = []
2725
+ include Aws::Structure
2726
+ end
2727
+
2728
+ # There is a validation error.
2729
+ #
2730
+ # @!attribute [rw] field_list
2731
+ # The field that caused the error.
2732
+ # @return [Array<Types::ValidationExceptionField>]
2733
+ #
2734
+ # @!attribute [rw] message
2735
+ # @return [String]
2736
+ #
2737
+ # @!attribute [rw] reason
2738
+ # Reason the request failed validation
2739
+ # @return [String]
2740
+ #
2741
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ValidationException AWS API Documentation
2742
+ #
2743
+ class ValidationException < Struct.new(
2744
+ :field_list,
2745
+ :message,
2746
+ :reason)
2747
+ SENSITIVE = []
2748
+ include Aws::Structure
2749
+ end
2750
+
2751
+ # Information about a field passed inside a request that resulted in an
2752
+ # exception.
2753
+ #
2754
+ # @!attribute [rw] message
2755
+ # The message describing why the field failed validation.
2756
+ # @return [String]
2757
+ #
2758
+ # @!attribute [rw] name
2759
+ # The name of the field that failed validation.
2760
+ # @return [String]
2761
+ #
2762
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ValidationExceptionField AWS API Documentation
2763
+ #
2764
+ class ValidationExceptionField < Struct.new(
2765
+ :message,
2766
+ :name)
2767
+ SENSITIVE = []
2768
+ include Aws::Structure
2769
+ end
2770
+
2771
+ end
2772
+ end