aws-sdk-workspacesweb 1.52.0 → 1.53.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8f0e56f7ff1f711c70eda251a4b7b678b5f9ea02a132096099aa0df1a716f561
4
- data.tar.gz: 2b8c0e6c14c3eb3ede485c946e6e98ec8d0982d2c6e2f7b12ba4938bd4687d9a
3
+ metadata.gz: edfbf4a427a8af19d4b983601cc2a7ae65649450da006a377fc3e79b078280c7
4
+ data.tar.gz: 97ddb891da7b3c4b3281aab97092e03a5a02a0a03e34d14f62d4f0a1ecf9e7bc
5
5
  SHA512:
6
- metadata.gz: a4a619eb3581243bc347c3b24ea27ff5aa69b9288f7d844a1c758619b2924d8dad6c918173720dd7d7d41913d1f711aaea7724637765de08d75b64f20bdd29ac
7
- data.tar.gz: 904692d4e781bd8d1433e084890e9e07d5496b6890991735660be9c327ec909411793a64a4d4fe6150dd50be3f975921b44782161ed23e6593fd076a7ddf66cf
6
+ metadata.gz: a38be535ef41e0482f49368208cb725138909370b48a609ad864d6eba772917f216cdf055ab96eca5b4aff6df703255bcf54d594543b7ab2771f38e4149443a9
7
+ data.tar.gz: 78ebff2c8026e6c9be1da3a0fa75da2b4665789a6c7a386c5ec6694d406ef821e5aa74f302c549d3b2e34e177bd1bbbc98699e376d549f295746e1a39bac6290
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.53.0 (2025-12-12)
5
+ ------------------
6
+
7
+ * Feature - Adds support for portal branding customization, enabling administrators to personalize end-user portals with custom assets.
8
+
4
9
  1.52.0 (2025-11-21)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.52.0
1
+ 1.53.0
@@ -1627,6 +1627,12 @@ module Aws::WorkSpacesWeb
1627
1627
  # sessions. If administrators do not modify these settings, end users
1628
1628
  # retain control over their toolbar preferences.
1629
1629
  #
1630
+ # @option params [Types::BrandingConfigurationCreateInput] :branding_configuration_input
1631
+ # The branding configuration input that customizes the appearance of the
1632
+ # web portal for end users. This includes a custom logo, favicon,
1633
+ # wallpaper, localized strings, color theme, and an optional terms of
1634
+ # service.
1635
+ #
1630
1636
  # @return [Types::CreateUserSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1631
1637
  #
1632
1638
  # * {Types::CreateUserSettingsResponse#user_settings_arn #user_settings_arn} => String
@@ -1675,6 +1681,34 @@ module Aws::WorkSpacesWeb
1675
1681
  # hidden_toolbar_items: ["Windows"], # accepts Windows, DualMonitor, FullScreen, Webcam, Microphone
1676
1682
  # max_display_resolution: "size4096X2160", # accepts size4096X2160, size3840X2160, size3440X1440, size2560X1440, size1920X1080, size1280X720, size1024X768, size800X600
1677
1683
  # },
1684
+ # branding_configuration_input: {
1685
+ # logo: { # required
1686
+ # blob: "data",
1687
+ # s3_uri: "S3Uri",
1688
+ # },
1689
+ # wallpaper: { # required
1690
+ # blob: "data",
1691
+ # s3_uri: "S3Uri",
1692
+ # },
1693
+ # favicon: { # required
1694
+ # blob: "data",
1695
+ # s3_uri: "S3Uri",
1696
+ # },
1697
+ # localized_strings: { # required
1698
+ # "de-DE" => {
1699
+ # browser_tab_title: "LocalizedBrandingStringsBrowserTabTitleString", # required
1700
+ # welcome_text: "LocalizedBrandingStringsWelcomeTextString", # required
1701
+ # login_title: "LocalizedBrandingStringsLoginTitleString",
1702
+ # login_description: "LocalizedBrandingStringsLoginDescriptionString",
1703
+ # login_button_text: "LocalizedBrandingStringsLoginButtonTextString",
1704
+ # contact_link: "ContactLinkUrl",
1705
+ # contact_button_text: "LocalizedBrandingStringsContactButtonTextString",
1706
+ # loading_text: "LocalizedBrandingStringsLoadingTextString",
1707
+ # },
1708
+ # },
1709
+ # color_theme: "Light", # required, accepts Light, Dark
1710
+ # terms_of_service: "Markdown",
1711
+ # },
1678
1712
  # })
1679
1713
  #
1680
1714
  # @example Response structure
@@ -2714,6 +2748,26 @@ module Aws::WorkSpacesWeb
2714
2748
  # resp.user_settings.toolbar_configuration.hidden_toolbar_items #=> Array
2715
2749
  # resp.user_settings.toolbar_configuration.hidden_toolbar_items[0] #=> String, one of "Windows", "DualMonitor", "FullScreen", "Webcam", "Microphone"
2716
2750
  # resp.user_settings.toolbar_configuration.max_display_resolution #=> String, one of "size4096X2160", "size3840X2160", "size3440X1440", "size2560X1440", "size1920X1080", "size1280X720", "size1024X768", "size800X600"
2751
+ # resp.user_settings.branding_configuration.logo.mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
2752
+ # resp.user_settings.branding_configuration.logo.file_extension #=> String
2753
+ # resp.user_settings.branding_configuration.logo.last_upload_timestamp #=> Time
2754
+ # resp.user_settings.branding_configuration.wallpaper.mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
2755
+ # resp.user_settings.branding_configuration.wallpaper.file_extension #=> String
2756
+ # resp.user_settings.branding_configuration.wallpaper.last_upload_timestamp #=> Time
2757
+ # resp.user_settings.branding_configuration.favicon.mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
2758
+ # resp.user_settings.branding_configuration.favicon.file_extension #=> String
2759
+ # resp.user_settings.branding_configuration.favicon.last_upload_timestamp #=> Time
2760
+ # resp.user_settings.branding_configuration.localized_strings #=> Hash
2761
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].browser_tab_title #=> String
2762
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].welcome_text #=> String
2763
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].login_title #=> String
2764
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].login_description #=> String
2765
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].login_button_text #=> String
2766
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].contact_link #=> String
2767
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].contact_button_text #=> String
2768
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].loading_text #=> String
2769
+ # resp.user_settings.branding_configuration.color_theme #=> String, one of "Light", "Dark"
2770
+ # resp.user_settings.branding_configuration.terms_of_service #=> String
2717
2771
  #
2718
2772
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetUserSettings AWS API Documentation
2719
2773
  #
@@ -3366,6 +3420,26 @@ module Aws::WorkSpacesWeb
3366
3420
  # resp.user_settings[0].toolbar_configuration.hidden_toolbar_items #=> Array
3367
3421
  # resp.user_settings[0].toolbar_configuration.hidden_toolbar_items[0] #=> String, one of "Windows", "DualMonitor", "FullScreen", "Webcam", "Microphone"
3368
3422
  # resp.user_settings[0].toolbar_configuration.max_display_resolution #=> String, one of "size4096X2160", "size3840X2160", "size3440X1440", "size2560X1440", "size1920X1080", "size1280X720", "size1024X768", "size800X600"
3423
+ # resp.user_settings[0].branding_configuration.logo.mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
3424
+ # resp.user_settings[0].branding_configuration.logo.file_extension #=> String
3425
+ # resp.user_settings[0].branding_configuration.logo.last_upload_timestamp #=> Time
3426
+ # resp.user_settings[0].branding_configuration.wallpaper.mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
3427
+ # resp.user_settings[0].branding_configuration.wallpaper.file_extension #=> String
3428
+ # resp.user_settings[0].branding_configuration.wallpaper.last_upload_timestamp #=> Time
3429
+ # resp.user_settings[0].branding_configuration.favicon.mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
3430
+ # resp.user_settings[0].branding_configuration.favicon.file_extension #=> String
3431
+ # resp.user_settings[0].branding_configuration.favicon.last_upload_timestamp #=> Time
3432
+ # resp.user_settings[0].branding_configuration.localized_strings #=> Hash
3433
+ # resp.user_settings[0].branding_configuration.localized_strings["Locale"].browser_tab_title #=> String
3434
+ # resp.user_settings[0].branding_configuration.localized_strings["Locale"].welcome_text #=> String
3435
+ # resp.user_settings[0].branding_configuration.localized_strings["Locale"].login_title #=> String
3436
+ # resp.user_settings[0].branding_configuration.localized_strings["Locale"].login_description #=> String
3437
+ # resp.user_settings[0].branding_configuration.localized_strings["Locale"].login_button_text #=> String
3438
+ # resp.user_settings[0].branding_configuration.localized_strings["Locale"].contact_link #=> String
3439
+ # resp.user_settings[0].branding_configuration.localized_strings["Locale"].contact_button_text #=> String
3440
+ # resp.user_settings[0].branding_configuration.localized_strings["Locale"].loading_text #=> String
3441
+ # resp.user_settings[0].branding_configuration.color_theme #=> String, one of "Light", "Dark"
3442
+ # resp.user_settings[0].branding_configuration.terms_of_service #=> String
3369
3443
  # resp.next_token #=> String
