aws-sdk-workspaces 1.44.0 → 1.49.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/lib/aws-sdk-workspaces.rb +3 -2
- data/lib/aws-sdk-workspaces/client.rb +453 -21
- data/lib/aws-sdk-workspaces/client_api.rb +194 -0
- data/lib/aws-sdk-workspaces/types.rb +459 -12
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ffe276903ab823c47db83da4ea3a55fe7cf7a3b85d6657f4c2d12c3a52397154
|
4
|
+
data.tar.gz: e3312a0ee0a0bb7336a11cbf672be53e7e4435d6a0eac4d7f5dd9994a2fc2027
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: be29a0d4dbcd4315f2f7fe90fce30f47e96f25c5eeda778e674c5625ea6ea82eb502c0f3e1b5e156f59145eaabc9685f7c41e8b0439228026e080189b3e85dc0
|
7
|
+
data.tar.gz: 1c5279d07df1f615e8cb874c3a10731c8b8f9eb26f41cdb900159276b7fb5cc5d44925213f0c05646b4fa1bda02a42e17cfc6abc27e49d68adce9bf59ff7902b
|
data/lib/aws-sdk-workspaces.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -27,7 +28,7 @@ require_relative 'aws-sdk-workspaces/customizations'
|
|
27
28
|
# structure.
|
28
29
|
#
|
29
30
|
# work_spaces = Aws::WorkSpaces::Client.new
|
30
|
-
# resp = work_spaces.
|
31
|
+
# resp = work_spaces.associate_connection_alias(params)
|
31
32
|
#
|
32
33
|
# See {Client} for more information.
|
33
34
|
#
|
@@ -47,6 +48,6 @@ require_relative 'aws-sdk-workspaces/customizations'
|
|
47
48
|
# @!group service
|
48
49
|
module Aws::WorkSpaces
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.49.0'
|
51
52
|
|
52
53
|
end
|
@@ -337,6 +337,52 @@ module Aws::WorkSpaces
|
|
337
337
|
|
338
338
|
# @!group API Operations
|
339
339
|
|
340
|
+
# Associates the specified connection alias with the specified directory
|
341
|
+
# to enable cross-Region redirection. For more information, see [
|
342
|
+
# Cross-Region Redirection for Amazon WorkSpaces][1].
|
343
|
+
#
|
344
|
+
# <note markdown="1"> Before performing this operation, call [ DescribeConnectionAliases][2]
|
345
|
+
# to make sure that the current state of the connection alias is
|
346
|
+
# `CREATED`.
|
347
|
+
#
|
348
|
+
# </note>
|
349
|
+
#
|
350
|
+
#
|
351
|
+
#
|
352
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
353
|
+
# [2]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html
|
354
|
+
#
|
355
|
+
# @option params [required, String] :alias_id
|
356
|
+
# The identifier of the connection alias.
|
357
|
+
#
|
358
|
+
# @option params [required, String] :resource_id
|
359
|
+
# The identifier of the directory to associate the connection alias
|
360
|
+
# with.
|
361
|
+
#
|
362
|
+
# @return [Types::AssociateConnectionAliasResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
363
|
+
#
|
364
|
+
# * {Types::AssociateConnectionAliasResult#connection_identifier #connection_identifier} => String
|
365
|
+
#
|
366
|
+
# @example Request syntax with placeholder values
|
367
|
+
#
|
368
|
+
# resp = client.associate_connection_alias({
|
369
|
+
# alias_id: "ConnectionAliasId", # required
|
370
|
+
# resource_id: "NonEmptyString", # required
|
371
|
+
# })
|
372
|
+
#
|
373
|
+
# @example Response structure
|
374
|
+
#
|
375
|
+
# resp.connection_identifier #=> String
|
376
|
+
#
|
377
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/AssociateConnectionAlias AWS API Documentation
|
378
|
+
#
|
379
|
+
# @overload associate_connection_alias(params = {})
|
380
|
+
# @param [Hash] params ({})
|
381
|
+
def associate_connection_alias(params = {}, options = {})
|
382
|
+
req = build_request(:associate_connection_alias, params)
|
383
|
+
req.send_request(options)
|
384
|
+
end
|
385
|
+
|
340
386
|
# Associates the specified IP access control group with the specified
|
341
387
|
# directory.
|
342
388
|
#
|
@@ -399,7 +445,28 @@ module Aws::WorkSpaces
|
|
399
445
|
end
|
400
446
|
|
401
447
|
# Copies the specified image from the specified Region to the current
|
402
|
-
# Region.
|
448
|
+
# Region. For more information about copying images, see [ Copy a Custom
|
449
|
+
# WorkSpaces Image][1].
|
450
|
+
#
|
451
|
+
# <note markdown="1"> In the China (Ningxia) Region, you can copy images only within the
|
452
|
+
# same Region.
|
453
|
+
#
|
454
|
+
# In the AWS GovCloud (US-West) Region, to copy images to and from other
|
455
|
+
# AWS Regions, contact AWS Support.
|
456
|
+
#
|
457
|
+
# </note>
|
458
|
+
#
|
459
|
+
# Before copying a shared image, be sure to verify that it has been
|
460
|
+
# shared from the correct AWS account. To determine if an image has been
|
461
|
+
# shared and to see the AWS account ID that owns an image, use the
|
462
|
+
# [DescribeWorkSpaceImages][2] and
|
463
|
+
# [DescribeWorkspaceImagePermissions][3] API operations.
|
464
|
+
#
|
465
|
+
#
|
466
|
+
#
|
467
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/copy-custom-image.html
|
468
|
+
# [2]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html
|
469
|
+
# [3]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImagePermissions.html
|
403
470
|
#
|
404
471
|
# @option params [required, String] :name
|
405
472
|
# The name of the image.
|
@@ -448,6 +515,56 @@ module Aws::WorkSpaces
|
|
448
515
|
req.send_request(options)
|
449
516
|
end
|
450
517
|
|
518
|
+
# Creates the specified connection alias for use with cross-Region
|
519
|
+
# redirection. For more information, see [ Cross-Region Redirection for
|
520
|
+
# Amazon WorkSpaces][1].
|
521
|
+
#
|
522
|
+
#
|
523
|
+
#
|
524
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
525
|
+
#
|
526
|
+
# @option params [required, String] :connection_string
|
527
|
+
# A connection string in the form of a fully qualified domain name
|
528
|
+
# (FQDN), such as `www.example.com`.
|
529
|
+
#
|
530
|
+
# After you create a connection string, it is always associated to your
|
531
|
+
# AWS account. You cannot recreate the same connection string with a
|
532
|
+
# different account, even if you delete all instances of it from the
|
533
|
+
# original account. The connection string is globally reserved for your
|
534
|
+
# account.
|
535
|
+
#
|
536
|
+
# @option params [Array<Types::Tag>] :tags
|
537
|
+
# The tags to associate with the connection alias.
|
538
|
+
#
|
539
|
+
# @return [Types::CreateConnectionAliasResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
540
|
+
#
|
541
|
+
# * {Types::CreateConnectionAliasResult#alias_id #alias_id} => String
|
542
|
+
#
|
543
|
+
# @example Request syntax with placeholder values
|
544
|
+
#
|
545
|
+
# resp = client.create_connection_alias({
|
546
|
+
# connection_string: "ConnectionString", # required
|
547
|
+
# tags: [
|
548
|
+
# {
|
549
|
+
# key: "TagKey", # required
|
550
|
+
# value: "TagValue",
|
551
|
+
# },
|
552
|
+
# ],
|
553
|
+
# })
|
554
|
+
#
|
555
|
+
# @example Response structure
|
556
|
+
#
|
557
|
+
# resp.alias_id #=> String
|
558
|
+
#
|
559
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateConnectionAlias AWS API Documentation
|
560
|
+
#
|
561
|
+
# @overload create_connection_alias(params = {})
|
562
|
+
# @param [Hash] params ({})
|
563
|
+
def create_connection_alias(params = {}, options = {})
|
564
|
+
req = build_request(:create_connection_alias, params)
|
565
|
+
req.send_request(options)
|
566
|
+
end
|
567
|
+
|
451
568
|
# Creates an IP access control group.
|
452
569
|
#
|
453
570
|
# An IP access control group provides you with the ability to control
|
@@ -517,12 +634,10 @@ module Aws::WorkSpaces
|
|
517
634
|
# @option params [required, String] :resource_id
|
518
635
|
# The identifier of the WorkSpaces resource. The supported resource
|
519
636
|
# types are WorkSpaces, registered directories, images, custom bundles,
|
520
|
-
#
|
637
|
+
# IP access control groups, and connection aliases.
|
521
638
|
#
|
522
639
|
# @option params [required, Array<Types::Tag>] :tags
|
523
|
-
# The tags. Each WorkSpaces resource can have a maximum of 50 tags.
|
524
|
-
# you want to add new tags to a set of existing tags, you must submit
|
525
|
-
# all of the existing tags along with the new ones.
|
640
|
+
# The tags. Each WorkSpaces resource can have a maximum of 50 tags.
|
526
641
|
#
|
527
642
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
528
643
|
#
|
@@ -639,6 +754,49 @@ module Aws::WorkSpaces
|
|
639
754
|
req.send_request(options)
|
640
755
|
end
|
641
756
|
|
757
|
+
# Deletes the specified connection alias. For more information, see [
|
758
|
+
# Cross-Region Redirection for Amazon WorkSpaces][1].
|
759
|
+
#
|
760
|
+
# **If you will no longer be using a fully qualified domain name (FQDN)
|
761
|
+
# as the registration code for your WorkSpaces users, you must take
|
762
|
+
# certain precautions to prevent potential security issues.** For more
|
763
|
+
# information, see [ Security Considerations if You Stop Using
|
764
|
+
# Cross-Region Redirection][2].
|
765
|
+
#
|
766
|
+
# <note markdown="1"> To delete a connection alias that has been shared, the shared account
|
767
|
+
# must first disassociate the connection alias from any directories it
|
768
|
+
# has been associated with. Then you must unshare the connection alias
|
769
|
+
# from the account it has been shared with. You can delete a connection
|
770
|
+
# alias only after it is no longer shared with any accounts or
|
771
|
+
# associated with any directories.
|
772
|
+
#
|
773
|
+
# </note>
|
774
|
+
#
|
775
|
+
#
|
776
|
+
#
|
777
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
778
|
+
# [2]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html#cross-region-redirection-security-considerations
|
779
|
+
#
|
780
|
+
# @option params [required, String] :alias_id
|
781
|
+
# The identifier of the connection alias to delete.
|
782
|
+
#
|
783
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
784
|
+
#
|
785
|
+
# @example Request syntax with placeholder values
|
786
|
+
#
|
787
|
+
# resp = client.delete_connection_alias({
|
788
|
+
# alias_id: "ConnectionAliasId", # required
|
789
|
+
# })
|
790
|
+
#
|
791
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteConnectionAlias AWS API Documentation
|
792
|
+
#
|
793
|
+
# @overload delete_connection_alias(params = {})
|
794
|
+
# @param [Hash] params ({})
|
795
|
+
def delete_connection_alias(params = {}, options = {})
|
796
|
+
req = build_request(:delete_connection_alias, params)
|
797
|
+
req.send_request(options)
|
798
|
+
end
|
799
|
+
|
642
800
|
# Deletes the specified IP access control group.
|
643
801
|
#
|
644
802
|
# You cannot delete an IP access control group that is associated with a
|
@@ -669,7 +827,7 @@ module Aws::WorkSpaces
|
|
669
827
|
# @option params [required, String] :resource_id
|
670
828
|
# The identifier of the WorkSpaces resource. The supported resource
|
671
829
|
# types are WorkSpaces, registered directories, images, custom bundles,
|
672
|
-
#
|
830
|
+
# IP access control groups, and connection aliases.
|
673
831
|
#
|
674
832
|
# @option params [required, Array<String>] :tag_keys
|
675
833
|
# The tag keys.
|
@@ -721,6 +879,25 @@ module Aws::WorkSpaces
|
|
721
879
|
# WorkSpaces are registered to this directory, you must remove them
|
722
880
|
# before you can deregister the directory.
|
723
881
|
#
|
882
|
+
# <note markdown="1"> Simple AD and AD Connector are made available to you free of charge to
|
883
|
+
# use with WorkSpaces. If there are no WorkSpaces being used with your
|
884
|
+
# Simple AD or AD Connector directory for 30 consecutive days, this
|
885
|
+
# directory will be automatically deregistered for use with Amazon
|
886
|
+
# WorkSpaces, and you will be charged for this directory as per the [AWS
|
887
|
+
# Directory Services pricing terms][1].
|
888
|
+
#
|
889
|
+
# To delete empty directories, see [ Delete the Directory for Your
|
890
|
+
# WorkSpaces][2]. If you delete your Simple AD or AD Connector
|
891
|
+
# directory, you can always create a new one when you want to start
|
892
|
+
# using WorkSpaces again.
|
893
|
+
#
|
894
|
+
# </note>
|
895
|
+
#
|
896
|
+
#
|
897
|
+
#
|
898
|
+
# [1]: http://aws.amazon.com/directoryservice/pricing/
|
899
|
+
# [2]: https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html
|
900
|
+
#
|
724
901
|
# @option params [required, String] :directory_id
|
725
902
|
# The identifier of the directory. If any WorkSpaces are registered to
|
726
903
|
# this directory, you must remove them before you deregister the
|
@@ -835,6 +1012,114 @@ module Aws::WorkSpaces
|
|
835
1012
|
req.send_request(options)
|
836
1013
|
end
|
837
1014
|
|
1015
|
+
# Describes the permissions that the owner of a connection alias has
|
1016
|
+
# granted to another AWS account for the specified connection alias. For
|
1017
|
+
# more information, see [ Cross-Region Redirection for Amazon
|
1018
|
+
# WorkSpaces][1].
|
1019
|
+
#
|
1020
|
+
#
|
1021
|
+
#
|
1022
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
1023
|
+
#
|
1024
|
+
# @option params [required, String] :alias_id
|
1025
|
+
# The identifier of the connection alias.
|
1026
|
+
#
|
1027
|
+
# @option params [String] :next_token
|
1028
|
+
# If you received a `NextToken` from a previous call that was paginated,
|
1029
|
+
# provide this token to receive the next set of results.
|
1030
|
+
#
|
1031
|
+
# @option params [Integer] :max_results
|
1032
|
+
# The maximum number of results to return.
|
1033
|
+
#
|
1034
|
+
# @return [Types::DescribeConnectionAliasPermissionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1035
|
+
#
|
1036
|
+
# * {Types::DescribeConnectionAliasPermissionsResult#alias_id #alias_id} => String
|
1037
|
+
# * {Types::DescribeConnectionAliasPermissionsResult#connection_alias_permissions #connection_alias_permissions} => Array<Types::ConnectionAliasPermission>
|
1038
|
+
# * {Types::DescribeConnectionAliasPermissionsResult#next_token #next_token} => String
|
1039
|
+
#
|
1040
|
+
# @example Request syntax with placeholder values
|
1041
|
+
#
|
1042
|
+
# resp = client.describe_connection_alias_permissions({
|
1043
|
+
# alias_id: "ConnectionAliasId", # required
|
1044
|
+
# next_token: "PaginationToken",
|
1045
|
+
# max_results: 1,
|
1046
|
+
# })
|
1047
|
+
#
|
1048
|
+
# @example Response structure
|
1049
|
+
#
|
1050
|
+
# resp.alias_id #=> String
|
1051
|
+
# resp.connection_alias_permissions #=> Array
|
1052
|
+
# resp.connection_alias_permissions[0].shared_account_id #=> String
|
1053
|
+
# resp.connection_alias_permissions[0].allow_association #=> Boolean
|
1054
|
+
# resp.next_token #=> String
|
1055
|
+
#
|
1056
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliasPermissions AWS API Documentation
|
1057
|
+
#
|
1058
|
+
# @overload describe_connection_alias_permissions(params = {})
|
1059
|
+
# @param [Hash] params ({})
|
1060
|
+
def describe_connection_alias_permissions(params = {}, options = {})
|
1061
|
+
req = build_request(:describe_connection_alias_permissions, params)
|
1062
|
+
req.send_request(options)
|
1063
|
+
end
|
1064
|
+
|
1065
|
+
# Retrieves a list that describes the connection aliases used for
|
1066
|
+
# cross-Region redirection. For more information, see [ Cross-Region
|
1067
|
+
# Redirection for Amazon WorkSpaces][1].
|
1068
|
+
#
|
1069
|
+
#
|
1070
|
+
#
|
1071
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
1072
|
+
#
|
1073
|
+
# @option params [Array<String>] :alias_ids
|
1074
|
+
# The identifiers of the connection aliases to describe.
|
1075
|
+
#
|
1076
|
+
# @option params [String] :resource_id
|
1077
|
+
# The identifier of the directory associated with the connection alias.
|
1078
|
+
#
|
1079
|
+
# @option params [Integer] :limit
|
1080
|
+
# The maximum number of connection aliases to return.
|
1081
|
+
#
|
1082
|
+
# @option params [String] :next_token
|
1083
|
+
# If you received a `NextToken` from a previous call that was paginated,
|
1084
|
+
# provide this token to receive the next set of results.
|
1085
|
+
#
|
1086
|
+
# @return [Types::DescribeConnectionAliasesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1087
|
+
#
|
1088
|
+
# * {Types::DescribeConnectionAliasesResult#connection_aliases #connection_aliases} => Array<Types::ConnectionAlias>
|
1089
|
+
# * {Types::DescribeConnectionAliasesResult#next_token #next_token} => String
|
1090
|
+
#
|
1091
|
+
# @example Request syntax with placeholder values
|
1092
|
+
#
|
1093
|
+
# resp = client.describe_connection_aliases({
|
1094
|
+
# alias_ids: ["ConnectionAliasId"],
|
1095
|
+
# resource_id: "NonEmptyString",
|
1096
|
+
# limit: 1,
|
1097
|
+
# next_token: "PaginationToken",
|
1098
|
+
# })
|
1099
|
+
#
|
1100
|
+
# @example Response structure
|
1101
|
+
#
|
1102
|
+
# resp.connection_aliases #=> Array
|
1103
|
+
# resp.connection_aliases[0].connection_string #=> String
|
1104
|
+
# resp.connection_aliases[0].alias_id #=> String
|
1105
|
+
# resp.connection_aliases[0].state #=> String, one of "CREATING", "CREATED", "DELETING"
|
1106
|
+
# resp.connection_aliases[0].owner_account_id #=> String
|
1107
|
+
# resp.connection_aliases[0].associations #=> Array
|
1108
|
+
# resp.connection_aliases[0].associations[0].association_status #=> String, one of "NOT_ASSOCIATED", "ASSOCIATED_WITH_OWNER_ACCOUNT", "ASSOCIATED_WITH_SHARED_ACCOUNT", "PENDING_ASSOCIATION", "PENDING_DISASSOCIATION"
|
1109
|
+
# resp.connection_aliases[0].associations[0].associated_account_id #=> String
|
1110
|
+
# resp.connection_aliases[0].associations[0].resource_id #=> String
|
1111
|
+
# resp.connection_aliases[0].associations[0].connection_identifier #=> String
|
1112
|
+
# resp.next_token #=> String
|
1113
|
+
#
|
1114
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliases AWS API Documentation
|
1115
|
+
#
|
1116
|
+
# @overload describe_connection_aliases(params = {})
|
1117
|
+
# @param [Hash] params ({})
|
1118
|
+
def describe_connection_aliases(params = {}, options = {})
|
1119
|
+
req = build_request(:describe_connection_aliases, params)
|
1120
|
+
req.send_request(options)
|
1121
|
+
end
|
1122
|
+
|
838
1123
|
# Describes one or more of your IP access control groups.
|
839
1124
|
#
|
840
1125
|
# @option params [Array<String>] :group_ids
|
@@ -885,7 +1170,7 @@ module Aws::WorkSpaces
|
|
885
1170
|
# @option params [required, String] :resource_id
|
886
1171
|
# The identifier of the WorkSpaces resource. The supported resource
|
887
1172
|
# types are WorkSpaces, registered directories, images, custom bundles,
|
888
|
-
#
|
1173
|
+
# IP access control groups, and connection aliases.
|
889
1174
|
#
|
890
1175
|
# @return [Types::DescribeTagsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
891
1176
|
#
|
@@ -1304,6 +1589,42 @@ module Aws::WorkSpaces
|
|
1304
1589
|
req.send_request(options)
|
1305
1590
|
end
|
1306
1591
|
|
1592
|
+
# Disassociates a connection alias from a directory. Disassociating a
|
1593
|
+
# connection alias disables cross-Region redirection between two
|
1594
|
+
# directories in different AWS Regions. For more information, see [
|
1595
|
+
# Cross-Region Redirection for Amazon WorkSpaces][1].
|
1596
|
+
#
|
1597
|
+
# <note markdown="1"> Before performing this operation, call [ DescribeConnectionAliases][2]
|
1598
|
+
# to make sure that the current state of the connection alias is
|
1599
|
+
# `CREATED`.
|
1600
|
+
#
|
1601
|
+
# </note>
|
1602
|
+
#
|
1603
|
+
#
|
1604
|
+
#
|
1605
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
1606
|
+
# [2]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html
|
1607
|
+
#
|
1608
|
+
# @option params [required, String] :alias_id
|
1609
|
+
# The identifier of the connection alias to disassociate.
|
1610
|
+
#
|
1611
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1612
|
+
#
|
1613
|
+
# @example Request syntax with placeholder values
|
1614
|
+
#
|
1615
|
+
# resp = client.disassociate_connection_alias({
|
1616
|
+
# alias_id: "ConnectionAliasId", # required
|
1617
|
+
# })
|
1618
|
+
#
|
1619
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateConnectionAlias AWS API Documentation
|
1620
|
+
#
|
1621
|
+
# @overload disassociate_connection_alias(params = {})
|
1622
|
+
# @param [Hash] params ({})
|
1623
|
+
def disassociate_connection_alias(params = {}, options = {})
|
1624
|
+
req = build_request(:disassociate_connection_alias, params)
|
1625
|
+
req.send_request(options)
|
1626
|
+
end
|
1627
|
+
|
1307
1628
|
# Disassociates the specified IP access control group from the specified
|
1308
1629
|
# directory.
|
1309
1630
|
#
|
@@ -1332,8 +1653,8 @@ module Aws::WorkSpaces
|
|
1332
1653
|
end
|
1333
1654
|
|
1334
1655
|
# Imports the specified Windows 10 Bring Your Own License (BYOL) image
|
1335
|
-
# into Amazon WorkSpaces. The image must be an already licensed
|
1336
|
-
# image that is in your AWS account, and you must own the image. For
|
1656
|
+
# into Amazon WorkSpaces. The image must be an already licensed Amazon
|
1657
|
+
# EC2 image that is in your AWS account, and you must own the image. For
|
1337
1658
|
# more information about creating BYOL images, see [ Bring Your Own
|
1338
1659
|
# Windows Desktop Licenses][1].
|
1339
1660
|
#
|
@@ -1345,9 +1666,15 @@ module Aws::WorkSpaces
|
|
1345
1666
|
# The identifier of the EC2 image.
|
1346
1667
|
#
|
1347
1668
|
# @option params [required, String] :ingestion_process
|
1348
|
-
# The ingestion process to be used when importing the image
|
1349
|
-
#
|
1350
|
-
#
|
1669
|
+
# The ingestion process to be used when importing the image, depending
|
1670
|
+
# on which protocol you want to use for your BYOL Workspace image,
|
1671
|
+
# either PCoIP or WorkSpaces Streaming Protocol (WSP). To use WSP,
|
1672
|
+
# specify a value that ends in `_WSP`. To use PCoIP, specify a value
|
1673
|
+
# that does not end in `_WSP`.
|
1674
|
+
#
|
1675
|
+
# For non-GPU-enabled bundles (bundles other than Graphics or
|
1676
|
+
# GraphicsPro), specify `BYOL_REGULAR` or `BYOL_REGULAR_WSP`, depending
|
1677
|
+
# on the protocol.
|
1351
1678
|
#
|
1352
1679
|
# @option params [required, String] :image_name
|
1353
1680
|
# The name of the WorkSpace image.
|
@@ -1381,7 +1708,7 @@ module Aws::WorkSpaces
|
|
1381
1708
|
#
|
1382
1709
|
# resp = client.import_workspace_image({
|
1383
1710
|
# ec2_image_id: "Ec2ImageId", # required
|
1384
|
-
# ingestion_process: "BYOL_REGULAR", # required, accepts BYOL_REGULAR, BYOL_GRAPHICS, BYOL_GRAPHICSPRO
|
1711
|
+
# ingestion_process: "BYOL_REGULAR", # required, accepts BYOL_REGULAR, BYOL_GRAPHICS, BYOL_GRAPHICSPRO, BYOL_REGULAR_WSP
|
1385
1712
|
# image_name: "WorkspaceImageName", # required
|
1386
1713
|
# image_description: "WorkspaceImageDescription", # required
|
1387
1714
|
# tags: [
|
@@ -1410,6 +1737,10 @@ module Aws::WorkSpaces
|
|
1410
1737
|
# that you can use for the network management interface when you enable
|
1411
1738
|
# Bring Your Own License (BYOL).
|
1412
1739
|
#
|
1740
|
+
# This operation can be run only by AWS accounts that are enabled for
|
1741
|
+
# BYOL. If your account isn't enabled for BYOL, you'll receive an
|
1742
|
+
# `AccessDeniedException` error.
|
1743
|
+
#
|
1413
1744
|
# The management network interface is connected to a secure Amazon
|
1414
1745
|
# WorkSpaces management network. It is used for interactive streaming of
|
1415
1746
|
# the WorkSpace desktop to Amazon WorkSpaces clients, and to allow
|
@@ -2057,12 +2388,37 @@ module Aws::WorkSpaces
|
|
2057
2388
|
#
|
2058
2389
|
# Terminating a WorkSpace is a permanent action and cannot be undone.
|
2059
2390
|
# The user's data is destroyed. If you need to archive any user data,
|
2060
|
-
# contact
|
2391
|
+
# contact AWS Support before terminating the WorkSpace.
|
2061
2392
|
#
|
2062
2393
|
# You can terminate a WorkSpace that is in any state except `SUSPENDED`.
|
2063
2394
|
#
|
2064
2395
|
# This operation is asynchronous and returns before the WorkSpaces have
|
2065
|
-
# been completely terminated.
|
2396
|
+
# been completely terminated. After a WorkSpace is terminated, the
|
2397
|
+
# `TERMINATED` state is returned only briefly before the WorkSpace
|
2398
|
+
# directory metadata is cleaned up, so this state is rarely returned. To
|
2399
|
+
# confirm that a WorkSpace is terminated, check for the WorkSpace ID by
|
2400
|
+
# using [ DescribeWorkSpaces][1]. If the WorkSpace ID isn't returned,
|
2401
|
+
# then the WorkSpace has been successfully terminated.
|
2402
|
+
#
|
2403
|
+
# <note markdown="1"> Simple AD and AD Connector are made available to you free of charge to
|
2404
|
+
# use with WorkSpaces. If there are no WorkSpaces being used with your
|
2405
|
+
# Simple AD or AD Connector directory for 30 consecutive days, this
|
2406
|
+
# directory will be automatically deregistered for use with Amazon
|
2407
|
+
# WorkSpaces, and you will be charged for this directory as per the [AWS
|
2408
|
+
# Directory Services pricing terms][2].
|
2409
|
+
#
|
2410
|
+
# To delete empty directories, see [ Delete the Directory for Your
|
2411
|
+
# WorkSpaces][3]. If you delete your Simple AD or AD Connector
|
2412
|
+
# directory, you can always create a new one when you want to start
|
2413
|
+
# using WorkSpaces again.
|
2414
|
+
#
|
2415
|
+
# </note>
|
2416
|
+
#
|
2417
|
+
#
|
2418
|
+
#
|
2419
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html
|
2420
|
+
# [2]: http://aws.amazon.com/directoryservice/pricing/
|
2421
|
+
# [3]: https://docs.aws.amazon.com/workspaces/latest/adminguide/delete-workspaces-directory.html
|
2066
2422
|
#
|
2067
2423
|
# @option params [required, Array<Types::TerminateRequest>] :terminate_workspace_requests
|
2068
2424
|
# The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
|
@@ -2097,6 +2453,61 @@ module Aws::WorkSpaces
|
|
2097
2453
|
req.send_request(options)
|
2098
2454
|
end
|
2099
2455
|
|
2456
|
+
# Shares or unshares a connection alias with one account by specifying
|
2457
|
+
# whether that account has permission to associate the connection alias
|
2458
|
+
# with a directory. If the association permission is granted, the
|
2459
|
+
# connection alias is shared with that account. If the association
|
2460
|
+
# permission is revoked, the connection alias is unshared with the
|
2461
|
+
# account. For more information, see [ Cross-Region Redirection for
|
2462
|
+
# Amazon WorkSpaces][1].
|
2463
|
+
#
|
2464
|
+
# <note markdown="1"> * Before performing this operation, call [
|
2465
|
+
# DescribeConnectionAliases][2] to make sure that the current state of
|
2466
|
+
# the connection alias is `CREATED`.
|
2467
|
+
#
|
2468
|
+
# * To delete a connection alias that has been shared, the shared
|
2469
|
+
# account must first disassociate the connection alias from any
|
2470
|
+
# directories it has been associated with. Then you must unshare the
|
2471
|
+
# connection alias from the account it has been shared with. You can
|
2472
|
+
# delete a connection alias only after it is no longer shared with any
|
2473
|
+
# accounts or associated with any directories.
|
2474
|
+
#
|
2475
|
+
# </note>
|
2476
|
+
#
|
2477
|
+
#
|
2478
|
+
#
|
2479
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
2480
|
+
# [2]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html
|
2481
|
+
#
|
2482
|
+
# @option params [required, String] :alias_id
|
2483
|
+
# The identifier of the connection alias that you want to update
|
2484
|
+
# permissions for.
|
2485
|
+
#
|
2486
|
+
# @option params [required, Types::ConnectionAliasPermission] :connection_alias_permission
|
2487
|
+
# Indicates whether to share or unshare the connection alias with the
|
2488
|
+
# specified AWS account.
|
2489
|
+
#
|
2490
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2491
|
+
#
|
2492
|
+
# @example Request syntax with placeholder values
|
2493
|
+
#
|
2494
|
+
# resp = client.update_connection_alias_permission({
|
2495
|
+
# alias_id: "ConnectionAliasId", # required
|
2496
|
+
# connection_alias_permission: { # required
|
2497
|
+
# shared_account_id: "AwsAccount", # required
|
2498
|
+
# allow_association: false, # required
|
2499
|
+
# },
|
2500
|
+
# })
|
2501
|
+
#
|
2502
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectionAliasPermission AWS API Documentation
|
2503
|
+
#
|
2504
|
+
# @overload update_connection_alias_permission(params = {})
|
2505
|
+
# @param [Hash] params ({})
|
2506
|
+
def update_connection_alias_permission(params = {}, options = {})
|
2507
|
+
req = build_request(:update_connection_alias_permission, params)
|
2508
|
+
req.send_request(options)
|
2509
|
+
end
|
2510
|
+
|
2100
2511
|
# Replaces the current rules of the specified IP access control group
|
2101
2512
|
# with the specified rules.
|
2102
2513
|
#
|
@@ -2129,11 +2540,25 @@ module Aws::WorkSpaces
|
|
2129
2540
|
req.send_request(options)
|
2130
2541
|
end
|
2131
2542
|
|
2132
|
-
# Shares or unshares an image with one account
|
2133
|
-
# that account has permission to copy the image. If
|
2134
|
-
# permission is granted, the image is shared with that
|
2135
|
-
# copy image permission is revoked, the image is
|
2136
|
-
# account.
|
2543
|
+
# Shares or unshares an image with one account in the same AWS Region by
|
2544
|
+
# specifying whether that account has permission to copy the image. If
|
2545
|
+
# the copy image permission is granted, the image is shared with that
|
2546
|
+
# account. If the copy image permission is revoked, the image is
|
2547
|
+
# unshared with the account.
|
2548
|
+
#
|
2549
|
+
# After an image has been shared, the recipient account can copy the
|
2550
|
+
# image to other AWS Regions as needed.
|
2551
|
+
#
|
2552
|
+
# <note markdown="1"> In the China (Ningxia) Region, you can copy images only within the
|
2553
|
+
# same Region.
|
2554
|
+
#
|
2555
|
+
# In the AWS GovCloud (US-West) Region, to copy images to and from other
|
2556
|
+
# AWS Regions, contact AWS Support.
|
2557
|
+
#
|
2558
|
+
# </note>
|
2559
|
+
#
|
2560
|
+
# For more information about sharing images, see [ Share or Unshare a
|
2561
|
+
# Custom WorkSpaces Image][1].
|
2137
2562
|
#
|
2138
2563
|
# <note markdown="1"> * To delete an image that has been shared, you must unshare the image
|
2139
2564
|
# before you delete it.
|
@@ -2145,6 +2570,10 @@ module Aws::WorkSpaces
|
|
2145
2570
|
#
|
2146
2571
|
# </note>
|
2147
2572
|
#
|
2573
|
+
#
|
2574
|
+
#
|
2575
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html
|
2576
|
+
#
|
2148
2577
|
# @option params [required, String] :image_id
|
2149
2578
|
# The identifier of the image.
|
2150
2579
|
#
|
@@ -2155,6 +2584,9 @@ module Aws::WorkSpaces
|
|
2155
2584
|
# @option params [required, String] :shared_account_id
|
2156
2585
|
# The identifier of the AWS account to share or unshare the image with.
|
2157
2586
|
#
|
2587
|
+
# Before sharing the image, confirm that you are sharing to the correct
|
2588
|
+
# AWS account ID.
|
2589
|
+
#
|
2158
2590
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2159
2591
|
#
|
2160
2592
|
# @example Request syntax with placeholder values
|
@@ -2187,7 +2619,7 @@ module Aws::WorkSpaces
|
|
2187
2619
|
params: params,
|
2188
2620
|
config: config)
|
2189
2621
|
context[:gem_name] = 'aws-sdk-workspaces'
|
2190
|
-
context[:gem_version] = '1.
|
2622
|
+
context[:gem_version] = '1.49.0'
|
2191
2623
|
Seahorse::Client::Request.new(handlers, context)
|
2192
2624
|
end
|
2193
2625
|
|