aws-sdk-workspaces 1.69.0 → 1.72.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-workspaces/client.rb +110 -1
- data/lib/aws-sdk-workspaces/client_api.rb +68 -0
- data/lib/aws-sdk-workspaces/types.rb +232 -6
- 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: 2c91c7db4285863209bd00670cc0fd06d75166350bfb09ff4fc2c541f7e060b3
|
4
|
+
data.tar.gz: 4844ade3c37b6fbaf184a5268bdabb2fb2dea0cec1dcaf44f9c44a0f9fe6d4b2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2a7b0339c0538fa6ac5533054e4e2496807c11b51ead7aed9e55c62895fbcae5c8ba858e2f7af291c062f5bb5e9f83049d8876ca3201ff2fe9fecbb984876954
|
7
|
+
data.tar.gz: c94915077d8b24ae8086291a670967de543c63d0bbdb8393bd39ba3052a7f0d50de10d825275eaf49f3fa1c7f2ef7520f95a1f794d94c513e123ce036b54936e
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.72.0 (2022-08-01)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* 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.
|
8
|
+
|
9
|
+
1.71.0 (2022-07-27)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Added CreateWorkspaceImage API to create a new WorkSpace image from an existing WorkSpace.
|
13
|
+
|
14
|
+
1.70.0 (2022-07-19)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Increased the character limit of the login message from 850 to 2000 characters.
|
18
|
+
|
4
19
|
1.69.0 (2022-06-15)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.72.0
|
@@ -881,6 +881,67 @@ module Aws::WorkSpaces
|
|
881
881
|
req.send_request(options)
|
882
882
|
end
|
883
883
|
|
884
|
+
# Creates a new WorkSpace image from an existing WorkSpace.
|
885
|
+
#
|
886
|
+
# @option params [required, String] :name
|
887
|
+
# The name of the new WorkSpace image.
|
888
|
+
#
|
889
|
+
# @option params [required, String] :description
|
890
|
+
# The description of the new WorkSpace image.
|
891
|
+
#
|
892
|
+
# @option params [required, String] :workspace_id
|
893
|
+
# The identifier of the source WorkSpace
|
894
|
+
#
|
895
|
+
# @option params [Array<Types::Tag>] :tags
|
896
|
+
# The tags that you want to add to the new WorkSpace image. To add tags
|
897
|
+
# when you're creating the image, you must create an IAM policy that
|
898
|
+
# grants your IAM user permission to use `workspaces:CreateTags`.
|
899
|
+
#
|
900
|
+
# @return [Types::CreateWorkspaceImageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
901
|
+
#
|
902
|
+
# * {Types::CreateWorkspaceImageResult#image_id #image_id} => String
|
903
|
+
# * {Types::CreateWorkspaceImageResult#name #name} => String
|
904
|
+
# * {Types::CreateWorkspaceImageResult#description #description} => String
|
905
|
+
# * {Types::CreateWorkspaceImageResult#operating_system #operating_system} => Types::OperatingSystem
|
906
|
+
# * {Types::CreateWorkspaceImageResult#state #state} => String
|
907
|
+
# * {Types::CreateWorkspaceImageResult#required_tenancy #required_tenancy} => String
|
908
|
+
# * {Types::CreateWorkspaceImageResult#created #created} => Time
|
909
|
+
# * {Types::CreateWorkspaceImageResult#owner_account_id #owner_account_id} => String
|
910
|
+
#
|
911
|
+
# @example Request syntax with placeholder values
|
912
|
+
#
|
913
|
+
# resp = client.create_workspace_image({
|
914
|
+
# name: "WorkspaceImageName", # required
|
915
|
+
# description: "WorkspaceImageDescription", # required
|
916
|
+
# workspace_id: "WorkspaceId", # required
|
917
|
+
# tags: [
|
918
|
+
# {
|
919
|
+
# key: "TagKey", # required
|
920
|
+
# value: "TagValue",
|
921
|
+
# },
|
922
|
+
# ],
|
923
|
+
# })
|
924
|
+
#
|
925
|
+
# @example Response structure
|
926
|
+
#
|
927
|
+
# resp.image_id #=> String
|
928
|
+
# resp.name #=> String
|
929
|
+
# resp.description #=> String
|
930
|
+
# resp.operating_system.type #=> String, one of "WINDOWS", "LINUX"
|
931
|
+
# resp.state #=> String, one of "AVAILABLE", "PENDING", "ERROR"
|
932
|
+
# resp.required_tenancy #=> String, one of "DEFAULT", "DEDICATED"
|
933
|
+
# resp.created #=> Time
|
934
|
+
# resp.owner_account_id #=> String
|
935
|
+
#
|
936
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaceImage AWS API Documentation
|
937
|
+
#
|
938
|
+
# @overload create_workspace_image(params = {})
|
939
|
+
# @param [Hash] params ({})
|
940
|
+
def create_workspace_image(params = {}, options = {})
|
941
|
+
req = build_request(:create_workspace_image, params)
|
942
|
+
req.send_request(options)
|
943
|
+
end
|
944
|
+
|
884
945
|
# Creates one or more WorkSpaces.
|
885
946
|
#
|
886
947
|
# This operation is asynchronous and returns before the WorkSpaces are
|
@@ -1756,6 +1817,9 @@ module Aws::WorkSpaces
|
|
1756
1817
|
# resp.directories[0].selfservice_permissions.change_compute_type #=> String, one of "ENABLED", "DISABLED"
|
1757
1818
|
# resp.directories[0].selfservice_permissions.switch_running_mode #=> String, one of "ENABLED", "DISABLED"
|
1758
1819
|
# resp.directories[0].selfservice_permissions.rebuild_workspace #=> String, one of "ENABLED", "DISABLED"
|
1820
|
+
# resp.directories[0].saml_properties.status #=> String, one of "DISABLED", "ENABLED", "ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK"
|
1821
|
+
# resp.directories[0].saml_properties.user_access_url #=> String
|
1822
|
+
# resp.directories[0].saml_properties.relay_state_parameter_name #=> String
|
1759
1823
|
# resp.next_token #=> String
|
1760
1824
|
#
|
1761
1825
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectories AWS API Documentation
|
@@ -2500,6 +2564,51 @@ module Aws::WorkSpaces
|
|
2500
2564
|
req.send_request(options)
|
2501
2565
|
end
|
2502
2566
|
|
2567
|
+
# Modifies multiple properties related to SAML 2.0 authentication,
|
2568
|
+
# including the enablement status, user access URL, and relay state
|
2569
|
+
# parameter name that are used for configuring federation with an SAML
|
2570
|
+
# 2.0 identity provider.
|
2571
|
+
#
|
2572
|
+
# @option params [required, String] :resource_id
|
2573
|
+
# The directory identifier for which you want to configure SAML
|
2574
|
+
# properties.
|
2575
|
+
#
|
2576
|
+
# @option params [Types::SamlProperties] :saml_properties
|
2577
|
+
# The properties for configuring SAML 2.0 authentication.
|
2578
|
+
#
|
2579
|
+
# @option params [Array<String>] :properties_to_delete
|
2580
|
+
# The SAML properties to delete as part of your request.
|
2581
|
+
#
|
2582
|
+
# Specify one of the following options:
|
2583
|
+
#
|
2584
|
+
# * `SAML_PROPERTIES_USER_ACCESS_URL` to delete the user access URL.
|
2585
|
+
#
|
2586
|
+
# * `SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME` to delete the relay
|
2587
|
+
# state parameter name.
|
2588
|
+
#
|
2589
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2590
|
+
#
|
2591
|
+
# @example Request syntax with placeholder values
|
2592
|
+
#
|
2593
|
+
# resp = client.modify_saml_properties({
|
2594
|
+
# resource_id: "DirectoryId", # required
|
2595
|
+
# saml_properties: {
|
2596
|
+
# status: "DISABLED", # accepts DISABLED, ENABLED, ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK
|
2597
|
+
# user_access_url: "SamlUserAccessUrl",
|
2598
|
+
# relay_state_parameter_name: "NonEmptyString",
|
2599
|
+
# },
|
2600
|
+
# properties_to_delete: ["SAML_PROPERTIES_USER_ACCESS_URL"], # accepts SAML_PROPERTIES_USER_ACCESS_URL, SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME
|
2601
|
+
# })
|
2602
|
+
#
|
2603
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySamlProperties AWS API Documentation
|
2604
|
+
#
|
2605
|
+
# @overload modify_saml_properties(params = {})
|
2606
|
+
# @param [Hash] params ({})
|
2607
|
+
def modify_saml_properties(params = {}, options = {})
|
2608
|
+
req = build_request(:modify_saml_properties, params)
|
2609
|
+
req.send_request(options)
|
2610
|
+
end
|
2611
|
+
|
2503
2612
|
# Modifies the self-service WorkSpace management capabilities for your
|
2504
2613
|
# users. For more information, see [Enable Self-Service WorkSpace
|
2505
2614
|
# Management Capabilities for Your Users][1].
|
@@ -3296,7 +3405,7 @@ module Aws::WorkSpaces
|
|
3296
3405
|
params: params,
|
3297
3406
|
config: config)
|
3298
3407
|
context[:gem_name] = 'aws-sdk-workspaces'
|
3299
|
-
context[:gem_version] = '1.
|
3408
|
+
context[:gem_version] = '1.72.0'
|
3300
3409
|
Seahorse::Client::Request.new(handlers, context)
|
3301
3410
|
end
|
3302
3411
|
|
@@ -77,6 +77,8 @@ module Aws::WorkSpaces
|
|
77
77
|
CreateUpdatedWorkspaceImageResult = Shapes::StructureShape.new(name: 'CreateUpdatedWorkspaceImageResult')
|
78
78
|
CreateWorkspaceBundleRequest = Shapes::StructureShape.new(name: 'CreateWorkspaceBundleRequest')
|
79
79
|
CreateWorkspaceBundleResult = Shapes::StructureShape.new(name: 'CreateWorkspaceBundleResult')
|
80
|
+
CreateWorkspaceImageRequest = Shapes::StructureShape.new(name: 'CreateWorkspaceImageRequest')
|
81
|
+
CreateWorkspaceImageResult = Shapes::StructureShape.new(name: 'CreateWorkspaceImageResult')
|
80
82
|
CreateWorkspacesRequest = Shapes::StructureShape.new(name: 'CreateWorkspacesRequest')
|
81
83
|
CreateWorkspacesResult = Shapes::StructureShape.new(name: 'CreateWorkspacesResult')
|
82
84
|
DedicatedTenancyCidrRangeList = Shapes::ListShape.new(name: 'DedicatedTenancyCidrRangeList')
|
@@ -89,6 +91,8 @@ module Aws::WorkSpaces
|
|
89
91
|
DefaultLogo = Shapes::BlobShape.new(name: 'DefaultLogo')
|
90
92
|
DefaultOu = Shapes::StringShape.new(name: 'DefaultOu')
|
91
93
|
DefaultWorkspaceCreationProperties = Shapes::StructureShape.new(name: 'DefaultWorkspaceCreationProperties')
|
94
|
+
DeletableSamlPropertiesList = Shapes::ListShape.new(name: 'DeletableSamlPropertiesList')
|
95
|
+
DeletableSamlProperty = Shapes::StringShape.new(name: 'DeletableSamlProperty')
|
92
96
|
DeleteClientBrandingRequest = Shapes::StructureShape.new(name: 'DeleteClientBrandingRequest')
|
93
97
|
DeleteClientBrandingResult = Shapes::StructureShape.new(name: 'DeleteClientBrandingResult')
|
94
98
|
DeleteConnectClientAddInRequest = Shapes::StructureShape.new(name: 'DeleteConnectClientAddInRequest')
|
@@ -199,6 +203,8 @@ module Aws::WorkSpaces
|
|
199
203
|
ModifyAccountResult = Shapes::StructureShape.new(name: 'ModifyAccountResult')
|
200
204
|
ModifyClientPropertiesRequest = Shapes::StructureShape.new(name: 'ModifyClientPropertiesRequest')
|
201
205
|
ModifyClientPropertiesResult = Shapes::StructureShape.new(name: 'ModifyClientPropertiesResult')
|
206
|
+
ModifySamlPropertiesRequest = Shapes::StructureShape.new(name: 'ModifySamlPropertiesRequest')
|
207
|
+
ModifySamlPropertiesResult = Shapes::StructureShape.new(name: 'ModifySamlPropertiesResult')
|
202
208
|
ModifySelfservicePermissionsRequest = Shapes::StructureShape.new(name: 'ModifySelfservicePermissionsRequest')
|
203
209
|
ModifySelfservicePermissionsResult = Shapes::StructureShape.new(name: 'ModifySelfservicePermissionsResult')
|
204
210
|
ModifyWorkspaceAccessPropertiesRequest = Shapes::StructureShape.new(name: 'ModifyWorkspaceAccessPropertiesRequest')
|
@@ -243,6 +249,9 @@ module Aws::WorkSpaces
|
|
243
249
|
RootVolumeSizeGib = Shapes::IntegerShape.new(name: 'RootVolumeSizeGib')
|
244
250
|
RunningMode = Shapes::StringShape.new(name: 'RunningMode')
|
245
251
|
RunningModeAutoStopTimeoutInMinutes = Shapes::IntegerShape.new(name: 'RunningModeAutoStopTimeoutInMinutes')
|
252
|
+
SamlProperties = Shapes::StructureShape.new(name: 'SamlProperties')
|
253
|
+
SamlStatusEnum = Shapes::StringShape.new(name: 'SamlStatusEnum')
|
254
|
+
SamlUserAccessUrl = Shapes::StringShape.new(name: 'SamlUserAccessUrl')
|
246
255
|
SecurityGroupId = Shapes::StringShape.new(name: 'SecurityGroupId')
|
247
256
|
SelfservicePermissions = Shapes::StructureShape.new(name: 'SelfservicePermissions')
|
248
257
|
Snapshot = Shapes::StructureShape.new(name: 'Snapshot')
|
@@ -466,6 +475,22 @@ module Aws::WorkSpaces
|
|
466
475
|
CreateWorkspaceBundleResult.add_member(:workspace_bundle, Shapes::ShapeRef.new(shape: WorkspaceBundle, location_name: "WorkspaceBundle"))
|
467
476
|
CreateWorkspaceBundleResult.struct_class = Types::CreateWorkspaceBundleResult
|
468
477
|
|
478
|
+
CreateWorkspaceImageRequest.add_member(:name, Shapes::ShapeRef.new(shape: WorkspaceImageName, required: true, location_name: "Name"))
|
479
|
+
CreateWorkspaceImageRequest.add_member(:description, Shapes::ShapeRef.new(shape: WorkspaceImageDescription, required: true, location_name: "Description"))
|
480
|
+
CreateWorkspaceImageRequest.add_member(:workspace_id, Shapes::ShapeRef.new(shape: WorkspaceId, required: true, location_name: "WorkspaceId"))
|
481
|
+
CreateWorkspaceImageRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
482
|
+
CreateWorkspaceImageRequest.struct_class = Types::CreateWorkspaceImageRequest
|
483
|
+
|
484
|
+
CreateWorkspaceImageResult.add_member(:image_id, Shapes::ShapeRef.new(shape: WorkspaceImageId, location_name: "ImageId"))
|
485
|
+
CreateWorkspaceImageResult.add_member(:name, Shapes::ShapeRef.new(shape: WorkspaceImageName, location_name: "Name"))
|
486
|
+
CreateWorkspaceImageResult.add_member(:description, Shapes::ShapeRef.new(shape: WorkspaceImageDescription, location_name: "Description"))
|
487
|
+
CreateWorkspaceImageResult.add_member(:operating_system, Shapes::ShapeRef.new(shape: OperatingSystem, location_name: "OperatingSystem"))
|
488
|
+
CreateWorkspaceImageResult.add_member(:state, Shapes::ShapeRef.new(shape: WorkspaceImageState, location_name: "State"))
|
489
|
+
CreateWorkspaceImageResult.add_member(:required_tenancy, Shapes::ShapeRef.new(shape: WorkspaceImageRequiredTenancy, location_name: "RequiredTenancy"))
|
490
|
+
CreateWorkspaceImageResult.add_member(:created, Shapes::ShapeRef.new(shape: Timestamp, location_name: "Created"))
|
491
|
+
CreateWorkspaceImageResult.add_member(:owner_account_id, Shapes::ShapeRef.new(shape: AwsAccount, location_name: "OwnerAccountId"))
|
492
|
+
CreateWorkspaceImageResult.struct_class = Types::CreateWorkspaceImageResult
|
493
|
+
|
469
494
|
CreateWorkspacesRequest.add_member(:workspaces, Shapes::ShapeRef.new(shape: WorkspaceRequestList, required: true, location_name: "Workspaces"))
|
470
495
|
CreateWorkspacesRequest.struct_class = Types::CreateWorkspacesRequest
|
471
496
|
|
@@ -497,6 +522,8 @@ module Aws::WorkSpaces
|
|
497
522
|
DefaultWorkspaceCreationProperties.add_member(:enable_maintenance_mode, Shapes::ShapeRef.new(shape: BooleanObject, location_name: "EnableMaintenanceMode"))
|
498
523
|
DefaultWorkspaceCreationProperties.struct_class = Types::DefaultWorkspaceCreationProperties
|
499
524
|
|
525
|
+
DeletableSamlPropertiesList.member = Shapes::ShapeRef.new(shape: DeletableSamlProperty)
|
526
|
+
|
500
527
|
DeleteClientBrandingRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: DirectoryId, required: true, location_name: "ResourceId"))
|
501
528
|
DeleteClientBrandingRequest.add_member(:platforms, Shapes::ShapeRef.new(shape: ClientDeviceTypeList, required: true, location_name: "Platforms"))
|
502
529
|
DeleteClientBrandingRequest.struct_class = Types::DeleteClientBrandingRequest
|
@@ -823,6 +850,13 @@ module Aws::WorkSpaces
|
|
823
850
|
|
824
851
|
ModifyClientPropertiesResult.struct_class = Types::ModifyClientPropertiesResult
|
825
852
|
|
853
|
+
ModifySamlPropertiesRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: DirectoryId, required: true, location_name: "ResourceId"))
|
854
|
+
ModifySamlPropertiesRequest.add_member(:saml_properties, Shapes::ShapeRef.new(shape: SamlProperties, location_name: "SamlProperties"))
|
855
|
+
ModifySamlPropertiesRequest.add_member(:properties_to_delete, Shapes::ShapeRef.new(shape: DeletableSamlPropertiesList, location_name: "PropertiesToDelete"))
|
856
|
+
ModifySamlPropertiesRequest.struct_class = Types::ModifySamlPropertiesRequest
|
857
|
+
|
858
|
+
ModifySamlPropertiesResult.struct_class = Types::ModifySamlPropertiesResult
|
859
|
+
|
826
860
|
ModifySelfservicePermissionsRequest.add_member(:resource_id, Shapes::ShapeRef.new(shape: DirectoryId, required: true, location_name: "ResourceId"))
|
827
861
|
ModifySelfservicePermissionsRequest.add_member(:selfservice_permissions, Shapes::ShapeRef.new(shape: SelfservicePermissions, required: true, location_name: "SelfservicePermissions"))
|
828
862
|
ModifySelfservicePermissionsRequest.struct_class = Types::ModifySelfservicePermissionsRequest
|
@@ -931,6 +965,11 @@ module Aws::WorkSpaces
|
|
931
965
|
RootStorage.add_member(:capacity, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "Capacity"))
|
932
966
|
RootStorage.struct_class = Types::RootStorage
|
933
967
|
|
968
|
+
SamlProperties.add_member(:status, Shapes::ShapeRef.new(shape: SamlStatusEnum, location_name: "Status"))
|
969
|
+
SamlProperties.add_member(:user_access_url, Shapes::ShapeRef.new(shape: SamlUserAccessUrl, location_name: "UserAccessUrl"))
|
970
|
+
SamlProperties.add_member(:relay_state_parameter_name, Shapes::ShapeRef.new(shape: NonEmptyString, location_name: "RelayStateParameterName"))
|
971
|
+
SamlProperties.struct_class = Types::SamlProperties
|
972
|
+
|
934
973
|
SelfservicePermissions.add_member(:restart_workspace, Shapes::ShapeRef.new(shape: ReconnectEnum, location_name: "RestartWorkspace"))
|
935
974
|
SelfservicePermissions.add_member(:increase_volume_size, Shapes::ShapeRef.new(shape: ReconnectEnum, location_name: "IncreaseVolumeSize"))
|
936
975
|
SelfservicePermissions.add_member(:change_compute_type, Shapes::ShapeRef.new(shape: ReconnectEnum, location_name: "ChangeComputeType"))
|
@@ -1103,6 +1142,7 @@ module Aws::WorkSpaces
|
|
1103
1142
|
WorkspaceDirectory.add_member(:workspace_access_properties, Shapes::ShapeRef.new(shape: WorkspaceAccessProperties, location_name: "WorkspaceAccessProperties"))
|
1104
1143
|
WorkspaceDirectory.add_member(:tenancy, Shapes::ShapeRef.new(shape: Tenancy, location_name: "Tenancy"))
|
1105
1144
|
WorkspaceDirectory.add_member(:selfservice_permissions, Shapes::ShapeRef.new(shape: SelfservicePermissions, location_name: "SelfservicePermissions"))
|
1145
|
+
WorkspaceDirectory.add_member(:saml_properties, Shapes::ShapeRef.new(shape: SamlProperties, location_name: "SamlProperties"))
|
1106
1146
|
WorkspaceDirectory.struct_class = Types::WorkspaceDirectory
|
1107
1147
|
|
1108
1148
|
WorkspaceIdList.member = Shapes::ShapeRef.new(shape: WorkspaceId)
|
@@ -1310,6 +1350,21 @@ module Aws::WorkSpaces
|
|
1310
1350
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1311
1351
|
end)
|
1312
1352
|
|
1353
|
+
api.add_operation(:create_workspace_image, Seahorse::Model::Operation.new.tap do |o|
|
1354
|
+
o.name = "CreateWorkspaceImage"
|
1355
|
+
o.http_method = "POST"
|
1356
|
+
o.http_request_uri = "/"
|
1357
|
+
o.input = Shapes::ShapeRef.new(shape: CreateWorkspaceImageRequest)
|
1358
|
+
o.output = Shapes::ShapeRef.new(shape: CreateWorkspaceImageResult)
|
1359
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceLimitExceededException)
|
1360
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceAlreadyExistsException)
|
1361
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1362
|
+
o.errors << Shapes::ShapeRef.new(shape: OperationNotSupportedException)
|
1363
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidResourceStateException)
|
1364
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1365
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValuesException)
|
1366
|
+
end)
|
1367
|
+
|
1313
1368
|
api.add_operation(:create_workspaces, Seahorse::Model::Operation.new.tap do |o|
|
1314
1369
|
o.name = "CreateWorkspaces"
|
1315
1370
|
o.http_method = "POST"
|
@@ -1624,6 +1679,7 @@ module Aws::WorkSpaces
|
|
1624
1679
|
o.output = Shapes::ShapeRef.new(shape: ImportClientBrandingResult)
|
1625
1680
|
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValuesException)
|
1626
1681
|
o.errors << Shapes::ShapeRef.new(shape: ResourceLimitExceededException)
|
1682
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1627
1683
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1628
1684
|
end)
|
1629
1685
|
|
@@ -1689,6 +1745,18 @@ module Aws::WorkSpaces
|
|
1689
1745
|
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1690
1746
|
end)
|
1691
1747
|
|
1748
|
+
api.add_operation(:modify_saml_properties, Seahorse::Model::Operation.new.tap do |o|
|
1749
|
+
o.name = "ModifySamlProperties"
|
1750
|
+
o.http_method = "POST"
|
1751
|
+
o.http_request_uri = "/"
|
1752
|
+
o.input = Shapes::ShapeRef.new(shape: ModifySamlPropertiesRequest)
|
1753
|
+
o.output = Shapes::ShapeRef.new(shape: ModifySamlPropertiesResult)
|
1754
|
+
o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
|
1755
|
+
o.errors << Shapes::ShapeRef.new(shape: InvalidParameterValuesException)
|
1756
|
+
o.errors << Shapes::ShapeRef.new(shape: OperationNotSupportedException)
|
1757
|
+
o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
|
1758
|
+
end)
|
1759
|
+
|
1692
1760
|
api.add_operation(:modify_selfservice_permissions, Seahorse::Model::Operation.new.tap do |o|
|
1693
1761
|
o.name = "ModifySelfservicePermissions"
|
1694
1762
|
o.http_method = "POST"
|
@@ -770,6 +770,104 @@ module Aws::WorkSpaces
|
|
770
770
|
include Aws::Structure
|
771
771
|
end
|
772
772
|
|
773
|
+
# @note When making an API call, you may pass CreateWorkspaceImageRequest
|
774
|
+
# data as a hash:
|
775
|
+
#
|
776
|
+
# {
|
777
|
+
# name: "WorkspaceImageName", # required
|
778
|
+
# description: "WorkspaceImageDescription", # required
|
779
|
+
# workspace_id: "WorkspaceId", # required
|
780
|
+
# tags: [
|
781
|
+
# {
|
782
|
+
# key: "TagKey", # required
|
783
|
+
# value: "TagValue",
|
784
|
+
# },
|
785
|
+
# ],
|
786
|
+
# }
|
787
|
+
#
|
788
|
+
# @!attribute [rw] name
|
789
|
+
# The name of the new WorkSpace image.
|
790
|
+
# @return [String]
|
791
|
+
#
|
792
|
+
# @!attribute [rw] description
|
793
|
+
# The description of the new WorkSpace image.
|
794
|
+
# @return [String]
|
795
|
+
#
|
796
|
+
# @!attribute [rw] workspace_id
|
797
|
+
# The identifier of the source WorkSpace
|
798
|
+
# @return [String]
|
799
|
+
#
|
800
|
+
# @!attribute [rw] tags
|
801
|
+
# The tags that you want to add to the new WorkSpace image. To add
|
802
|
+
# tags when you're creating the image, you must create an IAM policy
|
803
|
+
# that grants your IAM user permission to use `workspaces:CreateTags`.
|
804
|
+
# @return [Array<Types::Tag>]
|
805
|
+
#
|
806
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaceImageRequest AWS API Documentation
|
807
|
+
#
|
808
|
+
class CreateWorkspaceImageRequest < Struct.new(
|
809
|
+
:name,
|
810
|
+
:description,
|
811
|
+
:workspace_id,
|
812
|
+
:tags)
|
813
|
+
SENSITIVE = []
|
814
|
+
include Aws::Structure
|
815
|
+
end
|
816
|
+
|
817
|
+
# @!attribute [rw] image_id
|
818
|
+
# The identifier of the new WorkSpace image.
|
819
|
+
# @return [String]
|
820
|
+
#
|
821
|
+
# @!attribute [rw] name
|
822
|
+
# The name of the image.
|
823
|
+
# @return [String]
|
824
|
+
#
|
825
|
+
# @!attribute [rw] description
|
826
|
+
# The description of the image.
|
827
|
+
# @return [String]
|
828
|
+
#
|
829
|
+
# @!attribute [rw] operating_system
|
830
|
+
# The operating system that the image is running.
|
831
|
+
# @return [Types::OperatingSystem]
|
832
|
+
#
|
833
|
+
# @!attribute [rw] state
|
834
|
+
# The availability status of the image.
|
835
|
+
# @return [String]
|
836
|
+
#
|
837
|
+
# @!attribute [rw] required_tenancy
|
838
|
+
# Specifies whether the image is running on dedicated hardware. When
|
839
|
+
# Bring Your Own License (BYOL) is enabled, this value is set to
|
840
|
+
# DEDICATED. For more information, see [ Bring Your Own Windows
|
841
|
+
# Desktop Images.][1]
|
842
|
+
#
|
843
|
+
#
|
844
|
+
#
|
845
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.htm
|
846
|
+
# @return [String]
|
847
|
+
#
|
848
|
+
# @!attribute [rw] created
|
849
|
+
# The date when the image was created.
|
850
|
+
# @return [Time]
|
851
|
+
#
|
852
|
+
# @!attribute [rw] owner_account_id
|
853
|
+
# The identifier of the AWS account that owns the image.
|
854
|
+
# @return [String]
|
855
|
+
#
|
856
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaceImageResult AWS API Documentation
|
857
|
+
#
|
858
|
+
class CreateWorkspaceImageResult < Struct.new(
|
859
|
+
:image_id,
|
860
|
+
:name,
|
861
|
+
:description,
|
862
|
+
:operating_system,
|
863
|
+
:state,
|
864
|
+
:required_tenancy,
|
865
|
+
:created,
|
866
|
+
:owner_account_id)
|
867
|
+
SENSITIVE = []
|
868
|
+
include Aws::Structure
|
869
|
+
end
|
870
|
+
|
773
871
|
# @note When making an API call, you may pass CreateWorkspacesRequest
|
774
872
|
# data as a hash:
|
775
873
|
#
|
@@ -840,7 +938,7 @@ module Aws::WorkSpaces
|
|
840
938
|
# include sensitive information.
|
841
939
|
#
|
842
940
|
# @!attribute [rw] logo_url
|
843
|
-
# The logo
|
941
|
+
# The logo. The only image format accepted is a binary data object
|
844
942
|
# that is converted from a `.png` file.
|
845
943
|
# @return [String]
|
846
944
|
#
|
@@ -877,7 +975,10 @@ module Aws::WorkSpaces
|
|
877
975
|
# @!attribute [rw] login_message
|
878
976
|
# The login message. Specified as a key value pair, in which the key
|
879
977
|
# is a locale and the value is the localized message for that locale.
|
880
|
-
# The only key supported is `en_US`.
|
978
|
+
# The only key supported is `en_US`. The HTML tags supported include
|
979
|
+
# the following: `a, b, blockquote, br, cite, code, dd, dl, dt, div,
|
980
|
+
# em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u,
|
981
|
+
# ul`.
|
881
982
|
# @return [Hash<String,String>]
|
882
983
|
#
|
883
984
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DefaultClientBrandingAttributes AWS API Documentation
|
@@ -949,7 +1050,10 @@ module Aws::WorkSpaces
|
|
949
1050
|
# @!attribute [rw] login_message
|
950
1051
|
# The login message. Specified as a key value pair, in which the key
|
951
1052
|
# is a locale and the value is the localized message for that locale.
|
952
|
-
# The only key supported is `en_US`.
|
1053
|
+
# The only key supported is `en_US`. The HTML tags supported include
|
1054
|
+
# the following: `a, b, blockquote, br, cite, code, dd, dl, dt, div,
|
1055
|
+
# em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u,
|
1056
|
+
# ul`.
|
953
1057
|
# @return [Hash<String,String>]
|
954
1058
|
#
|
955
1059
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DefaultImportClientBrandingAttributes AWS API Documentation
|
@@ -2490,7 +2594,10 @@ module Aws::WorkSpaces
|
|
2490
2594
|
# @!attribute [rw] login_message
|
2491
2595
|
# The login message. Specified as a key value pair, in which the key
|
2492
2596
|
# is a locale and the value is the localized message for that locale.
|
2493
|
-
# The only key supported is `en_US`.
|
2597
|
+
# The only key supported is `en_US`. The HTML tags supported include
|
2598
|
+
# the following: `a, b, blockquote, br, cite, code, dd, dl, dt, div,
|
2599
|
+
# em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u,
|
2600
|
+
# ul`.
|
2494
2601
|
# @return [Hash<String,String>]
|
2495
2602
|
#
|
2496
2603
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/IosClientBrandingAttributes AWS API Documentation
|
@@ -2600,7 +2707,10 @@ module Aws::WorkSpaces
|
|
2600
2707
|
# @!attribute [rw] login_message
|
2601
2708
|
# The login message. Specified as a key value pair, in which the key
|
2602
2709
|
# is a locale and the value is the localized message for that locale.
|
2603
|
-
# The only key supported is `en_US`.
|
2710
|
+
# The only key supported is `en_US`. The HTML tags supported include
|
2711
|
+
# the following: `a, b, blockquote, br, cite, code, dd, dl, dt, div,
|
2712
|
+
# em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u,
|
2713
|
+
# ul`.
|
2604
2714
|
# @return [Hash<String,String>]
|
2605
2715
|
#
|
2606
2716
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/IosImportClientBrandingAttributes AWS API Documentation
|
@@ -2826,6 +2936,53 @@ module Aws::WorkSpaces
|
|
2826
2936
|
#
|
2827
2937
|
class ModifyClientPropertiesResult < Aws::EmptyStructure; end
|
2828
2938
|
|
2939
|
+
# @note When making an API call, you may pass ModifySamlPropertiesRequest
|
2940
|
+
# data as a hash:
|
2941
|
+
#
|
2942
|
+
# {
|
2943
|
+
# resource_id: "DirectoryId", # required
|
2944
|
+
# saml_properties: {
|
2945
|
+
# status: "DISABLED", # accepts DISABLED, ENABLED, ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK
|
2946
|
+
# user_access_url: "SamlUserAccessUrl",
|
2947
|
+
# relay_state_parameter_name: "NonEmptyString",
|
2948
|
+
# },
|
2949
|
+
# properties_to_delete: ["SAML_PROPERTIES_USER_ACCESS_URL"], # accepts SAML_PROPERTIES_USER_ACCESS_URL, SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME
|
2950
|
+
# }
|
2951
|
+
#
|
2952
|
+
# @!attribute [rw] resource_id
|
2953
|
+
# The directory identifier for which you want to configure SAML
|
2954
|
+
# properties.
|
2955
|
+
# @return [String]
|
2956
|
+
#
|
2957
|
+
# @!attribute [rw] saml_properties
|
2958
|
+
# The properties for configuring SAML 2.0 authentication.
|
2959
|
+
# @return [Types::SamlProperties]
|
2960
|
+
#
|
2961
|
+
# @!attribute [rw] properties_to_delete
|
2962
|
+
# The SAML properties to delete as part of your request.
|
2963
|
+
#
|
2964
|
+
# Specify one of the following options:
|
2965
|
+
#
|
2966
|
+
# * `SAML_PROPERTIES_USER_ACCESS_URL` to delete the user access URL.
|
2967
|
+
#
|
2968
|
+
# * `SAML_PROPERTIES_RELAY_STATE_PARAMETER_NAME` to delete the relay
|
2969
|
+
# state parameter name.
|
2970
|
+
# @return [Array<String>]
|
2971
|
+
#
|
2972
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySamlPropertiesRequest AWS API Documentation
|
2973
|
+
#
|
2974
|
+
class ModifySamlPropertiesRequest < Struct.new(
|
2975
|
+
:resource_id,
|
2976
|
+
:saml_properties,
|
2977
|
+
:properties_to_delete)
|
2978
|
+
SENSITIVE = []
|
2979
|
+
include Aws::Structure
|
2980
|
+
end
|
2981
|
+
|
2982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ModifySamlPropertiesResult AWS API Documentation
|
2983
|
+
#
|
2984
|
+
class ModifySamlPropertiesResult < Aws::EmptyStructure; end
|
2985
|
+
|
2829
2986
|
# @note When making an API call, you may pass ModifySelfservicePermissionsRequest
|
2830
2987
|
# data as a hash:
|
2831
2988
|
#
|
@@ -3405,6 +3562,68 @@ module Aws::WorkSpaces
|
|
3405
3562
|
include Aws::Structure
|
3406
3563
|
end
|
3407
3564
|
|
3565
|
+
# Describes the enablement status, user access URL, and relay state
|
3566
|
+
# parameter name that are used for configuring federation with an SAML
|
3567
|
+
# 2.0 identity provider.
|
3568
|
+
#
|
3569
|
+
# @note When making an API call, you may pass SamlProperties
|
3570
|
+
# data as a hash:
|
3571
|
+
#
|
3572
|
+
# {
|
3573
|
+
# status: "DISABLED", # accepts DISABLED, ENABLED, ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK
|
3574
|
+
# user_access_url: "SamlUserAccessUrl",
|
3575
|
+
# relay_state_parameter_name: "NonEmptyString",
|
3576
|
+
# }
|
3577
|
+
#
|
3578
|
+
# @!attribute [rw] status
|
3579
|
+
# Indicates the status of SAML 2.0 authentication. These statuses
|
3580
|
+
# include the following.
|
3581
|
+
#
|
3582
|
+
# * If the setting is `DISABLED`, end users will be directed to login
|
3583
|
+
# with their directory credentials.
|
3584
|
+
#
|
3585
|
+
# * If the setting is `ENABLED`, end users will be directed to login
|
3586
|
+
# via the user access URL. Users attempting to connect to WorkSpaces
|
3587
|
+
# from a client application that does not support SAML 2.0
|
3588
|
+
# authentication will not be able to connect.
|
3589
|
+
#
|
3590
|
+
# * If the setting is `ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK`, end
|
3591
|
+
# users will be directed to login via the user access URL on
|
3592
|
+
# supported client applications, but will not prevent clients that
|
3593
|
+
# do not support SAML 2.0 authentication from connecting as if SAML
|
3594
|
+
# 2.0 authentication was disabled.
|
3595
|
+
# @return [String]
|
3596
|
+
#
|
3597
|
+
# @!attribute [rw] user_access_url
|
3598
|
+
# The SAML 2.0 identity provider (IdP) user access URL is the URL a
|
3599
|
+
# user would navigate to in their web browser in order to federate
|
3600
|
+
# from the IdP and directly access the application, without any SAML
|
3601
|
+
# 2.0 service provider (SP) bindings.
|
3602
|
+
# @return [String]
|
3603
|
+
#
|
3604
|
+
# @!attribute [rw] relay_state_parameter_name
|
3605
|
+
# The relay state parameter name supported by the SAML 2.0 identity
|
3606
|
+
# provider (IdP). When the end user is redirected to the user access
|
3607
|
+
# URL from the WorkSpaces client application, this relay state
|
3608
|
+
# parameter name is appended as a query parameter to the URL along
|
3609
|
+
# with the relay state endpoint to return the user to the client
|
3610
|
+
# application session.
|
3611
|
+
#
|
3612
|
+
# To use SAML 2.0 authentication with WorkSpaces, the IdP must support
|
3613
|
+
# IdP-initiated deep linking for the relay state URL. Consult your IdP
|
3614
|
+
# documentation for more information.
|
3615
|
+
# @return [String]
|
3616
|
+
#
|
3617
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/SamlProperties AWS API Documentation
|
3618
|
+
#
|
3619
|
+
class SamlProperties < Struct.new(
|
3620
|
+
:status,
|
3621
|
+
:user_access_url,
|
3622
|
+
:relay_state_parameter_name)
|
3623
|
+
SENSITIVE = []
|
3624
|
+
include Aws::Structure
|
3625
|
+
end
|
3626
|
+
|
3408
3627
|
# Describes the self-service permissions for a directory. For more
|
3409
3628
|
# information, see [Enable Self-Service WorkSpace Management
|
3410
3629
|
# Capabilities for Your Users][1].
|
@@ -4400,6 +4619,12 @@ module Aws::WorkSpaces
|
|
4400
4619
|
# directory.
|
4401
4620
|
# @return [Types::SelfservicePermissions]
|
4402
4621
|
#
|
4622
|
+
# @!attribute [rw] saml_properties
|
4623
|
+
# Describes the enablement status, user access URL, and relay state
|
4624
|
+
# parameter name that are used for configuring federation with an SAML
|
4625
|
+
# 2.0 identity provider.
|
4626
|
+
# @return [Types::SamlProperties]
|
4627
|
+
#
|
4403
4628
|
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceDirectory AWS API Documentation
|
4404
4629
|
#
|
4405
4630
|
class WorkspaceDirectory < Struct.new(
|
@@ -4418,7 +4643,8 @@ module Aws::WorkSpaces
|
|
4418
4643
|
:ip_group_ids,
|
4419
4644
|
:workspace_access_properties,
|
4420
4645
|
:tenancy,
|
4421
|
-
:selfservice_permissions
|
4646
|
+
:selfservice_permissions,
|
4647
|
+
:saml_properties)
|
4422
4648
|
SENSITIVE = []
|
4423
4649
|
include Aws::Structure
|
4424
4650
|
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.72.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-08-01 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|