3370
3444
  #
3371
3445
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListUserSettings AWS API Documentation
@@ -4271,6 +4345,14 @@ module Aws::WorkSpacesWeb
4271
4345
  # sessions. If administrators do not modify these settings, end users
4272
4346
  # retain control over their toolbar preferences.
4273
4347
  #
4348
+ # @option params [Types::BrandingConfigurationUpdateInput] :branding_configuration_input
4349
+ # The branding configuration that customizes the appearance of the web
4350
+ # portal for end users. When updating user settings without an existing
4351
+ # branding configuration, all fields (logo, favicon, wallpaper,
4352
+ # localized strings, and color theme) are required except for terms of
4353
+ # service. When updating user settings with an existing branding
4354
+ # configuration, all fields are optional.
4355
+ #
4274
4356
  # @return [Types::UpdateUserSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4275
4357
  #
4276
4358
  # * {Types::UpdateUserSettingsResponse#user_settings #user_settings} => Types::UserSettings
@@ -4310,6 +4392,34 @@ module Aws::WorkSpacesWeb
4310
4392
  # hidden_toolbar_items: ["Windows"], # accepts Windows, DualMonitor, FullScreen, Webcam, Microphone
4311
4393
  # max_display_resolution: "size4096X2160", # accepts size4096X2160, size3840X2160, size3440X1440, size2560X1440, size1920X1080, size1280X720, size1024X768, size800X600
4312
4394
  # },
4395
+ # branding_configuration_input: {
4396
+ # logo: {
4397
+ # blob: "data",
4398
+ # s3_uri: "S3Uri",
4399
+ # },
4400
+ # wallpaper: {
4401
+ # blob: "data",
4402
+ # s3_uri: "S3Uri",
4403
+ # },
4404
+ # favicon: {
4405
+ # blob: "data",
4406
+ # s3_uri: "S3Uri",
4407
+ # },
4408
+ # localized_strings: {
4409
+ # "de-DE" => {
4410
+ # browser_tab_title: "LocalizedBrandingStringsBrowserTabTitleString", # required
4411
+ # welcome_text: "LocalizedBrandingStringsWelcomeTextString", # required
4412
+ # login_title: "LocalizedBrandingStringsLoginTitleString",
4413
+ # login_description: "LocalizedBrandingStringsLoginDescriptionString",
4414
+ # login_button_text: "LocalizedBrandingStringsLoginButtonTextString",
4415
+ # contact_link: "ContactLinkUrl",
4416
+ # contact_button_text: "LocalizedBrandingStringsContactButtonTextString",
4417
+ # loading_text: "LocalizedBrandingStringsLoadingTextString",
4418
+ # },
4419
+ # },
4420
+ # color_theme: "Light", # accepts Light, Dark
4421
+ # terms_of_service: "Markdown",
4422
+ # },
4313
4423
  # })
4314
4424
  #
4315
4425
  # @example Response structure
@@ -4341,6 +4451,26 @@ module Aws::WorkSpacesWeb
4341
4451
  # resp.user_settings.toolbar_configuration.hidden_toolbar_items #=> Array
4342
4452
  # resp.user_settings.toolbar_configuration.hidden_toolbar_items[0] #=> String, one of "Windows", "DualMonitor", "FullScreen", "Webcam", "Microphone"
4343
4453
  # resp.user_settings.toolbar_configuration.max_display_resolution #=> String, one of "size4096X2160", "size3840X2160", "size3440X1440", "size2560X1440", "size1920X1080", "size1280X720", "size1024X768", "size800X600"
4454
+ # resp.user_settings.branding_configuration.logo.mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
4455
+ # resp.user_settings.branding_configuration.logo.file_extension #=> String
4456
+ # resp.user_settings.branding_configuration.logo.last_upload_timestamp #=> Time
4457
+ # resp.user_settings.branding_configuration.wallpaper.mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
4458
+ # resp.user_settings.branding_configuration.wallpaper.file_extension #=> String
4459
+ # resp.user_settings.branding_configuration.wallpaper.last_upload_timestamp #=> Time
4460
+ # resp.user_settings.branding_configuration.favicon.mime_type #=> String, one of "image/png", "image/jpeg", "image/x-icon"
4461
+ # resp.user_settings.branding_configuration.favicon.file_extension #=> String
4462
+ # resp.user_settings.branding_configuration.favicon.last_upload_timestamp #=> Time
4463
+ # resp.user_settings.branding_configuration.localized_strings #=> Hash
4464
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].browser_tab_title #=> String
4465
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].welcome_text #=> String
4466
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].login_title #=> String
4467
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].login_description #=> String
4468
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].login_button_text #=> String
4469
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].contact_link #=> String
4470
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].contact_button_text #=> String
4471
+ # resp.user_settings.branding_configuration.localized_strings["Locale"].loading_text #=> String
4472
+ # resp.user_settings.branding_configuration.color_theme #=> String, one of "Light", "Dark"
4473
+ # resp.user_settings.branding_configuration.terms_of_service #=> String
4344
4474
  #
4345
4475
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateUserSettings AWS API Documentation
4346
4476
  #
@@ -4369,7 +4499,7 @@ module Aws::WorkSpacesWeb
4369
4499
  tracer: tracer
4370
4500
  )
4371
4501
  context[:gem_name] = 'aws-sdk-workspacesweb'
4372
- context[:gem_version] = '1.52.0'
4502
+ context[:gem_version] = '1.53.0'
4373
4503
  Seahorse::Client::Request.new(handlers, context)
4374
4504
  end
4375
4505
 
@@ -35,6 +35,9 @@ module Aws::WorkSpacesWeb
35
35
  AssociateUserSettingsResponse = Shapes::StructureShape.new(name: 'AssociateUserSettingsResponse')
36
36
  AuthenticationType = Shapes::StringShape.new(name: 'AuthenticationType')
37
37
  BlockedCategories = Shapes::ListShape.new(name: 'BlockedCategories')
38
+ BrandingConfiguration = Shapes::StructureShape.new(name: 'BrandingConfiguration')
39
+ BrandingConfigurationCreateInput = Shapes::StructureShape.new(name: 'BrandingConfigurationCreateInput')
40
+ BrandingConfigurationUpdateInput = Shapes::StructureShape.new(name: 'BrandingConfigurationUpdateInput')
38
41
  BrowserPolicy = Shapes::StringShape.new(name: 'BrowserPolicy')
39
42
  BrowserSettings = Shapes::StructureShape.new(name: 'BrowserSettings')
40
43
  BrowserSettingsList = Shapes::ListShape.new(name: 'BrowserSettingsList')
@@ -51,8 +54,10 @@ module Aws::WorkSpacesWeb
51
54
  CertificateThumbprint = Shapes::StringShape.new(name: 'CertificateThumbprint')
52
55
  CertificateThumbprintList = Shapes::ListShape.new(name: 'CertificateThumbprintList')
53
56
  ClientToken = Shapes::StringShape.new(name: 'ClientToken')
57
+ ColorTheme = Shapes::StringShape.new(name: 'ColorTheme')
54
58
  ConfidenceLevel = Shapes::IntegerShape.new(name: 'ConfidenceLevel')
55
59
  ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
60
+ ContactLinkUrl = Shapes::StringShape.new(name: 'ContactLinkUrl')
56
61
  CookieDomain = Shapes::StringShape.new(name: 'CookieDomain')
57
62
  CookieName = Shapes::StringShape.new(name: 'CookieName')
58
63
  CookiePath = Shapes::StringShape.new(name: 'CookiePath')
@@ -162,6 +167,8 @@ module Aws::WorkSpacesWeb
162
167
  GetUserSettingsResponse = Shapes::StructureShape.new(name: 'GetUserSettingsResponse')
163
168
  GlobalInlineRedactionUrls = Shapes::ListShape.new(name: 'GlobalInlineRedactionUrls')
164
169
  HiddenToolbarItemList = Shapes::ListShape.new(name: 'HiddenToolbarItemList')
