aws-sdk-workspacesweb 1.3.0 → 1.5.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 +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-workspacesweb/client.rb +345 -3
- data/lib/aws-sdk-workspacesweb/client_api.rb +188 -0
- data/lib/aws-sdk-workspacesweb/types.rb +465 -15
- data/lib/aws-sdk-workspacesweb.rb +1 -1
- metadata +2 -2
@@ -149,6 +149,48 @@ module Aws::WorkSpacesWeb
|
|
149
149
|
include Aws::Structure
|
150
150
|
end
|
151
151
|
|
152
|
+
# @note When making an API call, you may pass AssociateUserAccessLoggingSettingsRequest
|
153
|
+
# data as a hash:
|
154
|
+
#
|
155
|
+
# {
|
156
|
+
# portal_arn: "ARN", # required
|
157
|
+
# user_access_logging_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_access_logging_settings_arn
|
165
|
+
# The ARN of the user access logging settings.
|
166
|
+
# @return [String]
|
167
|
+
#
|
168
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AssociateUserAccessLoggingSettingsRequest AWS API Documentation
|
169
|
+
#
|
170
|
+
class AssociateUserAccessLoggingSettingsRequest < Struct.new(
|
171
|
+
:portal_arn,
|
172
|
+
:user_access_logging_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_access_logging_settings_arn
|
182
|
+
# The ARN of the user access logging settings.
|
183
|
+
# @return [String]
|
184
|
+
#
|
185
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/AssociateUserAccessLoggingSettingsResponse AWS API Documentation
|
186
|
+
#
|
187
|
+
class AssociateUserAccessLoggingSettingsResponse < Struct.new(
|
188
|
+
:portal_arn,
|
189
|
+
:user_access_logging_settings_arn)
|
190
|
+
SENSITIVE = []
|
191
|
+
include Aws::Structure
|
192
|
+
end
|
193
|
+
|
152
194
|
# @note When making an API call, you may pass AssociateUserSettingsRequest
|
153
195
|
# data as a hash:
|
154
196
|
#
|
@@ -216,7 +258,7 @@ module Aws::WorkSpacesWeb
|
|
216
258
|
:associated_portal_arns,
|
217
259
|
:browser_policy,
|
218
260
|
:browser_settings_arn)
|
219
|
-
SENSITIVE = []
|
261
|
+
SENSITIVE = [:browser_policy]
|
220
262
|
include Aws::Structure
|
221
263
|
end
|
222
264
|
|
@@ -389,7 +431,7 @@ module Aws::WorkSpacesWeb
|
|
389
431
|
:client_token,
|
390
432
|
:customer_managed_key,
|
391
433
|
:tags)
|
392
|
-
SENSITIVE = []
|
434
|
+
SENSITIVE = [:browser_policy]
|
393
435
|
include Aws::Structure
|
394
436
|
end
|
395
437
|
|
@@ -495,7 +537,7 @@ module Aws::WorkSpacesWeb
|
|
495
537
|
#
|
496
538
|
# * `MetadataFile` OR `MetadataURL`
|
497
539
|
#
|
498
|
-
# * `IDPSignout` *optional*
|
540
|
+
# * `IDPSignout` (boolean) *optional*
|
499
541
|
# @return [Hash<String,String>]
|
500
542
|
#
|
501
543
|
# @!attribute [rw] identity_provider_name
|
@@ -518,7 +560,7 @@ module Aws::WorkSpacesWeb
|
|
518
560
|
:identity_provider_name,
|
519
561
|
:identity_provider_type,
|
520
562
|
:portal_arn)
|
521
|
-
SENSITIVE = []
|
563
|
+
SENSITIVE = [:identity_provider_details, :identity_provider_name]
|
522
564
|
include Aws::Structure
|
523
565
|
end
|
524
566
|
|
@@ -667,7 +709,7 @@ module Aws::WorkSpacesWeb
|
|
667
709
|
:customer_managed_key,
|
668
710
|
:display_name,
|
669
711
|
:tags)
|
670
|
-
SENSITIVE = []
|
712
|
+
SENSITIVE = [:display_name]
|
671
713
|
include Aws::Structure
|
672
714
|
end
|
673
715
|
|
@@ -748,13 +790,75 @@ module Aws::WorkSpacesWeb
|
|
748
790
|
include Aws::Structure
|
749
791
|
end
|
750
792
|
|
793
|
+
# @note When making an API call, you may pass CreateUserAccessLoggingSettingsRequest
|
794
|
+
# data as a hash:
|
795
|
+
#
|
796
|
+
# {
|
797
|
+
# client_token: "ClientToken",
|
798
|
+
# kinesis_stream_arn: "KinesisStreamArn", # required
|
799
|
+
# tags: [
|
800
|
+
# {
|
801
|
+
# key: "TagKey", # required
|
802
|
+
# value: "TagValue", # required
|
803
|
+
# },
|
804
|
+
# ],
|
805
|
+
# }
|
806
|
+
#
|
807
|
+
# @!attribute [rw] client_token
|
808
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
809
|
+
# idempotency of the request. Idempotency ensures that an API request
|
810
|
+
# completes only once. With an idempotent request, if the original
|
811
|
+
# request completes successfully, subsequent retries with the same
|
812
|
+
# client token returns the result from the original successful
|
813
|
+
# request.
|
814
|
+
#
|
815
|
+
# If you do not specify a client token, one is automatically generated
|
816
|
+
# by the AWS SDK.
|
817
|
+
#
|
818
|
+
# **A suitable default value is auto-generated.** You should normally
|
819
|
+
# not need to pass this option.
|
820
|
+
# @return [String]
|
821
|
+
#
|
822
|
+
# @!attribute [rw] kinesis_stream_arn
|
823
|
+
# The ARN of the Kinesis stream.
|
824
|
+
# @return [String]
|
825
|
+
#
|
826
|
+
# @!attribute [rw] tags
|
827
|
+
# The tags to add to the user settings resource. A tag is a key-value
|
828
|
+
# pair.
|
829
|
+
# @return [Array<Types::Tag>]
|
830
|
+
#
|
831
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateUserAccessLoggingSettingsRequest AWS API Documentation
|
832
|
+
#
|
833
|
+
class CreateUserAccessLoggingSettingsRequest < Struct.new(
|
834
|
+
:client_token,
|
835
|
+
:kinesis_stream_arn,
|
836
|
+
:tags)
|
837
|
+
SENSITIVE = []
|
838
|
+
include Aws::Structure
|
839
|
+
end
|
840
|
+
|
841
|
+
# @!attribute [rw] user_access_logging_settings_arn
|
842
|
+
# The ARN of the user access logging settings.
|
843
|
+
# @return [String]
|
844
|
+
#
|
845
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/CreateUserAccessLoggingSettingsResponse AWS API Documentation
|
846
|
+
#
|
847
|
+
class CreateUserAccessLoggingSettingsResponse < Struct.new(
|
848
|
+
:user_access_logging_settings_arn)
|
849
|
+
SENSITIVE = []
|
850
|
+
include Aws::Structure
|
851
|
+
end
|
852
|
+
|
751
853
|
# @note When making an API call, you may pass CreateUserSettingsRequest
|
752
854
|
# data as a hash:
|
753
855
|
#
|
754
856
|
# {
|
755
857
|
# client_token: "ClientToken",
|
756
858
|
# copy_allowed: "Disabled", # required, accepts Disabled, Enabled
|
859
|
+
# disconnect_timeout_in_minutes: 1,
|
757
860
|
# download_allowed: "Disabled", # required, accepts Disabled, Enabled
|
861
|
+
# idle_disconnect_timeout_in_minutes: 1,
|
758
862
|
# paste_allowed: "Disabled", # required, accepts Disabled, Enabled
|
759
863
|
# print_allowed: "Disabled", # required, accepts Disabled, Enabled
|
760
864
|
# tags: [
|
@@ -786,11 +890,22 @@ module Aws::WorkSpacesWeb
|
|
786
890
|
# to the local device.
|
787
891
|
# @return [String]
|
788
892
|
#
|
893
|
+
# @!attribute [rw] disconnect_timeout_in_minutes
|
894
|
+
# The amount of time that a streaming session remains active after
|
895
|
+
# users disconnect.
|
896
|
+
# @return [Integer]
|
897
|
+
#
|
789
898
|
# @!attribute [rw] download_allowed
|
790
899
|
# Specifies whether the user can download files from the streaming
|
791
900
|
# session to the local device.
|
792
901
|
# @return [String]
|
793
902
|
#
|
903
|
+
# @!attribute [rw] idle_disconnect_timeout_in_minutes
|
904
|
+
# The amount of time that users can be idle (inactive) before they are
|
905
|
+
# disconnected from their streaming session and the disconnect timeout
|
906
|
+
# interval begins.
|
907
|
+
# @return [Integer]
|
908
|
+
#
|
794
909
|
# @!attribute [rw] paste_allowed
|
795
910
|
# Specifies whether the user can paste text from the local device to
|
796
911
|
# the streaming session.
|
@@ -815,7 +930,9 @@ module Aws::WorkSpacesWeb
|
|
815
930
|
class CreateUserSettingsRequest < Struct.new(
|
816
931
|
:client_token,
|
817
932
|
:copy_allowed,
|
933
|
+
:disconnect_timeout_in_minutes,
|
818
934
|
:download_allowed,
|
935
|
+
:idle_disconnect_timeout_in_minutes,
|
819
936
|
:paste_allowed,
|
820
937
|
:print_allowed,
|
821
938
|
:tags,
|
@@ -951,6 +1068,29 @@ module Aws::WorkSpacesWeb
|
|
951
1068
|
#
|
952
1069
|
class DeleteTrustStoreResponse < Aws::EmptyStructure; end
|
953
1070
|
|
1071
|
+
# @note When making an API call, you may pass DeleteUserAccessLoggingSettingsRequest
|
1072
|
+
# data as a hash:
|
1073
|
+
#
|
1074
|
+
# {
|
1075
|
+
# user_access_logging_settings_arn: "ARN", # required
|
1076
|
+
# }
|
1077
|
+
#
|
1078
|
+
# @!attribute [rw] user_access_logging_settings_arn
|
1079
|
+
# The ARN of the user access logging settings.
|
1080
|
+
# @return [String]
|
1081
|
+
#
|
1082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteUserAccessLoggingSettingsRequest AWS API Documentation
|
1083
|
+
#
|
1084
|
+
class DeleteUserAccessLoggingSettingsRequest < Struct.new(
|
1085
|
+
:user_access_logging_settings_arn)
|
1086
|
+
SENSITIVE = []
|
1087
|
+
include Aws::Structure
|
1088
|
+
end
|
1089
|
+
|
1090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DeleteUserAccessLoggingSettingsResponse AWS API Documentation
|
1091
|
+
#
|
1092
|
+
class DeleteUserAccessLoggingSettingsResponse < Aws::EmptyStructure; end
|
1093
|
+
|
954
1094
|
# @note When making an API call, you may pass DeleteUserSettingsRequest
|
955
1095
|
# data as a hash:
|
956
1096
|
#
|
@@ -1043,6 +1183,29 @@ module Aws::WorkSpacesWeb
|
|
1043
1183
|
#
|
1044
1184
|
class DisassociateTrustStoreResponse < Aws::EmptyStructure; end
|
1045
1185
|
|
1186
|
+
# @note When making an API call, you may pass DisassociateUserAccessLoggingSettingsRequest
|
1187
|
+
# data as a hash:
|
1188
|
+
#
|
1189
|
+
# {
|
1190
|
+
# portal_arn: "ARN", # required
|
1191
|
+
# }
|
1192
|
+
#
|
1193
|
+
# @!attribute [rw] portal_arn
|
1194
|
+
# The ARN of the web portal.
|
1195
|
+
# @return [String]
|
1196
|
+
#
|
1197
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DisassociateUserAccessLoggingSettingsRequest AWS API Documentation
|
1198
|
+
#
|
1199
|
+
class DisassociateUserAccessLoggingSettingsRequest < Struct.new(
|
1200
|
+
:portal_arn)
|
1201
|
+
SENSITIVE = []
|
1202
|
+
include Aws::Structure
|
1203
|
+
end
|
1204
|
+
|
1205
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/DisassociateUserAccessLoggingSettingsResponse AWS API Documentation
|
1206
|
+
#
|
1207
|
+
class DisassociateUserAccessLoggingSettingsResponse < Aws::EmptyStructure; end
|
1208
|
+
|
1046
1209
|
# @note When making an API call, you may pass DisassociateUserSettingsRequest
|
1047
1210
|
# data as a hash:
|
1048
1211
|
#
|
@@ -1299,6 +1462,37 @@ module Aws::WorkSpacesWeb
|
|
1299
1462
|
include Aws::Structure
|
1300
1463
|
end
|
1301
1464
|
|
1465
|
+
# @note When making an API call, you may pass GetUserAccessLoggingSettingsRequest
|
1466
|
+
# data as a hash:
|
1467
|
+
#
|
1468
|
+
# {
|
1469
|
+
# user_access_logging_settings_arn: "ARN", # required
|
1470
|
+
# }
|
1471
|
+
#
|
1472
|
+
# @!attribute [rw] user_access_logging_settings_arn
|
1473
|
+
# The ARN of the user access logging settings.
|
1474
|
+
# @return [String]
|
1475
|
+
#
|
1476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetUserAccessLoggingSettingsRequest AWS API Documentation
|
1477
|
+
#
|
1478
|
+
class GetUserAccessLoggingSettingsRequest < Struct.new(
|
1479
|
+
:user_access_logging_settings_arn)
|
1480
|
+
SENSITIVE = []
|
1481
|
+
include Aws::Structure
|
1482
|
+
end
|
1483
|
+
|
1484
|
+
# @!attribute [rw] user_access_logging_settings
|
1485
|
+
# The user access logging settings.
|
1486
|
+
# @return [Types::UserAccessLoggingSettings]
|
1487
|
+
#
|
1488
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/GetUserAccessLoggingSettingsResponse AWS API Documentation
|
1489
|
+
#
|
1490
|
+
class GetUserAccessLoggingSettingsResponse < Struct.new(
|
1491
|
+
:user_access_logging_settings)
|
1492
|
+
SENSITIVE = []
|
1493
|
+
include Aws::Structure
|
1494
|
+
end
|
1495
|
+
|
1302
1496
|
# @note When making an API call, you may pass GetUserSettingsRequest
|
1303
1497
|
# data as a hash:
|
1304
1498
|
#
|
@@ -1416,7 +1610,7 @@ module Aws::WorkSpacesWeb
|
|
1416
1610
|
:identity_provider_details,
|
1417
1611
|
:identity_provider_name,
|
1418
1612
|
:identity_provider_type)
|
1419
|
-
SENSITIVE = []
|
1613
|
+
SENSITIVE = [:identity_provider_details, :identity_provider_name]
|
1420
1614
|
include Aws::Structure
|
1421
1615
|
end
|
1422
1616
|
|
@@ -1440,7 +1634,7 @@ module Aws::WorkSpacesWeb
|
|
1440
1634
|
:identity_provider_arn,
|
1441
1635
|
:identity_provider_name,
|
1442
1636
|
:identity_provider_type)
|
1443
|
-
SENSITIVE = []
|
1637
|
+
SENSITIVE = [:identity_provider_name]
|
1444
1638
|
include Aws::Structure
|
1445
1639
|
end
|
1446
1640
|
|
@@ -1774,6 +1968,50 @@ module Aws::WorkSpacesWeb
|
|
1774
1968
|
include Aws::Structure
|
1775
1969
|
end
|
1776
1970
|
|
1971
|
+
# @note When making an API call, you may pass ListUserAccessLoggingSettingsRequest
|
1972
|
+
# data as a hash:
|
1973
|
+
#
|
1974
|
+
# {
|
1975
|
+
# max_results: 1,
|
1976
|
+
# next_token: "PaginationToken",
|
1977
|
+
# }
|
1978
|
+
#
|
1979
|
+
# @!attribute [rw] max_results
|
1980
|
+
# The maximum number of results to be included in the next page.
|
1981
|
+
# @return [Integer]
|
1982
|
+
#
|
1983
|
+
# @!attribute [rw] next_token
|
1984
|
+
# The pagination token used to retrieve the next page of results for
|
1985
|
+
# this operation.
|
1986
|
+
# @return [String]
|
1987
|
+
#
|
1988
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListUserAccessLoggingSettingsRequest AWS API Documentation
|
1989
|
+
#
|
1990
|
+
class ListUserAccessLoggingSettingsRequest < Struct.new(
|
1991
|
+
:max_results,
|
1992
|
+
:next_token)
|
1993
|
+
SENSITIVE = []
|
1994
|
+
include Aws::Structure
|
1995
|
+
end
|
1996
|
+
|
1997
|
+
# @!attribute [rw] next_token
|
1998
|
+
# The pagination token used to retrieve the next page of results for
|
1999
|
+
# this operation.
|
2000
|
+
# @return [String]
|
2001
|
+
#
|
2002
|
+
# @!attribute [rw] user_access_logging_settings
|
2003
|
+
# The user access logging settings.
|
2004
|
+
# @return [Array<Types::UserAccessLoggingSettingsSummary>]
|
2005
|
+
#
|
2006
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/ListUserAccessLoggingSettingsResponse AWS API Documentation
|
2007
|
+
#
|
2008
|
+
class ListUserAccessLoggingSettingsResponse < Struct.new(
|
2009
|
+
:next_token,
|
2010
|
+
:user_access_logging_settings)
|
2011
|
+
SENSITIVE = []
|
2012
|
+
include Aws::Structure
|
2013
|
+
end
|
2014
|
+
|
1777
2015
|
# @note When making an API call, you may pass ListUserSettingsRequest
|
1778
2016
|
# data as a hash:
|
1779
2017
|
#
|
@@ -1926,8 +2164,13 @@ module Aws::WorkSpacesWeb
|
|
1926
2164
|
# The ARN of the trust store that is associated with the web portal.
|
1927
2165
|
# @return [String]
|
1928
2166
|
#
|
2167
|
+
# @!attribute [rw] user_access_logging_settings_arn
|
2168
|
+
# The ARN of the user access logging settings that is associated with
|
2169
|
+
# the web portal.
|
2170
|
+
# @return [String]
|
2171
|
+
#
|
1929
2172
|
# @!attribute [rw] user_settings_arn
|
1930
|
-
# The ARN of the
|
2173
|
+
# The ARN of the user settings that is associated with the web portal.
|
1931
2174
|
# @return [String]
|
1932
2175
|
#
|
1933
2176
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/Portal AWS API Documentation
|
@@ -1944,8 +2187,9 @@ module Aws::WorkSpacesWeb
|
|
1944
2187
|
:renderer_type,
|
1945
2188
|
:status_reason,
|
1946
2189
|
:trust_store_arn,
|
2190
|
+
:user_access_logging_settings_arn,
|
1947
2191
|
:user_settings_arn)
|
1948
|
-
SENSITIVE = []
|
2192
|
+
SENSITIVE = [:display_name]
|
1949
2193
|
include Aws::Structure
|
1950
2194
|
end
|
1951
2195
|
|
@@ -1994,6 +2238,11 @@ module Aws::WorkSpacesWeb
|
|
1994
2238
|
# The ARN of the trust that is associated with this web portal.
|
1995
2239
|
# @return [String]
|
1996
2240
|
#
|
2241
|
+
# @!attribute [rw] user_access_logging_settings_arn
|
2242
|
+
# The ARN of the user access logging settings that is associated with
|
2243
|
+
# the web portal.
|
2244
|
+
# @return [String]
|
2245
|
+
#
|
1997
2246
|
# @!attribute [rw] user_settings_arn
|
1998
2247
|
# The ARN of the user settings that is associated with the web portal.
|
1999
2248
|
# @return [String]
|
@@ -2011,8 +2260,9 @@ module Aws::WorkSpacesWeb
|
|
2011
2260
|
:portal_status,
|
2012
2261
|
:renderer_type,
|
2013
2262
|
:trust_store_arn,
|
2263
|
+
:user_access_logging_settings_arn,
|
2014
2264
|
:user_settings_arn)
|
2015
|
-
SENSITIVE = []
|
2265
|
+
SENSITIVE = [:display_name]
|
2016
2266
|
include Aws::Structure
|
2017
2267
|
end
|
2018
2268
|
|
@@ -2095,7 +2345,7 @@ module Aws::WorkSpacesWeb
|
|
2095
2345
|
class Tag < Struct.new(
|
2096
2346
|
:key,
|
2097
2347
|
:value)
|
2098
|
-
SENSITIVE = []
|
2348
|
+
SENSITIVE = [:key, :value]
|
2099
2349
|
include Aws::Structure
|
2100
2350
|
end
|
2101
2351
|
|
@@ -2302,7 +2552,7 @@ module Aws::WorkSpacesWeb
|
|
2302
2552
|
:browser_policy,
|
2303
2553
|
:browser_settings_arn,
|
2304
2554
|
:client_token)
|
2305
|
-
SENSITIVE = []
|
2555
|
+
SENSITIVE = [:browser_policy]
|
2306
2556
|
include Aws::Structure
|
2307
2557
|
end
|
2308
2558
|
|
@@ -2350,7 +2600,68 @@ module Aws::WorkSpacesWeb
|
|
2350
2600
|
# @return [String]
|
2351
2601
|
#
|
2352
2602
|
# @!attribute [rw] identity_provider_details
|
2353
|
-
# The details of the identity provider.
|
2603
|
+
# The details of the identity provider. The following list describes
|
2604
|
+
# the provider detail keys for each identity provider type.
|
2605
|
+
#
|
2606
|
+
# * For Google and Login with Amazon:
|
2607
|
+
#
|
2608
|
+
# * `client_id`
|
2609
|
+
#
|
2610
|
+
# * `client_secret`
|
2611
|
+
#
|
2612
|
+
# * `authorize_scopes`
|
2613
|
+
#
|
2614
|
+
# * For Facebook:
|
2615
|
+
#
|
2616
|
+
# * `client_id`
|
2617
|
+
#
|
2618
|
+
# * `client_secret`
|
2619
|
+
#
|
2620
|
+
# * `authorize_scopes`
|
2621
|
+
#
|
2622
|
+
# * `api_version`
|
2623
|
+
#
|
2624
|
+
# * For Sign in with Apple:
|
2625
|
+
#
|
2626
|
+
# * `client_id`
|
2627
|
+
#
|
2628
|
+
# * `team_id`
|
2629
|
+
#
|
2630
|
+
# * `key_id`
|
2631
|
+
#
|
2632
|
+
# * `private_key`
|
2633
|
+
#
|
2634
|
+
# * `authorize_scopes`
|
2635
|
+
#
|
2636
|
+
# * For OIDC providers:
|
2637
|
+
#
|
2638
|
+
# * `client_id`
|
2639
|
+
#
|
2640
|
+
# * `client_secret`
|
2641
|
+
#
|
2642
|
+
# * `attributes_request_method`
|
2643
|
+
#
|
2644
|
+
# * `oidc_issuer`
|
2645
|
+
#
|
2646
|
+
# * `authorize_scopes`
|
2647
|
+
#
|
2648
|
+
# * `authorize_url` *if not available from discovery URL specified
|
2649
|
+
# by `oidc_issuer` key*
|
2650
|
+
#
|
2651
|
+
# * `token_url` *if not available from discovery URL specified by
|
2652
|
+
# `oidc_issuer` key*
|
2653
|
+
#
|
2654
|
+
# * `attributes_url` *if not available from discovery URL specified
|
2655
|
+
# by `oidc_issuer` key*
|
2656
|
+
#
|
2657
|
+
# * `jwks_uri` *if not available from discovery URL specified by
|
2658
|
+
# `oidc_issuer` key*
|
2659
|
+
#
|
2660
|
+
# * For SAML providers:
|
2661
|
+
#
|
2662
|
+
# * `MetadataFile` OR `MetadataURL`
|
2663
|
+
#
|
2664
|
+
# * `IDPSignout` (boolean) *optional*
|
2354
2665
|
# @return [Hash<String,String>]
|
2355
2666
|
#
|
2356
2667
|
# @!attribute [rw] identity_provider_name
|
@@ -2369,7 +2680,7 @@ module Aws::WorkSpacesWeb
|
|
2369
2680
|
:identity_provider_details,
|
2370
2681
|
:identity_provider_name,
|
2371
2682
|
:identity_provider_type)
|
2372
|
-
SENSITIVE = []
|
2683
|
+
SENSITIVE = [:identity_provider_details, :identity_provider_name]
|
2373
2684
|
include Aws::Structure
|
2374
2685
|
end
|
2375
2686
|
|
@@ -2475,7 +2786,7 @@ module Aws::WorkSpacesWeb
|
|
2475
2786
|
class UpdatePortalRequest < Struct.new(
|
2476
2787
|
:display_name,
|
2477
2788
|
:portal_arn)
|
2478
|
-
SENSITIVE = []
|
2789
|
+
SENSITIVE = [:display_name]
|
2479
2790
|
include Aws::Structure
|
2480
2791
|
end
|
2481
2792
|
|
@@ -2550,13 +2861,68 @@ module Aws::WorkSpacesWeb
|
|
2550
2861
|
include Aws::Structure
|
2551
2862
|
end
|
2552
2863
|
|
2864
|
+
# @note When making an API call, you may pass UpdateUserAccessLoggingSettingsRequest
|
2865
|
+
# data as a hash:
|
2866
|
+
#
|
2867
|
+
# {
|
2868
|
+
# client_token: "ClientToken",
|
2869
|
+
# kinesis_stream_arn: "KinesisStreamArn",
|
2870
|
+
# user_access_logging_settings_arn: "ARN", # required
|
2871
|
+
# }
|
2872
|
+
#
|
2873
|
+
# @!attribute [rw] client_token
|
2874
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
2875
|
+
# idempotency of the request. Idempotency ensures that an API request
|
2876
|
+
# completes only once. With an idempotent request, if the original
|
2877
|
+
# request completes successfully, subsequent retries with the same
|
2878
|
+
# client token return the result from the original successful request.
|
2879
|
+
#
|
2880
|
+
# If you do not specify a client token, one is automatically generated
|
2881
|
+
# by the AWS SDK.
|
2882
|
+
#
|
2883
|
+
# **A suitable default value is auto-generated.** You should normally
|
2884
|
+
# not need to pass this option.
|
2885
|
+
# @return [String]
|
2886
|
+
#
|
2887
|
+
# @!attribute [rw] kinesis_stream_arn
|
2888
|
+
# The ARN of the Kinesis stream.
|
2889
|
+
# @return [String]
|
2890
|
+
#
|
2891
|
+
# @!attribute [rw] user_access_logging_settings_arn
|
2892
|
+
# The ARN of the user access logging settings.
|
2893
|
+
# @return [String]
|
2894
|
+
#
|
2895
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateUserAccessLoggingSettingsRequest AWS API Documentation
|
2896
|
+
#
|
2897
|
+
class UpdateUserAccessLoggingSettingsRequest < Struct.new(
|
2898
|
+
:client_token,
|
2899
|
+
:kinesis_stream_arn,
|
2900
|
+
:user_access_logging_settings_arn)
|
2901
|
+
SENSITIVE = []
|
2902
|
+
include Aws::Structure
|
2903
|
+
end
|
2904
|
+
|
2905
|
+
# @!attribute [rw] user_access_logging_settings
|
2906
|
+
# The user access logging settings.
|
2907
|
+
# @return [Types::UserAccessLoggingSettings]
|
2908
|
+
#
|
2909
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UpdateUserAccessLoggingSettingsResponse AWS API Documentation
|
2910
|
+
#
|
2911
|
+
class UpdateUserAccessLoggingSettingsResponse < Struct.new(
|
2912
|
+
:user_access_logging_settings)
|
2913
|
+
SENSITIVE = []
|
2914
|
+
include Aws::Structure
|
2915
|
+
end
|
2916
|
+
|
2553
2917
|
# @note When making an API call, you may pass UpdateUserSettingsRequest
|
2554
2918
|
# data as a hash:
|
2555
2919
|
#
|
2556
2920
|
# {
|
2557
2921
|
# client_token: "ClientToken",
|
2558
2922
|
# copy_allowed: "Disabled", # accepts Disabled, Enabled
|
2923
|
+
# disconnect_timeout_in_minutes: 1,
|
2559
2924
|
# download_allowed: "Disabled", # accepts Disabled, Enabled
|
2925
|
+
# idle_disconnect_timeout_in_minutes: 1,
|
2560
2926
|
# paste_allowed: "Disabled", # accepts Disabled, Enabled
|
2561
2927
|
# print_allowed: "Disabled", # accepts Disabled, Enabled
|
2562
2928
|
# upload_allowed: "Disabled", # accepts Disabled, Enabled
|
@@ -2582,11 +2948,22 @@ module Aws::WorkSpacesWeb
|
|
2582
2948
|
# to the local device.
|
2583
2949
|
# @return [String]
|
2584
2950
|
#
|
2951
|
+
# @!attribute [rw] disconnect_timeout_in_minutes
|
2952
|
+
# The amount of time that a streaming session remains active after
|
2953
|
+
# users disconnect.
|
2954
|
+
# @return [Integer]
|
2955
|
+
#
|
2585
2956
|
# @!attribute [rw] download_allowed
|
2586
2957
|
# Specifies whether the user can download files from the streaming
|
2587
2958
|
# session to the local device.
|
2588
2959
|
# @return [String]
|
2589
2960
|
#
|
2961
|
+
# @!attribute [rw] idle_disconnect_timeout_in_minutes
|
2962
|
+
# The amount of time that users can be idle (inactive) before they are
|
2963
|
+
# disconnected from their streaming session and the disconnect timeout
|
2964
|
+
# interval begins.
|
2965
|
+
# @return [Integer]
|
2966
|
+
#
|
2590
2967
|
# @!attribute [rw] paste_allowed
|
2591
2968
|
# Specifies whether the user can paste text from the local device to
|
2592
2969
|
# the streaming session.
|
@@ -2610,7 +2987,9 @@ module Aws::WorkSpacesWeb
|
|
2610
2987
|
class UpdateUserSettingsRequest < Struct.new(
|
2611
2988
|
:client_token,
|
2612
2989
|
:copy_allowed,
|
2990
|
+
:disconnect_timeout_in_minutes,
|
2613
2991
|
:download_allowed,
|
2992
|
+
:idle_disconnect_timeout_in_minutes,
|
2614
2993
|
:paste_allowed,
|
2615
2994
|
:print_allowed,
|
2616
2995
|
:upload_allowed,
|
@@ -2631,6 +3010,51 @@ module Aws::WorkSpacesWeb
|
|
2631
3010
|
include Aws::Structure
|
2632
3011
|
end
|
2633
3012
|
|
3013
|
+
# A user access logging settings resource that can be associated with a
|
3014
|
+
# web portal.
|
3015
|
+
#
|
3016
|
+
# @!attribute [rw] associated_portal_arns
|
3017
|
+
# A list of web portal ARNs that this user access logging settings is
|
3018
|
+
# associated with.
|
3019
|
+
# @return [Array<String>]
|
3020
|
+
#
|
3021
|
+
# @!attribute [rw] kinesis_stream_arn
|
3022
|
+
# The ARN of the Kinesis stream.
|
3023
|
+
# @return [String]
|
3024
|
+
#
|
3025
|
+
# @!attribute [rw] user_access_logging_settings_arn
|
3026
|
+
# The ARN of the user access logging settings.
|
3027
|
+
# @return [String]
|
3028
|
+
#
|
3029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UserAccessLoggingSettings AWS API Documentation
|
3030
|
+
#
|
3031
|
+
class UserAccessLoggingSettings < Struct.new(
|
3032
|
+
:associated_portal_arns,
|
3033
|
+
:kinesis_stream_arn,
|
3034
|
+
:user_access_logging_settings_arn)
|
3035
|
+
SENSITIVE = []
|
3036
|
+
include Aws::Structure
|
3037
|
+
end
|
3038
|
+
|
3039
|
+
# The summary of user access logging settings.
|
3040
|
+
#
|
3041
|
+
# @!attribute [rw] kinesis_stream_arn
|
3042
|
+
# The ARN of the Kinesis stream.
|
3043
|
+
# @return [String]
|
3044
|
+
#
|
3045
|
+
# @!attribute [rw] user_access_logging_settings_arn
|
3046
|
+
# The ARN of the user access logging settings.
|
3047
|
+
# @return [String]
|
3048
|
+
#
|
3049
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-web-2020-07-08/UserAccessLoggingSettingsSummary AWS API Documentation
|
3050
|
+
#
|
3051
|
+
class UserAccessLoggingSettingsSummary < Struct.new(
|
3052
|
+
:kinesis_stream_arn,
|
3053
|
+
:user_access_logging_settings_arn)
|
3054
|
+
SENSITIVE = []
|
3055
|
+
include Aws::Structure
|
3056
|
+
end
|
3057
|
+
|
2634
3058
|
# A user settings resource that can be associated with a web portal.
|
2635
3059
|
# Once associated with a web portal, user settings control how users can
|
2636
3060
|
# transfer data between a streaming session and the their local devices.
|
@@ -2645,11 +3069,22 @@ module Aws::WorkSpacesWeb
|
|
2645
3069
|
# to the local device.
|
2646
3070
|
# @return [String]
|
2647
3071
|
#
|
3072
|
+
# @!attribute [rw] disconnect_timeout_in_minutes
|
3073
|
+
# The amount of time that a streaming session remains active after
|
3074
|
+
# users disconnect.
|
3075
|
+
# @return [Integer]
|
3076
|
+
#
|
2648
3077
|
# @!attribute [rw] download_allowed
|
2649
3078
|
# Specifies whether the user can download files from the streaming
|
2650
3079
|
# session to the local device.
|
2651
3080
|
# @return [String]
|
2652
3081
|
#
|
3082
|
+
# @!attribute [rw] idle_disconnect_timeout_in_minutes
|
3083
|
+
# The amount of time that users can be idle (inactive) before they are
|
3084
|
+
# disconnected from their streaming session and the disconnect timeout
|
3085
|
+
# interval begins.
|
3086
|
+
# @return [Integer]
|
3087
|
+
#
|
2653
3088
|
# @!attribute [rw] paste_allowed
|
2654
3089
|
# Specifies whether the user can paste text from the local device to
|
2655
3090
|
# the streaming session.
|
@@ -2673,7 +3108,9 @@ module Aws::WorkSpacesWeb
|
|
2673
3108
|
class UserSettings < Struct.new(
|
2674
3109
|
:associated_portal_arns,
|
2675
3110
|
:copy_allowed,
|
3111
|
+
:disconnect_timeout_in_minutes,
|
2676
3112
|
:download_allowed,
|
3113
|
+
:idle_disconnect_timeout_in_minutes,
|
2677
3114
|
:paste_allowed,
|
2678
3115
|
:print_allowed,
|
2679
3116
|
:upload_allowed,
|
@@ -2689,11 +3126,22 @@ module Aws::WorkSpacesWeb
|
|
2689
3126
|
# to the local device.
|
2690
3127
|
# @return [String]
|
2691
3128
|
#
|
3129
|
+
# @!attribute [rw] disconnect_timeout_in_minutes
|
3130
|
+
# The amount of time that a streaming session remains active after
|
3131
|
+
# users disconnect.
|
3132
|
+
# @return [Integer]
|
3133
|
+
#
|
2692
3134
|
# @!attribute [rw] download_allowed
|
2693
3135
|
# Specifies whether the user can download files from the streaming
|
2694
3136
|
# session to the local device.
|
2695
3137
|
# @return [String]
|
2696
3138
|
#
|
3139
|
+
# @!attribute [rw] idle_disconnect_timeout_in_minutes
|
3140
|
+
# The amount of time that users can be idle (inactive) before they are
|
3141
|
+
# disconnected from their streaming session and the disconnect timeout
|
3142
|
+
# interval begins.
|
3143
|
+
# @return [Integer]
|
3144
|
+
#
|
2697
3145
|
# @!attribute [rw] paste_allowed
|
2698
3146
|
# Specifies whether the user can paste text from the local device to
|
2699
3147
|
# the streaming session.
|
@@ -2716,7 +3164,9 @@ module Aws::WorkSpacesWeb
|
|
2716
3164
|
#
|
2717
3165
|
class UserSettingsSummary < Struct.new(
|
2718
3166
|
:copy_allowed,
|
3167
|
+
:disconnect_timeout_in_minutes,
|
2719
3168
|
:download_allowed,
|
3169
|
+
:idle_disconnect_timeout_in_minutes,
|
2720
3170
|
:paste_allowed,
|
2721
3171
|
:print_allowed,
|
2722
3172
|
:upload_allowed,
|