aws-sdk-workspaces 1.71.0 → 1.73.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-workspaces/client.rb +51 -1
- data/lib/aws-sdk-workspaces/client_api.rb +36 -0
- data/lib/aws-sdk-workspaces/types.rb +131 -3
- data/lib/aws-sdk-workspaces.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 18dbc01b8846c69ab51b978f28008b6ab75f1408b2fa43caedc6c792471e217a
|
4
|
+
data.tar.gz: 7b4862fde8ede0153de1207832c334b014b80bc5fc1cbd0260229514206694d5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0baab19d532995e76dfe8848d983fe7e80c3351b0ef1cf1db93500663a6dd45ba681440024342835702328f2c44f45a43fa3ba1c184d768c9a6bfc4f7c989774
|
7
|
+
data.tar.gz: '005971e2d50c2ddd045dd340bccf03d3c6ce5bd2654e53daea432a215fe51f60874e6b69e14f0aac6551322cd4777545689c901e1a748eaaf7e27672e4f91f4a'
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.73.0 (2022-09-29)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release includes diagnostic log uploading feature. If it is enabled, the log files of WorkSpaces Windows client will be sent to Amazon WorkSpaces automatically for troubleshooting. You can use modifyClientProperty api to enable/disable this feature.
|
8
|
+
|
9
|
+
1.72.0 (2022-08-01)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release introduces ModifySamlProperties, a new API that allows control of SAML properties associated with a WorkSpaces directory. The DescribeWorkspaceDirectories API will now additionally return SAML properties in its responses.
|
13
|
+
|
4
14
|
1.71.0 (2022-07-27)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.73.0
|
@@ -1451,6 +1451,7 @@ module Aws::WorkSpaces
|
|
1451
1451
|
# resp.client_properties_list #=> Array
|
1452
1452
|
# resp.client_properties_list[0].resource_id #=> String
|
1453
1453
|
# resp.client_properties_list[0].client_properties.reconnect_enabled #=> String, one of "ENABLED", "DISABLED"
|
1454
|
+
# resp.client_properties_list[0].client_properties.log_upload_enabled #=> String, one of "ENABLED", "DISABLED"
|
1454
1455
|
#
|
1455
1456
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeClientProperties AWS API Documentation
|
1456
1457
|
#
|
@@ -1817,6 +1818,9 @@ module Aws::WorkSpaces
|
|
1817
1818
|
# resp.directories[0].selfservice_permissions.change_compute_type #=> String, one of "ENABLED", "DISABLED"
|
1818
1819
|
# resp.directories[0].selfservice_permissions.switch_running_mode #=> String, one of "ENABLED", "DISABLED"
|
1819
1820
|
# resp.directories[0].selfservice_permissions.rebuild_workspace #=> String, one of "ENABLED", "DISABLED"
|
1821
|
+
# resp.directories[0].saml_properties.status #=> String, one of "DISABLED", "ENABLED", "ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK"
|
1822
|
+
# resp.directories[0].saml_properties.user_access_url #=> String
|
1823
|
+
# resp.directories[0].saml_properties.relay_state_parameter_name #=> String
|
1820
1824
|
# resp.next_token #=> String
|
1821
1825
|
#
|
1822
1826
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectories AWS API Documentation
|
@@ -2549,6 +2553,7 @@ module Aws::WorkSpaces
|
|
2549
2553
|
# resource_id: "NonEmptyString", # required
|
2550
2554
|
# client_properties: { # required
|
2551
2555
|
# reconnect_enabled: "ENABLED", # accepts ENABLED, DISABLED
|
2556
|
+
# log_upload_enabled: "ENABLED", # accepts ENABLED, DISABLED
|
2552
2557
|
# },
|
2553
2558
|
# })
|
2554
2559
|
#
|
@@ -2561,6 +2566,51 @@ module Aws::WorkSpaces
|
|
2561
2566
|
req.send_request(options)
|
2562
2567
|
end
|
2563
2568
|
|
2569
|
+
# Modifies multiple properties related to SAML 2.0 authentication,
|
2570
|
+
# including the enablement status, user access URL, and relay state
|
2571
|
+
# parameter name that are used for configuring federation with an SAML
|
2572
|
+
# 2.0 identity provider.
|
2573
|
+
#
|
2574
|
+
# @option params [required, String] :resource_id
|
2575
|
+
# The directory identifier for which you want to configure SAML
|
2576
|
+
# properties.
|
2577
|
+
#
|
2578
|
+
# @option params [Types::SamlProperties] :saml_properties
|
2579
|
+
# The properties for configuring SAML 2.0 authentication.
|
2580
|
+
#
|
2581
|
+
# @option params [Array<String>] :properties_to_delete
|
2582
|
+
# The SAML properties to delete as part of your request.
|
2583
|
+
#
|
2584
|
+
# Specify one of the following options:
|
2585
|
+
#
|
2586
|
+
# * `SAML_PROPERTIES_USER_ACCESS_URL` to delete the user access URL.
|
2587
|
+
#
|
2588
|
+
# * `SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME` to delete the relay
|
2589
|
+
# state parameter name.
|
2590
|
+
#
|
2591
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2592
|
+
#
|
2593
|
+
# @example Request syntax with placeholder values
|
2594
|
+
#
|
2595
|
+
# resp = client.modify_saml_properties({
|
2596
|
+
# resource_id: "DirectoryId", # required
|
2597
|
+
# saml_properties: {
|
2598
|
+
# status: "DISABLED", # accepts DISABLED, ENABLED, ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK
|
2599
|
+
# user_access_url: "SamlUserAccessUrl",
|
2600
|
+
# relay_state_parameter_name: "NonEmptyString",
|
2601
|
+
# },
|
2602
|
+
# properties_to_delete: ["SAML_PROPERTIES_USER_ACCESS_URL"], # accepts SAML_PROPERTIES_USER_ACCESS_URL, SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME
|
2603
|
+
# })
|
2604
|
+
#
|
2605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySamlProperties AWS API Documentation
|
2606
|
+
#
|
2607
|
+
# @overload modify_saml_properties(params = {})
|
2608
|
+
# @param [Hash] params ({})
|
2609
|
+
def modify_saml_properties(params = {}, options = {})
|
2610
|
+
req = build_request(:modify_saml_properties, params)
|
2611
|
+
req.send_request(options)
|
2612
|
+
end
|
2613
|
+
|
2564
2614
|
# Modifies the self-service WorkSpace management capabilities for your
|
2565
2615
|
# users. For more information, see [Enable Self-Service WorkSpace
|
2566
2616
|
# Management Capabilities for Your Users][1].
|
@@ -3357,7 +3407,7 @@ module Aws::WorkSpaces
|
|
3357
3407
|
params: params,
|
3358
3408
|
config: config)
|
3359
3409
|
context[:gem_name] = 'aws-sdk-workspaces'
|
3360
|
-
context[:gem_version] = '1.
|
3410
|
+
context[:gem_version] = '1.73.0'
|
3361
3411
|
Seahorse::Client::Request.new(handlers, context)
|
3362
3412
|
end
|
3363
3413
|
|
@@ -91,6 +91,8 @@ module Aws::WorkSpaces
|
|
91
91
|
DefaultLogo = Shapes::BlobShape.new(name: 'DefaultLogo')
|
92
92
|
DefaultOu = Shapes::StringShape.new(name: 'DefaultOu')
|
93
93
|
DefaultWorkspaceCreationProperties = Shapes::StructureShape.new(name: 'DefaultWorkspaceCreationProperties')
|
94
|
+
DeletableSamlPropertiesList = Shapes::ListShape.new(name: 'DeletableSamlPropertiesList')
|
95
|
+
DeletableSamlProperty = Shapes::StringShape.new(name: 'DeletableSamlProperty')
|
94
96
|
DeleteClientBrandingRequest = Shapes::StructureShape.new(name: 'DeleteClientBrandingRequest')
|
95
97
|
DeleteClientBrandingResult = Shapes::StructureShape.new(name: 'DeleteClientBrandingResult')
|
96
98
|
DeleteConnectClientAddInRequest = Shapes::StructureShape.new(name: 'DeleteConnectClientAddInRequest')
|
@@ -188,6 +190,7 @@ module Aws::WorkSpaces
|
|
188
190
|
Limit = Shapes::IntegerShape.new(name: 'Limit')
|
189
191
|
ListAvailableManagementCidrRangesRequest = Shapes::StructureShape.new(name: 'ListAvailableManagementCidrRangesRequest')
|
190
192
|
ListAvailableManagementCidrRangesResult = Shapes::StructureShape.new(name: 'ListAvailableManagementCidrRangesResult')
|
193
|
+
LogUploadEnum = Shapes::StringShape.new(name: 'LogUploadEnum')
|
191
194
|
LoginMessage = Shapes::MapShape.new(name: 'LoginMessage')
|
192
195
|
ManagementCidrRangeConstraint = Shapes::StringShape.new(name: 'ManagementCidrRangeConstraint')
|
193
196
|
ManagementCidrRangeMaxResults = Shapes::IntegerShape.new(name: 'ManagementCidrRangeMaxResults')
|
@@ -201,6 +204,8 @@ module Aws::WorkSpaces
|
|
201
204
|
ModifyAccountResult = Shapes::StructureShape.new(name: 'ModifyAccountResult')
|
202
205
|
ModifyClientPropertiesRequest = Shapes::StructureShape.new(name: 'ModifyClientPropertiesRequest')
|
203
206
|
ModifyClientPropertiesResult = Shapes::StructureShape.new(name: 'ModifyClientPropertiesResult')
|
207
|
+
ModifySamlPropertiesRequest = Shapes::StructureShape.new(name: 'ModifySamlPropertiesRequest')
|
208
|
+
ModifySamlPropertiesResult = Shapes::StructureShape.new(name: 'ModifySamlPropertiesResult')
|
204
209
|
ModifySelfservicePermissionsRequest = Shapes::StructureShape.new(name: 'ModifySelfservicePermissionsRequest')
|
205
210
|
ModifySelfservicePermissionsResult = Shapes::StructureShape.new(name: 'ModifySelfservicePermissionsResult')
|
206
211
|
ModifyWorkspaceAccessPropertiesRequest = Shapes::StructureShape.new(name: 'ModifyWorkspaceAccessPropertiesRequest')
|
@@ -245,6 +250,9 @@ module Aws::WorkSpaces
|
|
245
250
|
RootVolumeSizeGib = Shapes::IntegerShape.new(name: 'RootVolumeSizeGib')
|
246
251
|
RunningMode = Shapes::StringShape.new(name: 'RunningMode')
|
247
252
|
RunningModeAutoStopTimeoutInMinutes = Shapes::IntegerShape.new(name: 'RunningModeAutoStopTimeoutInMinutes')
|
253
|
+
SamlProperties = Shapes::StructureShape.new(name: 'SamlProperties')
|
254
|
+
SamlStatusEnum = Shapes::StringShape.new(name: 'SamlStatusEnum')
|
255
|
+
SamlUserAccessUrl = Shapes::StringShape.new(name: 'SamlUserAccessUrl')
|
248
256
|
SecurityGroupId = Shapes::StringShape.new(name: 'SecurityGroupId')
|
249
257
|
SelfservicePermissions = Shapes::StructureShape.new(name: 'SelfservicePermissions')
|
250
258
|
Snapshot = Shapes::StructureShape.new(name: 'Snapshot')
|
@@ -363,6 +371,7 @@ module Aws::WorkSpaces
|
|
363
371
|
ClientDeviceTypeList.member = Shapes::ShapeRef.new(shape: ClientDeviceType)
|
364
372
|
|
365
373
|
ClientProperties.add_member(:reconnect_enabled, Shapes::ShapeRef.new(shape: ReconnectEnum, location_name: "ReconnectEnabled"))
|
374
|
+
ClientProperties.add_member(:log_upload_enabled, Shapes::ShapeRef.new(shape: LogUploadEnum, location_name: "LogUploadEnabled"))
|
366
375
|
ClientProperties.struct_class = Types::ClientProperties
|
367
376
|
|
368
377
|
ClientPropertiesList.member = Shapes::ShapeRef.new(shape: ClientPropertiesResult)
|
@@ -515,6 +524,8 @@ module Aws::WorkSpaces
|
|
515
524
|
DefaultWorkspaceCreationProperties.add_member(:enable_maintenance_mode, Shapes::ShapeRef.new(shape: BooleanObject, location_name: "EnableMaintenanceMode"))
|
516
525
|
DefaultWorkspaceCreationProperties.struct_class = Types::DefaultWorkspaceCreationProperties
|
517
526
|
|
527
|
+
DeletableSamlPropertiesList.member = Shapes::ShapeRef.new(shape: DeletableSamlProperty)
|
528
|
+
|
518
529
|
DeleteClientBrandingRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: DirectoryId, required: true, location_name: "ResourceId"))
|
519
530
|
DeleteClientBrandingRequest.add_member(:platforms, Shapes::ShapeRef.new(shape: ClientDeviceTypeList, required: true, location_name: "Platforms"))
|
520
531
|
DeleteClientBrandingRequest.struct_class = Types::DeleteClientBrandingRequest
|
@@ -841,6 +852,13 @@ module Aws::WorkSpaces
|
|
841
852
|
|
842
853
|
ModifyClientPropertiesResult.struct_class = Types::ModifyClientPropertiesResult
|
843
854
|
|
855
|
+
ModifySamlPropertiesRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: DirectoryId, required: true, location_name: "ResourceId"))
|
856
|
+
ModifySamlPropertiesRequest.add_member(:saml_properties, Shapes::ShapeRef.new(shape: SamlProperties, location_name: "SamlProperties"))
|
857
|
+
ModifySamlPropertiesRequest.add_member(:properties_to_delete, Shapes::ShapeRef.new(shape: DeletableSamlPropertiesList, location_name: "PropertiesToDelete"))
|
858
|
+
ModifySamlPropertiesRequest.struct_class = Types::ModifySamlPropertiesRequest
|
859
|
+
|
860
|
+
ModifySamlPropertiesResult.struct_class = Types::ModifySamlPropertiesResult
|
861
|
+
|
844
862
|
ModifySelfservicePermissionsRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: DirectoryId, required: true, location_name: "ResourceId"))
|
845
863
|
ModifySelfservicePermissionsRequest.add_member(:selfservice_permissions, Shapes::ShapeRef.new(shape: SelfservicePermissions, required: true, location_name: "SelfservicePermissions"))
|
846
864
|
ModifySelfservicePermissionsRequest.struct_class = Types::ModifySelfservicePermissionsRequest
|
@@ -949,6 +967,11 @@ module Aws::WorkSpaces
|
|
949
967
|
RootStorage.add_member(:capacity, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "Capacity"))
|
950
968
|
RootStorage.struct_class = Types::RootStorage
|
951
969
|
|
970
|
+
SamlProperties.add_member(:status, Shapes::ShapeRef.new(shape: SamlStatusEnum, location_name: "Status"))
|
971
|
+
SamlProperties.add_member(:user_access_url, Shapes::ShapeRef.new(shape: SamlUserAccessUrl, location_name: "UserAccessUrl"))
|
972
|
+
SamlProperties.add_member(:relay_state_parameter_name, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "RelayStateParameterName"))
|
973
|
+
SamlProperties.struct_class = Types::SamlProperties
|
974
|
+
|
952
975
|
SelfservicePermissions.add_member(:restart_workspace, Shapes::ShapeRef.new(shape: ReconnectEnum, location_name: "RestartWorkspace"))
|
953
976
|
SelfservicePermissions.add_member(:increase_volume_size, Shapes::ShapeRef.new(shape: ReconnectEnum, location_name: "IncreaseVolumeSize"))
|
954
977
|
SelfservicePermissions.add_member(:change_compute_type, Shapes::ShapeRef.new(shape: ReconnectEnum, location_name: "ChangeComputeType"))
|
@@ -1121,6 +1144,7 @@ module Aws::WorkSpaces
|
|
1121
1144
|
WorkspaceDirectory.add_member(:workspace_access_properties, Shapes::ShapeRef.new(shape: WorkspaceAccessProperties, location_name: "WorkspaceAccessProperties"))
|
1122
1145
|
WorkspaceDirectory.add_member(:tenancy, Shapes::ShapeRef.new(shape: Tenancy, location_name: "Tenancy"))
|
1123
1146
|
WorkspaceDirectory.add_member(:selfservice_permissions, Shapes::ShapeRef.new(shape: SelfservicePermissions, location_name: "SelfservicePermissions"))
|
1147
|
+
WorkspaceDirectory.add_member(:saml_properties, Shapes::ShapeRef.new(shape: SamlProperties, location_name: "SamlProperties"))
|
1124
1148
|
WorkspaceDirectory.struct_class = Types::WorkspaceDirectory
|
1125
1149
|
|
1126
1150
|
WorkspaceIdList.member = Shapes::ShapeRef.new(shape: WorkspaceId)
|
@@ -1723,6 +1747,18 @@ module Aws::WorkSpaces
|
|
1723
1747
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1724
1748
|
end)
|
1725
1749
|
|
1750
|
+
api.add_operation(:modify_saml_properties, Seahorse::Model::Operation.new.tap do |o|
|
1751
|
+
o.name = "ModifySamlProperties"
|
1752
|
+
o.http_method = "POST"
|
1753
|
+
o.http_request_uri = "/"
|
1754
|
+
o.input = Shapes::ShapeRef.new(shape: ModifySamlPropertiesRequest)
|
1755
|
+
o.output = Shapes::ShapeRef.new(shape: ModifySamlPropertiesResult)
|
1756
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1757
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValuesException)
|
1758
|
+
o.errors << Shapes::ShapeRef.new(shape: OperationNotSupportedException)
|
1759
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1760
|
+
end)
|
1761
|
+
|
1726
1762
|
api.add_operation(:modify_selfservice_permissions, Seahorse::Model::Operation.new.tap do |o|
|
1727
1763
|
o.name = "ModifySelfservicePermissions"
|
1728
1764
|
o.http_method = "POST"
|
@@ -177,6 +177,7 @@ module Aws::WorkSpaces
|
|
177
177
|
#
|
178
178
|
# {
|
179
179
|
# reconnect_enabled: "ENABLED", # accepts ENABLED, DISABLED
|
180
|
+
# log_upload_enabled: "ENABLED", # accepts ENABLED, DISABLED
|
180
181
|
# }
|
181
182
|
#
|
182
183
|
# @!attribute [rw] reconnect_enabled
|
@@ -185,10 +186,19 @@ module Aws::WorkSpaces
|
|
185
186
|
# their WorkSpaces without re-entering their credentials.
|
186
187
|
# @return [String]
|
187
188
|
#
|
189
|
+
# @!attribute [rw] log_upload_enabled
|
190
|
+
# Specifies whether users can upload diagnostic log files of Amazon
|
191
|
+
# WorkSpaces client directly to WorkSpaces to troubleshoot issues when
|
192
|
+
# using the WorkSpaces client. When enabled, the log files will be
|
193
|
+
# sent to WorkSpaces automatically and will be applied to all users in
|
194
|
+
# the specified directory.
|
195
|
+
# @return [String]
|
196
|
+
#
|
188
197
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ClientProperties AWS API Documentation
|
189
198
|
#
|
190
199
|
class ClientProperties < Struct.new(
|
191
|
-
:reconnect_enabled
|
200
|
+
:reconnect_enabled,
|
201
|
+
:log_upload_enabled)
|
192
202
|
SENSITIVE = []
|
193
203
|
include Aws::Structure
|
194
204
|
end
|
@@ -850,7 +860,8 @@ module Aws::WorkSpaces
|
|
850
860
|
# @return [Time]
|
851
861
|
#
|
852
862
|
# @!attribute [rw] owner_account_id
|
853
|
-
# The identifier of the
|
863
|
+
# The identifier of the Amazon Web Services account that owns the
|
864
|
+
# image.
|
854
865
|
# @return [String]
|
855
866
|
#
|
856
867
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaceImageResult AWS API Documentation
|
@@ -2912,6 +2923,7 @@ module Aws::WorkSpaces
|
|
2912
2923
|
# resource_id: "NonEmptyString", # required
|
2913
2924
|
# client_properties: { # required
|
2914
2925
|
# reconnect_enabled: "ENABLED", # accepts ENABLED, DISABLED
|
2926
|
+
# log_upload_enabled: "ENABLED", # accepts ENABLED, DISABLED
|
2915
2927
|
# },
|
2916
2928
|
# }
|
2917
2929
|
#
|
@@ -2936,6 +2948,53 @@ module Aws::WorkSpaces
|
|
2936
2948
|
#
|
2937
2949
|
class ModifyClientPropertiesResult < Aws::EmptyStructure; end
|
2938
2950
|
|
2951
|
+
# @note When making an API call, you may pass ModifySamlPropertiesRequest
|
2952
|
+
# data as a hash:
|
2953
|
+
#
|
2954
|
+
# {
|
2955
|
+
# resource_id: "DirectoryId", # required
|
2956
|
+
# saml_properties: {
|
2957
|
+
# status: "DISABLED", # accepts DISABLED, ENABLED, ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK
|
2958
|
+
# user_access_url: "SamlUserAccessUrl",
|
2959
|
+
# relay_state_parameter_name: "NonEmptyString",
|
2960
|
+
# },
|
2961
|
+
# properties_to_delete: ["SAML_PROPERTIES_USER_ACCESS_URL"], # accepts SAML_PROPERTIES_USER_ACCESS_URL, SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME
|
2962
|
+
# }
|
2963
|
+
#
|
2964
|
+
# @!attribute [rw] resource_id
|
2965
|
+
# The directory identifier for which you want to configure SAML
|
2966
|
+
# properties.
|
2967
|
+
# @return [String]
|
2968
|
+
#
|
2969
|
+
# @!attribute [rw] saml_properties
|
2970
|
+
# The properties for configuring SAML 2.0 authentication.
|
2971
|
+
# @return [Types::SamlProperties]
|
2972
|
+
#
|
2973
|
+
# @!attribute [rw] properties_to_delete
|
2974
|
+
# The SAML properties to delete as part of your request.
|
2975
|
+
#
|
2976
|
+
# Specify one of the following options:
|
2977
|
+
#
|
2978
|
+
# * `SAML_PROPERTIES_USER_ACCESS_URL` to delete the user access URL.
|
2979
|
+
#
|
2980
|
+
# * `SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME` to delete the relay
|
2981
|
+
# state parameter name.
|
2982
|
+
# @return [Array<String>]
|
2983
|
+
#
|
2984
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySamlPropertiesRequest AWS API Documentation
|
2985
|
+
#
|
2986
|
+
class ModifySamlPropertiesRequest < Struct.new(
|
2987
|
+
:resource_id,
|
2988
|
+
:saml_properties,
|
2989
|
+
:properties_to_delete)
|
2990
|
+
SENSITIVE = []
|
2991
|
+
include Aws::Structure
|
2992
|
+
end
|
2993
|
+
|
2994
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySamlPropertiesResult AWS API Documentation
|
2995
|
+
#
|
2996
|
+
class ModifySamlPropertiesResult < Aws::EmptyStructure; end
|
2997
|
+
|
2939
2998
|
# @note When making an API call, you may pass ModifySelfservicePermissionsRequest
|
2940
2999
|
# data as a hash:
|
2941
3000
|
#
|
@@ -3515,6 +3574,68 @@ module Aws::WorkSpaces
|
|
3515
3574
|
include Aws::Structure
|
3516
3575
|
end
|
3517
3576
|
|
3577
|
+
# Describes the enablement status, user access URL, and relay state
|
3578
|
+
# parameter name that are used for configuring federation with an SAML
|
3579
|
+
# 2.0 identity provider.
|
3580
|
+
#
|
3581
|
+
# @note When making an API call, you may pass SamlProperties
|
3582
|
+
# data as a hash:
|
3583
|
+
#
|
3584
|
+
# {
|
3585
|
+
# status: "DISABLED", # accepts DISABLED, ENABLED, ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK
|
3586
|
+
# user_access_url: "SamlUserAccessUrl",
|
3587
|
+
# relay_state_parameter_name: "NonEmptyString",
|
3588
|
+
# }
|
3589
|
+
#
|
3590
|
+
# @!attribute [rw] status
|
3591
|
+
# Indicates the status of SAML 2.0 authentication. These statuses
|
3592
|
+
# include the following.
|
3593
|
+
#
|
3594
|
+
# * If the setting is `DISABLED`, end users will be directed to login
|
3595
|
+
# with their directory credentials.
|
3596
|
+
#
|
3597
|
+
# * If the setting is `ENABLED`, end users will be directed to login
|
3598
|
+
# via the user access URL. Users attempting to connect to WorkSpaces
|
3599
|
+
# from a client application that does not support SAML 2.0
|
3600
|
+
# authentication will not be able to connect.
|
3601
|
+
#
|
3602
|
+
# * If the setting is `ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK`, end
|
3603
|
+
# users will be directed to login via the user access URL on
|
3604
|
+
# supported client applications, but will not prevent clients that
|
3605
|
+
# do not support SAML 2.0 authentication from connecting as if SAML
|
3606
|
+
# 2.0 authentication was disabled.
|
3607
|
+
# @return [String]
|
3608
|
+
#
|
3609
|
+
# @!attribute [rw] user_access_url
|
3610
|
+
# The SAML 2.0 identity provider (IdP) user access URL is the URL a
|
3611
|
+
# user would navigate to in their web browser in order to federate
|
3612
|
+
# from the IdP and directly access the application, without any SAML
|
3613
|
+
# 2.0 service provider (SP) bindings.
|
3614
|
+
# @return [String]
|
3615
|
+
#
|
3616
|
+
# @!attribute [rw] relay_state_parameter_name
|
3617
|
+
# The relay state parameter name supported by the SAML 2.0 identity
|
3618
|
+
# provider (IdP). When the end user is redirected to the user access
|
3619
|
+
# URL from the WorkSpaces client application, this relay state
|
3620
|
+
# parameter name is appended as a query parameter to the URL along
|
3621
|
+
# with the relay state endpoint to return the user to the client
|
3622
|
+
# application session.
|
3623
|
+
#
|
3624
|
+
# To use SAML 2.0 authentication with WorkSpaces, the IdP must support
|
3625
|
+
# IdP-initiated deep linking for the relay state URL. Consult your IdP
|
3626
|
+
# documentation for more information.
|
3627
|
+
# @return [String]
|
3628
|
+
#
|
3629
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/SamlProperties AWS API Documentation
|
3630
|
+
#
|
3631
|
+
class SamlProperties < Struct.new(
|
3632
|
+
:status,
|
3633
|
+
:user_access_url,
|
3634
|
+
:relay_state_parameter_name)
|
3635
|
+
SENSITIVE = []
|
3636
|
+
include Aws::Structure
|
3637
|
+
end
|
3638
|
+
|
3518
3639
|
# Describes the self-service permissions for a directory. For more
|
3519
3640
|
# information, see [Enable Self-Service WorkSpace Management
|
3520
3641
|
# Capabilities for Your Users][1].
|
@@ -4510,6 +4631,12 @@ module Aws::WorkSpaces
|
|
4510
4631
|
# directory.
|
4511
4632
|
# @return [Types::SelfservicePermissions]
|
4512
4633
|
#
|
4634
|
+
# @!attribute [rw] saml_properties
|
4635
|
+
# Describes the enablement status, user access URL, and relay state
|
4636
|
+
# parameter name that are used for configuring federation with an SAML
|
4637
|
+
# 2.0 identity provider.
|
4638
|
+
# @return [Types::SamlProperties]
|
4639
|
+
#
|
4513
4640
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceDirectory AWS API Documentation
|
4514
4641
|
#
|
4515
4642
|
class WorkspaceDirectory < Struct.new(
|
@@ -4528,7 +4655,8 @@ module Aws::WorkSpaces
|
|
4528
4655
|
:ip_group_ids,
|
4529
4656
|
:workspace_access_properties,
|
4530
4657
|
:tenancy,
|
4531
|
-
:selfservice_permissions
|
4658
|
+
:selfservice_permissions,
|
4659
|
+
:saml_properties)
|
4532
4660
|
SENSITIVE = []
|
4533
4661
|
include Aws::Structure
|
4534
4662
|
end
|
data/lib/aws-sdk-workspaces.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-workspaces
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.73.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-09-29 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|