170
+ IconImage = Shapes::BlobShape.new(name: 'IconImage')
171
+ IconImageInput = Shapes::UnionShape.new(name: 'IconImageInput')
165
172
  IdentityProvider = Shapes::StructureShape.new(name: 'IdentityProvider')
166
173
  IdentityProviderDetails = Shapes::MapShape.new(name: 'IdentityProviderDetails')
167
174
  IdentityProviderList = Shapes::ListShape.new(name: 'IdentityProviderList')
@@ -169,6 +176,7 @@ module Aws::WorkSpacesWeb
169
176
  IdentityProviderSummary = Shapes::StructureShape.new(name: 'IdentityProviderSummary')
170
177
  IdentityProviderType = Shapes::StringShape.new(name: 'IdentityProviderType')
171
178
  IdleDisconnectTimeoutInMinutes = Shapes::IntegerShape.new(name: 'IdleDisconnectTimeoutInMinutes')
179
+ ImageMetadata = Shapes::StructureShape.new(name: 'ImageMetadata')
172
180
  InlineRedactionConfiguration = Shapes::StructureShape.new(name: 'InlineRedactionConfiguration')
173
181
  InlineRedactionPattern = Shapes::StructureShape.new(name: 'InlineRedactionPattern')
174
182
  InlineRedactionPatterns = Shapes::ListShape.new(name: 'InlineRedactionPatterns')
@@ -211,11 +219,23 @@ module Aws::WorkSpacesWeb
211
219
  ListUserAccessLoggingSettingsResponse = Shapes::StructureShape.new(name: 'ListUserAccessLoggingSettingsResponse')
212
220
  ListUserSettingsRequest = Shapes::StructureShape.new(name: 'ListUserSettingsRequest')
213
221
  ListUserSettingsResponse = Shapes::StructureShape.new(name: 'ListUserSettingsResponse')
222
+ Locale = Shapes::StringShape.new(name: 'Locale')
223
+ LocalizedBrandingStringMap = Shapes::MapShape.new(name: 'LocalizedBrandingStringMap')
224
+ LocalizedBrandingStrings = Shapes::StructureShape.new(name: 'LocalizedBrandingStrings')
225
+ LocalizedBrandingStringsBrowserTabTitleString = Shapes::StringShape.new(name: 'LocalizedBrandingStringsBrowserTabTitleString')
226
+ LocalizedBrandingStringsContactButtonTextString = Shapes::StringShape.new(name: 'LocalizedBrandingStringsContactButtonTextString')
227
+ LocalizedBrandingStringsLoadingTextString = Shapes::StringShape.new(name: 'LocalizedBrandingStringsLoadingTextString')
228
+ LocalizedBrandingStringsLoginButtonTextString = Shapes::StringShape.new(name: 'LocalizedBrandingStringsLoginButtonTextString')
229
+ LocalizedBrandingStringsLoginDescriptionString = Shapes::StringShape.new(name: 'LocalizedBrandingStringsLoginDescriptionString')
230
+ LocalizedBrandingStringsLoginTitleString = Shapes::StringShape.new(name: 'LocalizedBrandingStringsLoginTitleString')
231
+ LocalizedBrandingStringsWelcomeTextString = Shapes::StringShape.new(name: 'LocalizedBrandingStringsWelcomeTextString')
214
232
  LogConfiguration = Shapes::StructureShape.new(name: 'LogConfiguration')
215
233
  LogFileFormat = Shapes::StringShape.new(name: 'LogFileFormat')
234
+ Markdown = Shapes::StringShape.new(name: 'Markdown')
216
235
  MaxConcurrentSessions = Shapes::IntegerShape.new(name: 'MaxConcurrentSessions')
217
236
  MaxDisplayResolution = Shapes::StringShape.new(name: 'MaxDisplayResolution')
218
237
  MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
238
+ MimeType = Shapes::StringShape.new(name: 'MimeType')
219
239
  NetworkSettings = Shapes::StructureShape.new(name: 'NetworkSettings')
220
240
  NetworkSettingsList = Shapes::ListShape.new(name: 'NetworkSettingsList')
221
241
  NetworkSettingsSummary = Shapes::StructureShape.new(name: 'NetworkSettingsSummary')
@@ -241,6 +261,7 @@ module Aws::WorkSpacesWeb
241
261
  S3BucketOwner = Shapes::StringShape.new(name: 'S3BucketOwner')
242
262
  S3KeyPrefix = Shapes::StringShape.new(name: 'S3KeyPrefix')
243
263
  S3LogConfiguration = Shapes::StructureShape.new(name: 'S3LogConfiguration')
264
+ S3Uri = Shapes::StringShape.new(name: 'S3Uri')
244
265
  SamlMetadata = Shapes::StringShape.new(name: 'SamlMetadata')
245
266
  SecurityGroupId = Shapes::StringShape.new(name: 'SecurityGroupId')
246
267
  SecurityGroupIdList = Shapes::ListShape.new(name: 'SecurityGroupIdList')
@@ -315,6 +336,8 @@ module Aws::WorkSpacesWeb
315
336
  ValidationExceptionReason = Shapes::StringShape.new(name: 'ValidationExceptionReason')
316
337
  VisualMode = Shapes::StringShape.new(name: 'VisualMode')
317
338
  VpcId = Shapes::StringShape.new(name: 'VpcId')
339
+ WallpaperImage = Shapes::BlobShape.new(name: 'WallpaperImage')
340
+ WallpaperImageInput = Shapes::UnionShape.new(name: 'WallpaperImageInput')
318
341
  WebContentFilteringPolicy = Shapes::StructureShape.new(name: 'WebContentFilteringPolicy')
319
342
  keyArn = Shapes::StringShape.new(name: 'keyArn')
320
343
 
@@ -389,6 +412,30 @@ module Aws::WorkSpacesWeb
389
412
 
390
413
  BlockedCategories.member = Shapes::ShapeRef.new(shape: Category)
391
414
 
415
+ BrandingConfiguration.add_member(:logo, Shapes::ShapeRef.new(shape: ImageMetadata, required: true, location_name: "logo"))
416
+ BrandingConfiguration.add_member(:wallpaper, Shapes::ShapeRef.new(shape: ImageMetadata, required: true, location_name: "wallpaper"))
417
+ BrandingConfiguration.add_member(:favicon, Shapes::ShapeRef.new(shape: ImageMetadata, required: true, location_name: "favicon"))
418
+ BrandingConfiguration.add_member(:localized_strings, Shapes::ShapeRef.new(shape: LocalizedBrandingStringMap, required: true, location_name: "localizedStrings"))
419
+ BrandingConfiguration.add_member(:color_theme, Shapes::ShapeRef.new(shape: ColorTheme, required: true, location_name: "colorTheme"))
420
+ BrandingConfiguration.add_member(:terms_of_service, Shapes::ShapeRef.new(shape: Markdown, location_name: "termsOfService"))
421
+ BrandingConfiguration.struct_class = Types::BrandingConfiguration
422
+
423
+ BrandingConfigurationCreateInput.add_member(:logo, Shapes::ShapeRef.new(shape: IconImageInput, required: true, location_name: "logo"))
424
+ BrandingConfigurationCreateInput.add_member(:wallpaper, Shapes::ShapeRef.new(shape: WallpaperImageInput, required: true, location_name: "wallpaper"))
425
+ BrandingConfigurationCreateInput.add_member(:favicon, Shapes::ShapeRef.new(shape: IconImageInput, required: true, location_name: "favicon"))
426
+ BrandingConfigurationCreateInput.add_member(:localized_strings, Shapes::ShapeRef.new(shape: LocalizedBrandingStringMap, required: true, location_name: "localizedStrings"))
427
+ BrandingConfigurationCreateInput.add_member(:color_theme, Shapes::ShapeRef.new(shape: ColorTheme, required: true, location_name: "colorTheme"))
428
+ BrandingConfigurationCreateInput.add_member(:terms_of_service, Shapes::ShapeRef.new(shape: Markdown, location_name: "termsOfService"))
429
+ BrandingConfigurationCreateInput.struct_class = Types::BrandingConfigurationCreateInput
430
+
431
+ BrandingConfigurationUpdateInput.add_member(:logo, Shapes::ShapeRef.new(shape: IconImageInput, location_name: "logo"))
432
+ BrandingConfigurationUpdateInput.add_member(:wallpaper, Shapes::ShapeRef.new(shape: WallpaperImageInput, location_name: "wallpaper"))
433
+ BrandingConfigurationUpdateInput.add_member(:favicon, Shapes::ShapeRef.new(shape: IconImageInput, location_name: "favicon"))
434
+ BrandingConfigurationUpdateInput.add_member(:localized_strings, Shapes::ShapeRef.new(shape: LocalizedBrandingStringMap, location_name: "localizedStrings"))
435
+ BrandingConfigurationUpdateInput.add_member(:color_theme, Shapes::ShapeRef.new(shape: ColorTheme, location_name: "colorTheme"))
436
+ BrandingConfigurationUpdateInput.add_member(:terms_of_service, Shapes::ShapeRef.new(shape: Markdown, location_name: "termsOfService"))
437
+ BrandingConfigurationUpdateInput.struct_class = Types::BrandingConfigurationUpdateInput
438
+
392
439
  BrowserSettings.add_member(:browser_settings_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "browserSettingsArn"))
393
440
  BrowserSettings.add_member(:associated_portal_arns, Shapes::ShapeRef.new(shape: ArnList, location_name: "associatedPortalArns"))
394
441
  BrowserSettings.add_member(:browser_policy, Shapes::ShapeRef.new(shape: BrowserPolicy, location_name: "browserPolicy"))
@@ -551,6 +598,7 @@ module Aws::WorkSpacesWeb
551
598
  CreateUserSettingsRequest.add_member(:additional_encryption_context, Shapes::ShapeRef.new(shape: EncryptionContextMap, location_name: "additionalEncryptionContext"))
552
599
  CreateUserSettingsRequest.add_member(:deep_link_allowed, Shapes::ShapeRef.new(shape: EnabledType, location_name: "deepLinkAllowed"))
553
600
  CreateUserSettingsRequest.add_member(:toolbar_configuration, Shapes::ShapeRef.new(shape: ToolbarConfiguration, location_name: "toolbarConfiguration"))
601
+ CreateUserSettingsRequest.add_member(:branding_configuration_input, Shapes::ShapeRef.new(shape: BrandingConfigurationCreateInput, location_name: "brandingConfigurationInput"))
554
602
  CreateUserSettingsRequest.struct_class = Types::CreateUserSettingsRequest
555
603
 
556
604
  CreateUserSettingsResponse.add_member(:user_settings_arn, Shapes::ShapeRef.new(shape: ARN, required: true, location_name: "userSettingsArn"))
@@ -775,6 +823,14 @@ module Aws::WorkSpacesWeb
775
823
 
776
824
  HiddenToolbarItemList.member = Shapes::ShapeRef.new(shape: ToolbarItem)
777
825
 
826
+ IconImageInput.add_member(:blob, Shapes::ShapeRef.new(shape: IconImage, location_name: "blob"))
827
+ IconImageInput.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "s3Uri"))
828
+ IconImageInput.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
829
+ IconImageInput.add_member_subclass(:blob, Types::IconImageInput::Blob)
830
+ IconImageInput.add_member_subclass(:s3_uri, Types::IconImageInput::S3Uri)
831
+ IconImageInput.add_member_subclass(:unknown, Types::IconImageInput::Unknown)
832
+ IconImageInput.struct_class = Types::IconImageInput
833
+
778
834
  IdentityProvider.add_member(:identity_provider_arn, Shapes::ShapeRef.new(shape: SubresourceARN, required: true, location_name: "identityProviderArn"))
779
835
  IdentityProvider.add_member(:identity_provider_name, Shapes::ShapeRef.new(shape: IdentityProviderName, location_name: "identityProviderName"))
780
836
  IdentityProvider.add_member(:identity_provider_type, Shapes::ShapeRef.new(shape: IdentityProviderType, location_name: "identityProviderType"))
@@ -791,6 +847,11 @@ module Aws::WorkSpacesWeb
791
847
  IdentityProviderSummary.add_member(:identity_provider_type, Shapes::ShapeRef.new(shape: IdentityProviderType, location_name: "identityProviderType"))
792
848
  IdentityProviderSummary.struct_class = Types::IdentityProviderSummary
793
849
 
850
+ ImageMetadata.add_member(:mime_type, Shapes::ShapeRef.new(shape: MimeType, required: true, location_name: "mimeType"))
851
+ ImageMetadata.add_member(:file_extension, Shapes::ShapeRef.new(shape: StringType, required: true, location_name: "fileExtension"))
852
+ ImageMetadata.add_member(:last_upload_timestamp, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "lastUploadTimestamp"))
853
+ ImageMetadata.struct_class = Types::ImageMetadata
854
+
794
855
  InlineRedactionConfiguration.add_member(:inline_redaction_patterns, Shapes::ShapeRef.new(shape: InlineRedactionPatterns, required: true, location_name: "inlineRedactionPatterns"))
795
856
  InlineRedactionConfiguration.add_member(:global_enforced_urls, Shapes::ShapeRef.new(shape: GlobalInlineRedactionUrls, location_name: "globalEnforcedUrls"))
796
857
  InlineRedactionConfiguration.add_member(:global_exempt_urls, Shapes::ShapeRef.new(shape: GlobalInlineRedactionUrls, location_name: "globalExemptUrls"))
@@ -949,6 +1010,19 @@ module Aws::WorkSpacesWeb
949
1010
  ListUserSettingsResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: PaginationToken, location_name: "nextToken"))
950
1011
  ListUserSettingsResponse.struct_class = Types::ListUserSettingsResponse
951
1012
 
1013
+ LocalizedBrandingStringMap.key = Shapes::ShapeRef.new(shape: Locale)
1014
+ LocalizedBrandingStringMap.value = Shapes::ShapeRef.new(shape: LocalizedBrandingStrings)
1015
+
1016
+ LocalizedBrandingStrings.add_member(:browser_tab_title, Shapes::ShapeRef.new(shape: LocalizedBrandingStringsBrowserTabTitleString, required: true, location_name: "browserTabTitle"))
1017
+ LocalizedBrandingStrings.add_member(:welcome_text, Shapes::ShapeRef.new(shape: LocalizedBrandingStringsWelcomeTextString, required: true, location_name: "welcomeText"))
1018
+ LocalizedBrandingStrings.add_member(:login_title, Shapes::ShapeRef.new(shape: LocalizedBrandingStringsLoginTitleString, location_name: "loginTitle"))
1019
+ LocalizedBrandingStrings.add_member(:login_description, Shapes::ShapeRef.new(shape: LocalizedBrandingStringsLoginDescriptionString, location_name: "loginDescription"))
1020
+ LocalizedBrandingStrings.add_member(:login_button_text, Shapes::ShapeRef.new(shape: LocalizedBrandingStringsLoginButtonTextString, location_name: "loginButtonText"))
1021
+ LocalizedBrandingStrings.add_member(:contact_link, Shapes::ShapeRef.new(shape: ContactLinkUrl, location_name: "contactLink"))
1022
+ LocalizedBrandingStrings.add_member(:contact_button_text, Shapes::ShapeRef.new(shape: LocalizedBrandingStringsContactButtonTextString, location_name: "contactButtonText"))
1023
+ LocalizedBrandingStrings.add_member(:loading_text, Shapes::ShapeRef.new(shape: LocalizedBrandingStringsLoadingTextString, location_name: "loadingText"))
1024
+ LocalizedBrandingStrings.struct_class = Types::LocalizedBrandingStrings
1025
+
952
1026
  LogConfiguration.add_member(:s3, Shapes::ShapeRef.new(shape: S3LogConfiguration, location_name: "s3"))
953
1027
  LogConfiguration.struct_class = Types::LogConfiguration
954
1028
 
@@ -1219,6 +1293,7 @@ module Aws::WorkSpacesWeb
1219
1293
  UpdateUserSettingsRequest.add_member(:cookie_synchronization_configuration, Shapes::ShapeRef.new(shape: CookieSynchronizationConfiguration, location_name: "cookieSynchronizationConfiguration"))
1220
1294
  UpdateUserSettingsRequest.add_member(:deep_link_allowed, Shapes::ShapeRef.new(shape: EnabledType, location_name: "deepLinkAllowed"))
1221
1295
  UpdateUserSettingsRequest.add_member(:toolbar_configuration, Shapes::ShapeRef.new(shape: ToolbarConfiguration, location_name: "toolbarConfiguration"))
1296
+ UpdateUserSettingsRequest.add_member(:branding_configuration_input, Shapes::ShapeRef.new(shape: BrandingConfigurationUpdateInput, location_name: "brandingConfigurationInput"))
1222
1297
  UpdateUserSettingsRequest.struct_class = Types::UpdateUserSettingsRequest
1223
1298
 
1224
1299
  UpdateUserSettingsResponse.add_member(:user_settings, Shapes::ShapeRef.new(shape: UserSettings, required: true, location_name: "userSettings"))
@@ -1251,6 +1326,7 @@ module Aws::WorkSpacesWeb
1251
1326
  UserSettings.add_member(:additional_encryption_context, Shapes::ShapeRef.new(shape: EncryptionContextMap, location_name: "additionalEncryptionContext"))
1252
1327
  UserSettings.add_member(:deep_link_allowed, Shapes::ShapeRef.new(shape: EnabledType, location_name: "deepLinkAllowed"))
1253
1328
  UserSettings.add_member(:toolbar_configuration, Shapes::ShapeRef.new(shape: ToolbarConfiguration, location_name: "toolbarConfiguration"))
1329
+ UserSettings.add_member(:branding_configuration, Shapes::ShapeRef.new(shape: BrandingConfiguration, location_name: "brandingConfiguration"))
1254
1330
  UserSettings.struct_class = Types::UserSettings
1255
1331
 
1256
1332
  UserSettingsList.member = Shapes::ShapeRef.new(shape: UserSettingsSummary)
@@ -1266,6 +1342,7 @@ module Aws::WorkSpacesWeb
1266
1342
  UserSettingsSummary.add_member(:cookie_synchronization_configuration, Shapes::ShapeRef.new(shape: CookieSynchronizationConfiguration, location_name: "cookieSynchronizationConfiguration"))
1267
1343
  UserSettingsSummary.add_member(:deep_link_allowed, Shapes::ShapeRef.new(shape: EnabledType, location_name: "deepLinkAllowed"))
1268
1344
  UserSettingsSummary.add_member(:toolbar_configuration, Shapes::ShapeRef.new(shape: ToolbarConfiguration, location_name: "toolbarConfiguration"))
1345
+ UserSettingsSummary.add_member(:branding_configuration, Shapes::ShapeRef.new(shape: BrandingConfiguration, location_name: "brandingConfiguration"))
1269
1346
  UserSettingsSummary.struct_class = Types::UserSettingsSummary
1270
1347
 
1271
1348
  ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: ExceptionMessage, location_name: "message"))
@@ -1279,6 +1356,14 @@ module Aws::WorkSpacesWeb
1279
1356
 
1280
1357
  ValidationExceptionFieldList.member = Shapes::ShapeRef.new(shape: ValidationExceptionField)
1281
1358
 
1359
+ WallpaperImageInput.add_member(:blob, Shapes::ShapeRef.new(shape: WallpaperImage, location_name: "blob"))
1360
+ WallpaperImageInput.add_member(:s3_uri, Shapes::ShapeRef.new(shape: S3Uri, location_name: "s3Uri"))
1361
+ WallpaperImageInput.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
1362
+ WallpaperImageInput.add_member_subclass(:blob, Types::WallpaperImageInput::Blob)
1363
+ WallpaperImageInput.add_member_subclass(:s3_uri, Types::WallpaperImageInput::S3Uri)
1364
+ WallpaperImageInput.add_member_subclass(:unknown, Types::WallpaperImageInput::Unknown)
1365
+ WallpaperImageInput.struct_class = Types::WallpaperImageInput
1366
+
1282
1367
  WebContentFilteringPolicy.add_member(:blocked_categories, Shapes::ShapeRef.new(shape: BlockedCategories, location_name: "blockedCategories"))
1283
1368
  WebContentFilteringPolicy.add_member(:allowed_urls, Shapes::ShapeRef.new(shape: UrlPatternList, location_name: "allowedUrls"))
1284
1369
  WebContentFilteringPolicy.add_member(:blocked_urls, Shapes::ShapeRef.new(shape: UrlPatternList, location_name: "blockedUrls"))
@@ -1552,6 +1637,7 @@ module Aws::WorkSpacesWeb
1552
1637
  o.input = Shapes::ShapeRef.new(shape: CreateUserSettingsRequest)
1553
1638
  o.output = Shapes::ShapeRef.new(shape: CreateUserSettingsResponse)
1554
1639
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1640
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1555
1641
  o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
1556
1642
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
1557
1643
  o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
@@ -295,6 +295,150 @@ module Aws::WorkSpacesWeb
295
295
  include Aws::Structure
296
296
  end
297
297
 
298
+ # The branding configuration output including custom images metadata,
299
+ # localized strings, color theme, and terms of service.
300
+ #
301
+ # @!attribute [rw] logo
302
+ # Metadata for the logo image file, including the MIME type, file
303
+ # extension, and upload timestamp.
304
+ # @return [Types::ImageMetadata]
305
+ #
306
+ # @!attribute [rw] wallpaper
307
+ # Metadata for the wallpaper image file, including the MIME type, file
308
+ # extension, and upload timestamp.
309
+ # @return [Types::ImageMetadata]
310
+ #
311
+ # @!attribute [rw] favicon
312
+ # Metadata for the favicon image file, including the MIME type, file
313
+ # extension, and upload timestamp.
314
+ # @return [Types::ImageMetadata]
315
+ #
316
+ # @!attribute [rw] localized_strings
317
+ # A map of localized text strings for different languages, allowing
318
+ # the portal to display content in the user's preferred language.
319
+ # @return [Hash<String,Types::LocalizedBrandingStrings>]
320
+ #
321
+ # @!attribute [rw] color_theme
322
+ # The color theme for components on the web portal.
323
+ # @return [String]
324
+ #
325
+ # @!attribute [rw] terms_of_service
326
+ # The terms of service text in Markdown format that users must accept
327
+ # before accessing the portal.
328
+ # @return [String]
329
+ #
330
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/BrandingConfiguration AWS API Documentation
331
+ #
332
+ class BrandingConfiguration < Struct.new(
333
+ :logo,
334
+ :wallpaper,
335
+ :favicon,
336
+ :localized_strings,
337
+ :color_theme,
338
+ :terms_of_service)
339
+ SENSITIVE = [:terms_of_service]
340
+ include Aws::Structure
341
+ end
342
+
343
+ # The input configuration for creating branding settings.
344
+ #
345
+ # @!attribute [rw] logo
346
+ # The logo image for the portal. Provide either a binary image file or
347
+ # an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG,
348
+ # or ICO format.
349
+ # @return [Types::IconImageInput]
350
+ #
351
+ # @!attribute [rw] wallpaper
352
+ # The wallpaper image for the portal. Provide either a binary image
353
+ # file or an S3 URI pointing to the image file. Maximum 5 MB in JPEG
354
+ # or PNG format.
355
+ # @return [Types::WallpaperImageInput]
356
+ #
357
+ # @!attribute [rw] favicon
358
+ # The favicon image for the portal. Provide either a binary image file
359
+ # or an S3 URI pointing to the image file. Maximum 100 KB in JPEG,
360
+ # PNG, or ICO format.
361
+ # @return [Types::IconImageInput]
362
+ #
363
+ # @!attribute [rw] localized_strings
364
+ # A map of localized text strings for different supported languages.
365
+ # Each locale must provide the required fields `browserTabTitle` and
366
+ # `welcomeText`.
367
+ # @return [Hash<String,Types::LocalizedBrandingStrings>]
368
+ #
369
+ # @!attribute [rw] color_theme
370
+ # The color theme for components on the web portal. Choose `Light` if
371
+ # you upload a dark wallpaper, or `Dark` for a light wallpaper.
372
+ # @return [String]
373
+ #
374
+ # @!attribute [rw] terms_of_service
375
+ # The terms of service text in Markdown format. Users will be
376
+ # presented with the terms of service after successfully signing in.
377
+ # @return [String]
378
+ #
379
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/BrandingConfigurationCreateInput AWS API Documentation
380
+ #
381
+ class BrandingConfigurationCreateInput < Struct.new(
382
+ :logo,
383
+ :wallpaper,
384
+ :favicon,
385
+ :localized_strings,
386
+ :color_theme,
387
+ :terms_of_service)
388
+ SENSITIVE = [:terms_of_service]
389
+ include Aws::Structure
390
+ end
391
+
392
+ # The input configuration for updating branding settings. All fields are
393
+ # optional when updating existing branding.
394
+ #
395
+ # @!attribute [rw] logo
396
+ # The logo image for the portal. Provide either a binary image file or
397
+ # an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG,
398
+ # or ICO format.
399
+ # @return [Types::IconImageInput]
400
+ #
401
+ # @!attribute [rw] wallpaper
402
+ # The wallpaper image for the portal. Provide either a binary image
403
+ # file or an S3 URI pointing to the image file. Maximum 5 MB in JPEG
404
+ # or PNG format.
405
+ # @return [Types::WallpaperImageInput]
406
+ #
407
+ # @!attribute [rw] favicon
408
+ # The favicon image for the portal. Provide either a binary image file
409
+ # or an S3 URI pointing to the image file. Maximum 100 KB in JPEG,
410
+ # PNG, or ICO format.
411
+ # @return [Types::IconImageInput]
412
+ #
413
+ # @!attribute [rw] localized_strings
414
+ # A map of localized text strings for different supported languages.
415
+ # Each locale must provide the required fields `browserTabTitle` and
416
+ # `welcomeText`.
417
+ # @return [Hash<String,Types::LocalizedBrandingStrings>]
418
+ #
419
+ # @!attribute [rw] color_theme
420
+ # The color theme for components on the web portal. Choose `Light` if
421
+ # you upload a dark wallpaper, or `Dark` for a light wallpaper.
422
+ # @return [String]
423
+ #
424
+ # @!attribute [rw] terms_of_service
425
+ # The terms of service text in Markdown format. To remove existing
426
+ # terms of service, provide an empty string.
427
+ # @return [String]
428
+ #
429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/BrandingConfigurationUpdateInput AWS API Documentation
430
+ #
431
+ class BrandingConfigurationUpdateInput < Struct.new(
432
+ :logo,
433
+ :wallpaper,
434
+ :favicon,
435
+ :localized_strings,
436
+ :color_theme,
437
+ :terms_of_service)
438
+ SENSITIVE = [:terms_of_service]
439
+ include Aws::Structure
440
+ end
441
+
298
442
  # The browser settings resource that can be associated with a web
299
443
  # portal. Once associated with a web portal, browser settings control
300
444
  # how the browser will behave once a user starts a streaming session for
@@ -1205,6 +1349,13 @@ module Aws::WorkSpacesWeb
1205
1349
  # settings, end users retain control over their toolbar preferences.
1206
1350
  # @return [Types::ToolbarConfiguration]
1207
1351
  #
1352
+ # @!attribute [rw] branding_configuration_input
1353
+ # The branding configuration input that customizes the appearance of
1354
+ # the web portal for end users. This includes a custom logo, favicon,
1355
+ # wallpaper, localized strings, color theme, and an optional terms of
1356
+ # service.
1357
+ # @return [Types::BrandingConfigurationCreateInput]
1358
+ #
1208
1359
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateUserSettingsRequest AWS API Documentation
1209
1360
  #
1210
1361
  class CreateUserSettingsRequest < Struct.new(
@@ -1221,7 +1372,8 @@ module Aws::WorkSpacesWeb
1221
1372
  :customer_managed_key,
1222
1373
  :additional_encryption_context,
1223
1374
  :deep_link_allowed,
1224
- :toolbar_configuration)
1375
+ :toolbar_configuration,
1376
+ :branding_configuration_input)
1225
1377
  SENSITIVE = [:tags, :cookie_synchronization_configuration]
1226
1378
  include Aws::Structure
1227
1379
  end
@@ -2030,6 +2182,37 @@ module Aws::WorkSpacesWeb
2030
2182
  include Aws::Structure
2031
2183
  end
2032
2184
 
2185
+ # The input for an icon image (logo or favicon). Provide either a binary
2186
+ # image file or an S3 URI pointing to the image file. Maximum 100 KB in
2187
+ # JPEG, PNG, or ICO format.
2188
+ #
2189
+ # @note IconImageInput is a union - when making an API calls you must set exactly one of the members.
2190
+ #
2191
+ # @!attribute [rw] blob
2192
+ # The image provided as a binary image file.
2193
+ # @return [String]
2194
+ #
2195
+ # @!attribute [rw] s3_uri
2196
+ # The S3 URI pointing to the image file. The URI must use the format
2197
+ # `s3://bucket-name/key-name`. You must have read access to the S3
2198
+ # object.
2199
+ # @return [String]
2200
+ #
2201
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/IconImageInput AWS API Documentation
2202
+ #
2203
+ class IconImageInput < Struct.new(
2204
+ :blob,
2205
+ :s3_uri,
2206
+ :unknown)
2207
+ SENSITIVE = []
2208
+ include Aws::Structure
2209
+ include Aws::Structure::Union
2210
+
2211
+ class Blob < IconImageInput; end
2212
+ class S3Uri < IconImageInput; end
2213
+ class Unknown < IconImageInput; end
2214
+ end
2215
+
2033
2216
  # The identity provider.
2034
2217
  #
2035
2218
  # @!attribute [rw] identity_provider_arn
@@ -2147,6 +2330,30 @@ module Aws::WorkSpacesWeb
2147
2330
  include Aws::Structure
2148
2331
  end
2149
2332
 
2333
+ # Metadata information about an uploaded image file.
2334
+ #
2335
+ # @!attribute [rw] mime_type
2336
+ # The MIME type of the image.
2337
+ # @return [String]
2338
+ #
2339
+ # @!attribute [rw] file_extension
2340
+ # The file extension of the image.
2341
+ # @return [String]
2342
+ #
2343
+ # @!attribute [rw] last_upload_timestamp
2344
+ # The timestamp when the image was last uploaded.
2345
+ # @return [Time]
2346
+ #
2347
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ImageMetadata AWS API Documentation
2348
+ #
2349
+ class ImageMetadata < Struct.new(
2350
+ :mime_type,
2351
+ :file_extension,
2352
+ :last_upload_timestamp)
2353
+ SENSITIVE = []
2354
+ include Aws::Structure
2355
+ end
2356
+
2150
2357
  # The configuration for in-session inline redaction.
2151
2358
  #
2152
2359
  # @!attribute [rw] inline_redaction_patterns
@@ -2857,6 +3064,63 @@ module Aws::WorkSpacesWeb
2857
3064
  include Aws::Structure
2858
3065
  end
2859
3066
 
3067
+ # Localized text strings for a specific language that customize the web
3068
+ # portal.
3069
+ #
3070
+ # @!attribute [rw] browser_tab_title
3071
+ # The text displayed in the browser tab title.
3072
+ # @return [String]
3073
+ #
3074
+ # @!attribute [rw] welcome_text
3075
+ # The welcome text displayed on the sign-in page.
3076
+ # @return [String]
3077
+ #
3078
+ # @!attribute [rw] login_title
3079
+ # The title text for the login section. This field is optional and
3080
+ # defaults to "Sign In".
3081
+ # @return [String]
3082
+ #
3083
+ # @!attribute [rw] login_description
3084
+ # The description text for the login section. This field is optional
3085
+ # and defaults to "Sign in to your session".
3086
+ # @return [String]
3087
+ #
3088
+ # @!attribute [rw] login_button_text
3089
+ # The text displayed on the login button. This field is optional and
3090
+ # defaults to "Sign In".
3091
+ # @return [String]
3092
+ #
3093
+ # @!attribute [rw] contact_link
3094
+ # A contact link URL. The URL must start with `https://` or `mailto:`.
3095
+ # If not provided, the contact button will be hidden from the web
3096
+ # portal screen.
3097
+ # @return [String]
3098
+ #
3099
+ # @!attribute [rw] contact_button_text
3100
+ # The text displayed on the contact button. This field is optional and
3101
+ # defaults to "Contact us".
3102
+ # @return [String]
3103
+ #
3104
+ # @!attribute [rw] loading_text
3105
+ # The text displayed during session loading. This field is optional
3106
+ # and defaults to "Loading your session".
3107
+ # @return [String]
3108
+ #
3109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/LocalizedBrandingStrings AWS API Documentation
3110
+ #
3111
+ class LocalizedBrandingStrings < Struct.new(
3112
+ :browser_tab_title,
3113
+ :welcome_text,
3114
+ :login_title,
3115
+ :login_description,
3116
+ :login_button_text,
3117
+ :contact_link,
3118
+ :contact_button_text,
3119
+ :loading_text)
3120
+ SENSITIVE = []
3121
+ include Aws::Structure
3122
+ end
3123
+
2860
3124
  # The configuration of the log.
2861
3125
  #
2862
3126
  # @!attribute [rw] s3
@@ -4252,6 +4516,15 @@ module Aws::WorkSpacesWeb
4252
4516
  # settings, end users retain control over their toolbar preferences.
4253
4517
  # @return [Types::ToolbarConfiguration]
4254
4518
  #
4519
+ # @!attribute [rw] branding_configuration_input
4520
+ # The branding configuration that customizes the appearance of the web
4521
+ # portal for end users. When updating user settings without an
4522
+ # existing branding configuration, all fields (logo, favicon,
4523
+ # wallpaper, localized strings, and color theme) are required except
4524
+ # for terms of service. When updating user settings with an existing
4525
+ # branding configuration, all fields are optional.
4526
+ # @return [Types::BrandingConfigurationUpdateInput]
4527
+ #
4255
4528
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateUserSettingsRequest AWS API Documentation
4256
4529
  #
4257
4530
  class UpdateUserSettingsRequest < Struct.new(
@@ -4266,7 +4539,8 @@ module Aws::WorkSpacesWeb
4266
4539
  :client_token,
4267
4540
  :cookie_synchronization_configuration,
4268
4541
  :deep_link_allowed,
4269
- :toolbar_configuration)
4542
+ :toolbar_configuration,
4543
+ :branding_configuration_input)
4270
4544
  SENSITIVE = [:cookie_synchronization_configuration]
4271
4545
  include Aws::Structure
4272
4546
  end
@@ -4404,6 +4678,11 @@ module Aws::WorkSpacesWeb
4404
4678
  # settings, end users retain control over their toolbar preferences.
4405
4679
  # @return [Types::ToolbarConfiguration]
4406
4680
  #
4681
+ # @!attribute [rw] branding_configuration
4682
+ # The branding configuration output that customizes the appearance of
4683
+ # the web portal for end users.
4684
+ # @return [Types::BrandingConfiguration]
4685
+ #
4407
4686
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UserSettings AWS API Documentation
4408
4687
  #
4409
4688
  class UserSettings < Struct.new(
@@ -4420,7 +4699,8 @@ module Aws::WorkSpacesWeb
4420
4699
  :customer_managed_key,
4421
4700
  :additional_encryption_context,
4422
4701
  :deep_link_allowed,
4423
- :toolbar_configuration)
4702
+ :toolbar_configuration,
4703
+ :branding_configuration)
4424
4704
  SENSITIVE = [:cookie_synchronization_configuration]
4425
4705
  include Aws::Structure
4426
4706
  end
@@ -4485,6 +4765,11 @@ module Aws::WorkSpacesWeb
4485
4765
  # settings, end users retain control over their toolbar preferences.
4486
4766
  # @return [Types::ToolbarConfiguration]
4487
4767
  #
4768
+ # @!attribute [rw] branding_configuration
4769
+ # The branding configuration output that customizes the appearance of
4770
+ # the web portal for end users.
4771
+ # @return [Types::BrandingConfiguration]
4772
+ #
4488
4773
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UserSettingsSummary AWS API Documentation
4489
4774
  #
4490
4775
  class UserSettingsSummary < Struct.new(
@@ -4498,7 +4783,8 @@ module Aws::WorkSpacesWeb
4498
4783
  :idle_disconnect_timeout_in_minutes,
4499
4784
  :cookie_synchronization_configuration,
4500
4785
  :deep_link_allowed,
4501
- :toolbar_configuration)
4786
+ :toolbar_configuration,
4787
+ :branding_configuration)
4502
4788
  SENSITIVE = [:cookie_synchronization_configuration]
4503
4789
  include Aws::Structure
4504
4790
  end
@@ -4546,6 +4832,36 @@ module Aws::WorkSpacesWeb
4546
4832
  include Aws::Structure
4547
4833
  end
4548
4834
 
4835
+ # The input for a wallpaper image. Provide the image as either a binary
4836
+ # image file or an S3 URI. Maximum 5 MB in JPEG or PNG format.
4837
+ #
4838
+ # @note WallpaperImageInput is a union - when making an API calls you must set exactly one of the members.
4839
+ #
4840
+ # @!attribute [rw] blob
4841
+ # The image provided as a binary image file.
4842
+ # @return [String]
4843
+ #
4844
+ # @!attribute [rw] s3_uri
4845
+ # The S3 URI pointing to the image file. The URI must use the format
4846
+ # `s3://bucket-name/key-name`. You must have read access to the S3
4847
+ # object.
4848
+ # @return [String]
4849
+ #
4850
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/WallpaperImageInput AWS API Documentation
4851
+ #
4852
+ class WallpaperImageInput < Struct.new(
4853
+ :blob,
4854
+ :s3_uri,
4855
+ :unknown)
4856
+ SENSITIVE = []
4857
+ include Aws::Structure
4858
+ include Aws::Structure::Union
4859
+
4860
+ class Blob < WallpaperImageInput; end
4861
+ class S3Uri < WallpaperImageInput; end
4862
+ class Unknown < WallpaperImageInput; end
4863
+ end
4864
+
4549
4865
  # The policy that specifies which URLs end users are allowed to access
4550
4866
  # or which URLs or domain categories they are restricted from accessing
4551
4867
  # for enhanced security.
@@ -55,7 +55,7 @@ module Aws::WorkSpacesWeb
55
55
  autoload :EndpointProvider, 'aws-sdk-workspacesweb/endpoint_provider'
56
56
  autoload :Endpoints, 'aws-sdk-workspacesweb/endpoints'
57
57
 
58
- GEM_VERSION = '1.52.0'
58
+ GEM_VERSION = '1.53.0'
59
59
 
60
60
  end
61
61
 
data/sig/client.rbs CHANGED
@@ -440,6 +440,32 @@ module Aws
440
440
  visual_mode: ("Dark" | "Light")?,
441
441
  hidden_toolbar_items: Array[("Windows" | "DualMonitor" | "FullScreen" | "Webcam" | "Microphone")]?,
442
442
  max_display_resolution: ("size4096X2160" | "size3840X2160" | "size3440X1440" | "size2560X1440" | "size1920X1080" | "size1280X720" | "size1024X768" | "size800X600")?
443
+ },
444
+ ?branding_configuration_input: {
445
+ logo: {
446
+ blob: ::String?,
447
+ s3_uri: ::String?
448
+ },
449
+ wallpaper: {
450
+ blob: ::String?,
451
+ s3_uri: ::String?
452
+ },
453
+ favicon: {
454
+ blob: ::String?,
455
+ s3_uri: ::String?
456
+ },
457
+ localized_strings: Hash[("de-DE" | "en-US" | "es-ES" | "fr-FR" | "id-ID" | "it-IT" | "ja-JP" | "ko-KR" | "pt-BR" | "zh-CN" | "zh-TW"), {
458
+ browser_tab_title: ::String,
459
+ welcome_text: ::String,
460
+ login_title: ::String?,
461
+ login_description: ::String?,
462
+ login_button_text: ::String?,
463
+ contact_link: ::String?,
464
+ contact_button_text: ::String?,
465
+ loading_text: ::String?
466
+ }],
467
+ color_theme: ("Light" | "Dark"),
468
+ terms_of_service: ::String?
443
469
  }
444
470
  ) -> _CreateUserSettingsResponseSuccess
445
471
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateUserSettingsResponseSuccess
@@ -1139,6 +1165,32 @@ module Aws
1139
1165
  visual_mode: ("Dark" | "Light")?,
1140
1166
  hidden_toolbar_items: Array[("Windows" | "DualMonitor" | "FullScreen" | "Webcam" | "Microphone")]?,
1141
1167
  max_display_resolution: ("size4096X2160" | "size3840X2160" | "size3440X1440" | "size2560X1440" | "size1920X1080" | "size1280X720" | "size1024X768" | "size800X600")?
1168
+ },
1169
+ ?branding_configuration_input: {
1170
+ logo: {
1171
+ blob: ::String?,
1172
+ s3_uri: ::String?
1173
+ }?,
1174
+ wallpaper: {
1175
+ blob: ::String?,
1176
+ s3_uri: ::String?
1177
+ }?,
1178
+ favicon: {
1179
+ blob: ::String?,
1180
+ s3_uri: ::String?
1181
+ }?,
1182
+ localized_strings: Hash[("de-DE" | "en-US" | "es-ES" | "fr-FR" | "id-ID" | "it-IT" | "ja-JP" | "ko-KR" | "pt-BR" | "zh-CN" | "zh-TW"), {
1183
+ browser_tab_title: ::String,
1184
+ welcome_text: ::String,
1185
+ login_title: ::String?,
1186
+ login_description: ::String?,
1187
+ login_button_text: ::String?,
1188
+ contact_link: ::String?,
1189
+ contact_button_text: ::String?,
1190
+ loading_text: ::String?
1191
+ }]?,
1192
+ color_theme: ("Light" | "Dark")?,
1193
+ terms_of_service: ::String?
1142
1194
  }
1143
1195
  ) -> _UpdateUserSettingsResponseSuccess
1144
1196
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateUserSettingsResponseSuccess
data/sig/types.rbs CHANGED
@@ -109,6 +109,36 @@ module Aws::WorkSpacesWeb
109
109
  SENSITIVE: []
110
110
  end
111
111
 
112
+ class BrandingConfiguration
113
+ attr_accessor logo: Types::ImageMetadata
114
+ attr_accessor wallpaper: Types::ImageMetadata
115
+ attr_accessor favicon: Types::ImageMetadata
116
+ attr_accessor localized_strings: ::Hash[("de-DE" | "en-US" | "es-ES" | "fr-FR" | "id-ID" | "it-IT" | "ja-JP" | "ko-KR" | "pt-BR" | "zh-CN" | "zh-TW"), Types::LocalizedBrandingStrings]
117
+ attr_accessor color_theme: ("Light" | "Dark")
118
+ attr_accessor terms_of_service: ::String
119
+ SENSITIVE: [:terms_of_service]
120
+ end
121
+
122
+ class BrandingConfigurationCreateInput
123
+ attr_accessor logo: Types::IconImageInput
124
+ attr_accessor wallpaper: Types::WallpaperImageInput
125
+ attr_accessor favicon: Types::IconImageInput
126
+ attr_accessor localized_strings: ::Hash[("de-DE" | "en-US" | "es-ES" | "fr-FR" | "id-ID" | "it-IT" | "ja-JP" | "ko-KR" | "pt-BR" | "zh-CN" | "zh-TW"), Types::LocalizedBrandingStrings]
127
+ attr_accessor color_theme: ("Light" | "Dark")
128
+ attr_accessor terms_of_service: ::String
129
+ SENSITIVE: [:terms_of_service]
130
+ end
131
+
132
+ class BrandingConfigurationUpdateInput
133
+ attr_accessor logo: Types::IconImageInput
134
+ attr_accessor wallpaper: Types::WallpaperImageInput
135
+ attr_accessor favicon: Types::IconImageInput
136
+ attr_accessor localized_strings: ::Hash[("de-DE" | "en-US" | "es-ES" | "fr-FR" | "id-ID" | "it-IT" | "ja-JP" | "ko-KR" | "pt-BR" | "zh-CN" | "zh-TW"), Types::LocalizedBrandingStrings]
137
+ attr_accessor color_theme: ("Light" | "Dark")
138
+ attr_accessor terms_of_service: ::String
139
+ SENSITIVE: [:terms_of_service]
140
+ end
141
+
112
142
  class BrowserSettings
113
143
  attr_accessor browser_settings_arn: ::String
114
144
  attr_accessor associated_portal_arns: ::Array[::String]
@@ -312,6 +342,7 @@ module Aws::WorkSpacesWeb
312
342
  attr_accessor additional_encryption_context: ::Hash[::String, ::String]
313
343
  attr_accessor deep_link_allowed: ("Disabled" | "Enabled")
314
344
  attr_accessor toolbar_configuration: Types::ToolbarConfiguration
345
+ attr_accessor branding_configuration_input: Types::BrandingConfigurationCreateInput
315
346
  SENSITIVE: [:cookie_synchronization_configuration]
316
347
  end
317
348
 
@@ -649,6 +680,20 @@ module Aws::WorkSpacesWeb
649
680
  SENSITIVE: []
650
681
  end
651
682
 
683
+ class IconImageInput
684
+ attr_accessor blob: ::String
685
+ attr_accessor s3_uri: ::String
686
+ attr_accessor unknown: untyped
687
+ SENSITIVE: []
688
+
689
+ class Blob < IconImageInput
690
+ end
691
+ class S3Uri < IconImageInput
692
+ end
693
+ class Unknown < IconImageInput
694
+ end
695
+ end
696
+
652
697
  class IdentityProvider
653
698
  attr_accessor identity_provider_arn: ::String
654
699
  attr_accessor identity_provider_name: ::String
@@ -664,6 +709,13 @@ module Aws::WorkSpacesWeb
664
709
  SENSITIVE: [:identity_provider_name]
665
710
  end
666
711
 
712
+ class ImageMetadata
713
+ attr_accessor mime_type: ("image/png" | "image/jpeg" | "image/x-icon")
714
+ attr_accessor file_extension: ::String
715
+ attr_accessor last_upload_timestamp: ::Time
716
+ SENSITIVE: []
717
+ end
718
+
667
719
  class InlineRedactionConfiguration
668
720
  attr_accessor inline_redaction_patterns: ::Array[Types::InlineRedactionPattern]
669
721
  attr_accessor global_enforced_urls: ::Array[::String]
@@ -876,6 +928,18 @@ module Aws::WorkSpacesWeb
876
928
  SENSITIVE: []
877
929
  end
878
930
 
931
+ class LocalizedBrandingStrings
932
+ attr_accessor browser_tab_title: ::String
933
+ attr_accessor welcome_text: ::String
934
+ attr_accessor login_title: ::String
935
+ attr_accessor login_description: ::String
936
+ attr_accessor login_button_text: ::String
937
+ attr_accessor contact_link: ::String
938
+ attr_accessor contact_button_text: ::String
939
+ attr_accessor loading_text: ::String
940
+ SENSITIVE: []
941
+ end
942
+
879
943
  class LogConfiguration
880
944
  attr_accessor s3: Types::S3LogConfiguration
881
945
  SENSITIVE: []
@@ -1210,6 +1274,7 @@ module Aws::WorkSpacesWeb
1210
1274
  attr_accessor cookie_synchronization_configuration: Types::CookieSynchronizationConfiguration
1211
1275
  attr_accessor deep_link_allowed: ("Disabled" | "Enabled")
1212
1276
  attr_accessor toolbar_configuration: Types::ToolbarConfiguration
1277
+ attr_accessor branding_configuration_input: Types::BrandingConfigurationUpdateInput
1213
1278
  SENSITIVE: [:cookie_synchronization_configuration]
1214
1279
  end
1215
1280
 
@@ -1246,6 +1311,7 @@ module Aws::WorkSpacesWeb
1246
1311
  attr_accessor additional_encryption_context: ::Hash[::String, ::String]
1247
1312
  attr_accessor deep_link_allowed: ("Disabled" | "Enabled")
1248
1313
  attr_accessor toolbar_configuration: Types::ToolbarConfiguration
1314
+ attr_accessor branding_configuration: Types::BrandingConfiguration
1249
1315
  SENSITIVE: [:cookie_synchronization_configuration]
1250
1316
  end
1251
1317
 
@@ -1261,6 +1327,7 @@ module Aws::WorkSpacesWeb
1261
1327
  attr_accessor cookie_synchronization_configuration: Types::CookieSynchronizationConfiguration
1262
1328
  attr_accessor deep_link_allowed: ("Disabled" | "Enabled")
1263
1329
  attr_accessor toolbar_configuration: Types::ToolbarConfiguration
1330
+ attr_accessor branding_configuration: Types::BrandingConfiguration
1264
1331
  SENSITIVE: [:cookie_synchronization_configuration]
1265
1332
  end
1266
1333
 
@@ -1277,6 +1344,20 @@ module Aws::WorkSpacesWeb
1277
1344
  SENSITIVE: []
1278
1345
  end
1279
1346
 
1347
+ class WallpaperImageInput
1348
+ attr_accessor blob: ::String
1349
+ attr_accessor s3_uri: ::String
1350
+ attr_accessor unknown: untyped
1351
+ SENSITIVE: []
1352
+
1353
+ class Blob < WallpaperImageInput
1354
+ end
1355
+ class S3Uri < WallpaperImageInput
1356
+ end
1357
+ class Unknown < WallpaperImageInput
1358
+ end
1359
+ end
1360
+
1280
1361
  class WebContentFilteringPolicy
1281
1362
  attr_accessor blocked_categories: ::Array[("Cults" | "Gambling" | "Nudity" | "Pornography" | "SexEducation" | "Tasteless" | "Violence" | "DownloadSites" | "ImageSharing" | "PeerToPeer" | "StreamingMediaAndDownloads" | "GenerativeAI" | "CriminalActivity" | "Hacking" | "HateAndIntolerance" | "IllegalDrug" | "IllegalSoftware" | "SchoolCheating" | "SelfHarm" | "Weapons" | "Chat" | "Games" | "InstantMessaging" | "ProfessionalNetwork" | "SocialNetworking" | "WebBasedEmail" | "ParkedDomains")]
1282
1363
  attr_accessor allowed_urls: ::Array[::String]
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-workspacesweb
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.52.0
4
+ version: 1.53.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services