aws-sdk-workspaces 1.43.0 → 1.48.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 +409 -16
- data/lib/aws-sdk-workspaces/client_api.rb +199 -0
- data/lib/aws-sdk-workspaces/types.rb +471 -10
- 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: c2a3ac34bac067bf5fc00e25e05aa0245a34d5b0744d9d6eff248bb4fd3868a6
|
4
|
+
data.tar.gz: bb7d8257d27122cf448d19552eab7adf87bec64767b58a7fd414d541b72f6736
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a1509fda9397f656e2f08cd9c92d225b85462a9854d2a9676cfc107669e037b64eac1fd26ef5c47debb33927c98323d1163c4f6bd764669f43d7230006a3065a
|
7
|
+
data.tar.gz: 9c796875f31aafcd9215efc8d83d88ed24d008d679fb8c8406bf5aa598e12d567bf4c944f29e9e65ddc331483e14531f3daf32ee5f36458ecd06d0a89bf3e3bb
|
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.48.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,20 @@ 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
|
+
# Before copying a shared image, be sure to verify that it has been
|
452
|
+
# shared from the correct AWS account. To determine if an image has been
|
453
|
+
# shared and to see the AWS account ID that owns an image, use the
|
454
|
+
# [DescribeWorkSpaceImages][2] and
|
455
|
+
# [DescribeWorkspaceImagePermissions][3] API operations.
|
456
|
+
#
|
457
|
+
#
|
458
|
+
#
|
459
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/copy-custom-image.html
|
460
|
+
# [2]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImages.html
|
461
|
+
# [3]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceImagePermissions.html
|
403
462
|
#
|
404
463
|
# @option params [required, String] :name
|
405
464
|
# The name of the image.
|
@@ -448,6 +507,56 @@ module Aws::WorkSpaces
|
|
448
507
|
req.send_request(options)
|
449
508
|
end
|
450
509
|
|
510
|
+
# Creates the specified connection alias for use with cross-Region
|
511
|
+
# redirection. For more information, see [ Cross-Region Redirection for
|
512
|
+
# Amazon WorkSpaces][1].
|
513
|
+
#
|
514
|
+
#
|
515
|
+
#
|
516
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
517
|
+
#
|
518
|
+
# @option params [required, String] :connection_string
|
519
|
+
# A connection string in the form of a fully qualified domain name
|
520
|
+
# (FQDN), such as `www.example.com`.
|
521
|
+
#
|
522
|
+
# After you create a connection string, it is always associated to your
|
523
|
+
# AWS account. You cannot recreate the same connection string with a
|
524
|
+
# different account, even if you delete all instances of it from the
|
525
|
+
# original account. The connection string is globally reserved for your
|
526
|
+
# account.
|
527
|
+
#
|
528
|
+
# @option params [Array<Types::Tag>] :tags
|
529
|
+
# The tags to associate with the connection alias.
|
530
|
+
#
|
531
|
+
# @return [Types::CreateConnectionAliasResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
532
|
+
#
|
533
|
+
# * {Types::CreateConnectionAliasResult#alias_id #alias_id} => String
|
534
|
+
#
|
535
|
+
# @example Request syntax with placeholder values
|
536
|
+
#
|
537
|
+
# resp = client.create_connection_alias({
|
538
|
+
# connection_string: "ConnectionString", # required
|
539
|
+
# tags: [
|
540
|
+
# {
|
541
|
+
# key: "TagKey", # required
|
542
|
+
# value: "TagValue",
|
543
|
+
# },
|
544
|
+
# ],
|
545
|
+
# })
|
546
|
+
#
|
547
|
+
# @example Response structure
|
548
|
+
#
|
549
|
+
# resp.alias_id #=> String
|
550
|
+
#
|
551
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateConnectionAlias AWS API Documentation
|
552
|
+
#
|
553
|
+
# @overload create_connection_alias(params = {})
|
554
|
+
# @param [Hash] params ({})
|
555
|
+
def create_connection_alias(params = {}, options = {})
|
556
|
+
req = build_request(:create_connection_alias, params)
|
557
|
+
req.send_request(options)
|
558
|
+
end
|
559
|
+
|
451
560
|
# Creates an IP access control group.
|
452
561
|
#
|
453
562
|
# An IP access control group provides you with the ability to control
|
@@ -517,12 +626,10 @@ module Aws::WorkSpaces
|
|
517
626
|
# @option params [required, String] :resource_id
|
518
627
|
# The identifier of the WorkSpaces resource. The supported resource
|
519
628
|
# types are WorkSpaces, registered directories, images, custom bundles,
|
520
|
-
#
|
629
|
+
# IP access control groups, and connection aliases.
|
521
630
|
#
|
522
631
|
# @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.
|
632
|
+
# The tags. Each WorkSpaces resource can have a maximum of 50 tags.
|
526
633
|
#
|
527
634
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
528
635
|
#
|
@@ -639,6 +746,49 @@ module Aws::WorkSpaces
|
|
639
746
|
req.send_request(options)
|
640
747
|
end
|
641
748
|
|
749
|
+
# Deletes the specified connection alias. For more information, see [
|
750
|
+
# Cross-Region Redirection for Amazon WorkSpaces][1].
|
751
|
+
#
|
752
|
+
# **If you will no longer be using a fully qualified domain name (FQDN)
|
753
|
+
# as the registration code for your WorkSpaces users, you must take
|
754
|
+
# certain precautions to prevent potential security issues.** For more
|
755
|
+
# information, see [ Security Considerations if You Stop Using
|
756
|
+
# Cross-Region Redirection][2].
|
757
|
+
#
|
758
|
+
# <note markdown="1"> To delete a connection alias that has been shared, the shared account
|
759
|
+
# must first disassociate the connection alias from any directories it
|
760
|
+
# has been associated with. Then you must unshare the connection alias
|
761
|
+
# from the account it has been shared with. You can delete a connection
|
762
|
+
# alias only after it is no longer shared with any accounts or
|
763
|
+
# associated with any directories.
|
764
|
+
#
|
765
|
+
# </note>
|
766
|
+
#
|
767
|
+
#
|
768
|
+
#
|
769
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
770
|
+
# [2]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html#cross-region-redirection-security-considerations
|
771
|
+
#
|
772
|
+
# @option params [required, String] :alias_id
|
773
|
+
# The identifier of the connection alias to delete.
|
774
|
+
#
|
775
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
776
|
+
#
|
777
|
+
# @example Request syntax with placeholder values
|
778
|
+
#
|
779
|
+
# resp = client.delete_connection_alias({
|
780
|
+
# alias_id: "ConnectionAliasId", # required
|
781
|
+
# })
|
782
|
+
#
|
783
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteConnectionAlias AWS API Documentation
|
784
|
+
#
|
785
|
+
# @overload delete_connection_alias(params = {})
|
786
|
+
# @param [Hash] params ({})
|
787
|
+
def delete_connection_alias(params = {}, options = {})
|
788
|
+
req = build_request(:delete_connection_alias, params)
|
789
|
+
req.send_request(options)
|
790
|
+
end
|
791
|
+
|
642
792
|
# Deletes the specified IP access control group.
|
643
793
|
#
|
644
794
|
# You cannot delete an IP access control group that is associated with a
|
@@ -669,7 +819,7 @@ module Aws::WorkSpaces
|
|
669
819
|
# @option params [required, String] :resource_id
|
670
820
|
# The identifier of the WorkSpaces resource. The supported resource
|
671
821
|
# types are WorkSpaces, registered directories, images, custom bundles,
|
672
|
-
#
|
822
|
+
# IP access control groups, and connection aliases.
|
673
823
|
#
|
674
824
|
# @option params [required, Array<String>] :tag_keys
|
675
825
|
# The tag keys.
|
@@ -835,6 +985,114 @@ module Aws::WorkSpaces
|
|
835
985
|
req.send_request(options)
|
836
986
|
end
|
837
987
|
|
988
|
+
# Describes the permissions that the owner of a connection alias has
|
989
|
+
# granted to another AWS account for the specified connection alias. For
|
990
|
+
# more information, see [ Cross-Region Redirection for Amazon
|
991
|
+
# WorkSpaces][1].
|
992
|
+
#
|
993
|
+
#
|
994
|
+
#
|
995
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
996
|
+
#
|
997
|
+
# @option params [required, String] :alias_id
|
998
|
+
# The identifier of the connection alias.
|
999
|
+
#
|
1000
|
+
# @option params [String] :next_token
|
1001
|
+
# If you received a `NextToken` from a previous call that was paginated,
|
1002
|
+
# provide this token to receive the next set of results.
|
1003
|
+
#
|
1004
|
+
# @option params [Integer] :max_results
|
1005
|
+
# The maximum number of results to return.
|
1006
|
+
#
|
1007
|
+
# @return [Types::DescribeConnectionAliasPermissionsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1008
|
+
#
|
1009
|
+
# * {Types::DescribeConnectionAliasPermissionsResult#alias_id #alias_id} => String
|
1010
|
+
# * {Types::DescribeConnectionAliasPermissionsResult#connection_alias_permissions #connection_alias_permissions} => Array<Types::ConnectionAliasPermission>
|
1011
|
+
# * {Types::DescribeConnectionAliasPermissionsResult#next_token #next_token} => String
|
1012
|
+
#
|
1013
|
+
# @example Request syntax with placeholder values
|
1014
|
+
#
|
1015
|
+
# resp = client.describe_connection_alias_permissions({
|
1016
|
+
# alias_id: "ConnectionAliasId", # required
|
1017
|
+
# next_token: "PaginationToken",
|
1018
|
+
# max_results: 1,
|
1019
|
+
# })
|
1020
|
+
#
|
1021
|
+
# @example Response structure
|
1022
|
+
#
|
1023
|
+
# resp.alias_id #=> String
|
1024
|
+
# resp.connection_alias_permissions #=> Array
|
1025
|
+
# resp.connection_alias_permissions[0].shared_account_id #=> String
|
1026
|
+
# resp.connection_alias_permissions[0].allow_association #=> Boolean
|
1027
|
+
# resp.next_token #=> String
|
1028
|
+
#
|
1029
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliasPermissions AWS API Documentation
|
1030
|
+
#
|
1031
|
+
# @overload describe_connection_alias_permissions(params = {})
|
1032
|
+
# @param [Hash] params ({})
|
1033
|
+
def describe_connection_alias_permissions(params = {}, options = {})
|
1034
|
+
req = build_request(:describe_connection_alias_permissions, params)
|
1035
|
+
req.send_request(options)
|
1036
|
+
end
|
1037
|
+
|
1038
|
+
# Retrieves a list that describes the connection aliases used for
|
1039
|
+
# cross-Region redirection. For more information, see [ Cross-Region
|
1040
|
+
# Redirection for Amazon WorkSpaces][1].
|
1041
|
+
#
|
1042
|
+
#
|
1043
|
+
#
|
1044
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
1045
|
+
#
|
1046
|
+
# @option params [Array<String>] :alias_ids
|
1047
|
+
# The identifiers of the connection aliases to describe.
|
1048
|
+
#
|
1049
|
+
# @option params [String] :resource_id
|
1050
|
+
# The identifier of the directory associated with the connection alias.
|
1051
|
+
#
|
1052
|
+
# @option params [Integer] :limit
|
1053
|
+
# The maximum number of connection aliases to return.
|
1054
|
+
#
|
1055
|
+
# @option params [String] :next_token
|
1056
|
+
# If you received a `NextToken` from a previous call that was paginated,
|
1057
|
+
# provide this token to receive the next set of results.
|
1058
|
+
#
|
1059
|
+
# @return [Types::DescribeConnectionAliasesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1060
|
+
#
|
1061
|
+
# * {Types::DescribeConnectionAliasesResult#connection_aliases #connection_aliases} => Array<Types::ConnectionAlias>
|
1062
|
+
# * {Types::DescribeConnectionAliasesResult#next_token #next_token} => String
|
1063
|
+
#
|
1064
|
+
# @example Request syntax with placeholder values
|
1065
|
+
#
|
1066
|
+
# resp = client.describe_connection_aliases({
|
1067
|
+
# alias_ids: ["ConnectionAliasId"],
|
1068
|
+
# resource_id: "NonEmptyString",
|
1069
|
+
# limit: 1,
|
1070
|
+
# next_token: "PaginationToken",
|
1071
|
+
# })
|
1072
|
+
#
|
1073
|
+
# @example Response structure
|
1074
|
+
#
|
1075
|
+
# resp.connection_aliases #=> Array
|
1076
|
+
# resp.connection_aliases[0].connection_string #=> String
|
1077
|
+
# resp.connection_aliases[0].alias_id #=> String
|
1078
|
+
# resp.connection_aliases[0].state #=> String, one of "CREATING", "CREATED", "DELETING"
|
1079
|
+
# resp.connection_aliases[0].owner_account_id #=> String
|
1080
|
+
# resp.connection_aliases[0].associations #=> Array
|
1081
|
+
# 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"
|
1082
|
+
# resp.connection_aliases[0].associations[0].associated_account_id #=> String
|
1083
|
+
# resp.connection_aliases[0].associations[0].resource_id #=> String
|
1084
|
+
# resp.connection_aliases[0].associations[0].connection_identifier #=> String
|
1085
|
+
# resp.next_token #=> String
|
1086
|
+
#
|
1087
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliases AWS API Documentation
|
1088
|
+
#
|
1089
|
+
# @overload describe_connection_aliases(params = {})
|
1090
|
+
# @param [Hash] params ({})
|
1091
|
+
def describe_connection_aliases(params = {}, options = {})
|
1092
|
+
req = build_request(:describe_connection_aliases, params)
|
1093
|
+
req.send_request(options)
|
1094
|
+
end
|
1095
|
+
|
838
1096
|
# Describes one or more of your IP access control groups.
|
839
1097
|
#
|
840
1098
|
# @option params [Array<String>] :group_ids
|
@@ -885,7 +1143,7 @@ module Aws::WorkSpaces
|
|
885
1143
|
# @option params [required, String] :resource_id
|
886
1144
|
# The identifier of the WorkSpaces resource. The supported resource
|
887
1145
|
# types are WorkSpaces, registered directories, images, custom bundles,
|
888
|
-
#
|
1146
|
+
# IP access control groups, and connection aliases.
|
889
1147
|
#
|
890
1148
|
# @return [Types::DescribeTagsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
891
1149
|
#
|
@@ -1304,6 +1562,42 @@ module Aws::WorkSpaces
|
|
1304
1562
|
req.send_request(options)
|
1305
1563
|
end
|
1306
1564
|
|
1565
|
+
# Disassociates a connection alias from a directory. Disassociating a
|
1566
|
+
# connection alias disables cross-Region redirection between two
|
1567
|
+
# directories in different AWS Regions. For more information, see [
|
1568
|
+
# Cross-Region Redirection for Amazon WorkSpaces][1].
|
1569
|
+
#
|
1570
|
+
# <note markdown="1"> Before performing this operation, call [ DescribeConnectionAliases][2]
|
1571
|
+
# to make sure that the current state of the connection alias is
|
1572
|
+
# `CREATED`.
|
1573
|
+
#
|
1574
|
+
# </note>
|
1575
|
+
#
|
1576
|
+
#
|
1577
|
+
#
|
1578
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
1579
|
+
# [2]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html
|
1580
|
+
#
|
1581
|
+
# @option params [required, String] :alias_id
|
1582
|
+
# The identifier of the connection alias to disassociate.
|
1583
|
+
#
|
1584
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1585
|
+
#
|
1586
|
+
# @example Request syntax with placeholder values
|
1587
|
+
#
|
1588
|
+
# resp = client.disassociate_connection_alias({
|
1589
|
+
# alias_id: "ConnectionAliasId", # required
|
1590
|
+
# })
|
1591
|
+
#
|
1592
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DisassociateConnectionAlias AWS API Documentation
|
1593
|
+
#
|
1594
|
+
# @overload disassociate_connection_alias(params = {})
|
1595
|
+
# @param [Hash] params ({})
|
1596
|
+
def disassociate_connection_alias(params = {}, options = {})
|
1597
|
+
req = build_request(:disassociate_connection_alias, params)
|
1598
|
+
req.send_request(options)
|
1599
|
+
end
|
1600
|
+
|
1307
1601
|
# Disassociates the specified IP access control group from the specified
|
1308
1602
|
# directory.
|
1309
1603
|
#
|
@@ -1331,16 +1625,23 @@ module Aws::WorkSpaces
|
|
1331
1625
|
req.send_request(options)
|
1332
1626
|
end
|
1333
1627
|
|
1334
|
-
# Imports the specified Windows
|
1335
|
-
#
|
1336
|
-
#
|
1337
|
-
#
|
1628
|
+
# Imports the specified Windows 10 Bring Your Own License (BYOL) image
|
1629
|
+
# into Amazon WorkSpaces. The image must be an already licensed Amazon
|
1630
|
+
# EC2 image that is in your AWS account, and you must own the image. For
|
1631
|
+
# more information about creating BYOL images, see [ Bring Your Own
|
1632
|
+
# Windows Desktop Licenses][1].
|
1633
|
+
#
|
1634
|
+
#
|
1635
|
+
#
|
1636
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html
|
1338
1637
|
#
|
1339
1638
|
# @option params [required, String] :ec2_image_id
|
1340
1639
|
# The identifier of the EC2 image.
|
1341
1640
|
#
|
1342
1641
|
# @option params [required, String] :ingestion_process
|
1343
|
-
# The ingestion process to be used when importing the image.
|
1642
|
+
# The ingestion process to be used when importing the image. For
|
1643
|
+
# non-GPU-enabled bundles (bundles other than Graphics or GraphicsPro),
|
1644
|
+
# specify `BYOL_REGULAR`.
|
1344
1645
|
#
|
1345
1646
|
# @option params [required, String] :image_name
|
1346
1647
|
# The name of the WorkSpace image.
|
@@ -1351,6 +1652,21 @@ module Aws::WorkSpaces
|
|
1351
1652
|
# @option params [Array<Types::Tag>] :tags
|
1352
1653
|
# The tags. Each WorkSpaces resource can have a maximum of 50 tags.
|
1353
1654
|
#
|
1655
|
+
# @option params [Array<String>] :applications
|
1656
|
+
# If specified, the version of Microsoft Office to subscribe to. Valid
|
1657
|
+
# only for Windows 10 BYOL images. For more information about
|
1658
|
+
# subscribing to Office for BYOL images, see [ Bring Your Own Windows
|
1659
|
+
# Desktop Licenses][1].
|
1660
|
+
#
|
1661
|
+
# <note markdown="1"> Although this parameter is an array, only one item is allowed at this
|
1662
|
+
# time.
|
1663
|
+
#
|
1664
|
+
# </note>
|
1665
|
+
#
|
1666
|
+
#
|
1667
|
+
#
|
1668
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html
|
1669
|
+
#
|
1354
1670
|
# @return [Types::ImportWorkspaceImageResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1355
1671
|
#
|
1356
1672
|
# * {Types::ImportWorkspaceImageResult#image_id #image_id} => String
|
@@ -1368,6 +1684,7 @@ module Aws::WorkSpaces
|
|
1368
1684
|
# value: "TagValue",
|
1369
1685
|
# },
|
1370
1686
|
# ],
|
1687
|
+
# applications: ["Microsoft_Office_2016"], # accepts Microsoft_Office_2016, Microsoft_Office_2019
|
1371
1688
|
# })
|
1372
1689
|
#
|
1373
1690
|
# @example Response structure
|
@@ -1387,6 +1704,10 @@ module Aws::WorkSpaces
|
|
1387
1704
|
# that you can use for the network management interface when you enable
|
1388
1705
|
# Bring Your Own License (BYOL).
|
1389
1706
|
#
|
1707
|
+
# This operation can be run only by AWS accounts that are enabled for
|
1708
|
+
# BYOL. If your account isn't enabled for BYOL, you'll receive an
|
1709
|
+
# `AccessDeniedException` error.
|
1710
|
+
#
|
1390
1711
|
# The management network interface is connected to a secure Amazon
|
1391
1712
|
# WorkSpaces management network. It is used for interactive streaming of
|
1392
1713
|
# the WorkSpace desktop to Amazon WorkSpaces clients, and to allow
|
@@ -2034,12 +2355,21 @@ module Aws::WorkSpaces
|
|
2034
2355
|
#
|
2035
2356
|
# Terminating a WorkSpace is a permanent action and cannot be undone.
|
2036
2357
|
# The user's data is destroyed. If you need to archive any user data,
|
2037
|
-
# contact
|
2358
|
+
# contact AWS Support before terminating the WorkSpace.
|
2038
2359
|
#
|
2039
2360
|
# You can terminate a WorkSpace that is in any state except `SUSPENDED`.
|
2040
2361
|
#
|
2041
2362
|
# This operation is asynchronous and returns before the WorkSpaces have
|
2042
|
-
# been completely terminated.
|
2363
|
+
# been completely terminated. After a WorkSpace is terminated, the
|
2364
|
+
# `TERMINATED` state is returned only briefly before the WorkSpace
|
2365
|
+
# directory metadata is cleaned up, so this state is rarely returned. To
|
2366
|
+
# confirm that a WorkSpace is terminated, check for the WorkSpace ID by
|
2367
|
+
# using [ DescribeWorkSpaces][1]. If the WorkSpace ID isn't returned,
|
2368
|
+
# then the WorkSpace has been successfully terminated.
|
2369
|
+
#
|
2370
|
+
#
|
2371
|
+
#
|
2372
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html
|
2043
2373
|
#
|
2044
2374
|
# @option params [required, Array<Types::TerminateRequest>] :terminate_workspace_requests
|
2045
2375
|
# The WorkSpaces to terminate. You can specify up to 25 WorkSpaces.
|
@@ -2074,6 +2404,61 @@ module Aws::WorkSpaces
|
|
2074
2404
|
req.send_request(options)
|
2075
2405
|
end
|
2076
2406
|
|
2407
|
+
# Shares or unshares a connection alias with one account by specifying
|
2408
|
+
# whether that account has permission to associate the connection alias
|
2409
|
+
# with a directory. If the association permission is granted, the
|
2410
|
+
# connection alias is shared with that account. If the association
|
2411
|
+
# permission is revoked, the connection alias is unshared with the
|
2412
|
+
# account. For more information, see [ Cross-Region Redirection for
|
2413
|
+
# Amazon WorkSpaces][1].
|
2414
|
+
#
|
2415
|
+
# <note markdown="1"> * Before performing this operation, call [
|
2416
|
+
# DescribeConnectionAliases][2] to make sure that the current state of
|
2417
|
+
# the connection alias is `CREATED`.
|
2418
|
+
#
|
2419
|
+
# * To delete a connection alias that has been shared, the shared
|
2420
|
+
# account must first disassociate the connection alias from any
|
2421
|
+
# directories it has been associated with. Then you must unshare the
|
2422
|
+
# connection alias from the account it has been shared with. You can
|
2423
|
+
# delete a connection alias only after it is no longer shared with any
|
2424
|
+
# accounts or associated with any directories.
|
2425
|
+
#
|
2426
|
+
# </note>
|
2427
|
+
#
|
2428
|
+
#
|
2429
|
+
#
|
2430
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html
|
2431
|
+
# [2]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeConnectionAliases.html
|
2432
|
+
#
|
2433
|
+
# @option params [required, String] :alias_id
|
2434
|
+
# The identifier of the connection alias that you want to update
|
2435
|
+
# permissions for.
|
2436
|
+
#
|
2437
|
+
# @option params [required, Types::ConnectionAliasPermission] :connection_alias_permission
|
2438
|
+
# Indicates whether to share or unshare the connection alias with the
|
2439
|
+
# specified AWS account.
|
2440
|
+
#
|
2441
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2442
|
+
#
|
2443
|
+
# @example Request syntax with placeholder values
|
2444
|
+
#
|
2445
|
+
# resp = client.update_connection_alias_permission({
|
2446
|
+
# alias_id: "ConnectionAliasId", # required
|
2447
|
+
# connection_alias_permission: { # required
|
2448
|
+
# shared_account_id: "AwsAccount", # required
|
2449
|
+
# allow_association: false, # required
|
2450
|
+
# },
|
2451
|
+
# })
|
2452
|
+
#
|
2453
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateConnectionAliasPermission AWS API Documentation
|
2454
|
+
#
|
2455
|
+
# @overload update_connection_alias_permission(params = {})
|
2456
|
+
# @param [Hash] params ({})
|
2457
|
+
def update_connection_alias_permission(params = {}, options = {})
|
2458
|
+
req = build_request(:update_connection_alias_permission, params)
|
2459
|
+
req.send_request(options)
|
2460
|
+
end
|
2461
|
+
|
2077
2462
|
# Replaces the current rules of the specified IP access control group
|
2078
2463
|
# with the specified rules.
|
2079
2464
|
#
|
@@ -2110,7 +2495,8 @@ module Aws::WorkSpaces
|
|
2110
2495
|
# that account has permission to copy the image. If the copy image
|
2111
2496
|
# permission is granted, the image is shared with that account. If the
|
2112
2497
|
# copy image permission is revoked, the image is unshared with the
|
2113
|
-
# account.
|
2498
|
+
# account. For more information about sharing images, see [ Share or
|
2499
|
+
# Unshare a Custom WorkSpaces Image][1].
|
2114
2500
|
#
|
2115
2501
|
# <note markdown="1"> * To delete an image that has been shared, you must unshare the image
|
2116
2502
|
# before you delete it.
|
@@ -2122,6 +2508,10 @@ module Aws::WorkSpaces
|
|
2122
2508
|
#
|
2123
2509
|
# </note>
|
2124
2510
|
#
|
2511
|
+
#
|
2512
|
+
#
|
2513
|
+
# [1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/share-custom-image.html
|
2514
|
+
#
|
2125
2515
|
# @option params [required, String] :image_id
|
2126
2516
|
# The identifier of the image.
|
2127
2517
|
#
|
@@ -2132,6 +2522,9 @@ module Aws::WorkSpaces
|
|
2132
2522
|
# @option params [required, String] :shared_account_id
|
2133
2523
|
# The identifier of the AWS account to share or unshare the image with.
|
2134
2524
|
#
|
2525
|
+
# Before sharing the image, confirm that you are sharing to the correct
|
2526
|
+
# AWS account ID.
|
2527
|
+
#
|
2135
2528
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2136
2529
|
#
|
2137
2530
|
# @example Request syntax with placeholder values
|
@@ -2164,7 +2557,7 @@ module Aws::WorkSpaces
|
|
2164
2557
|
params: params,
|
2165
2558
|
config: config)
|
2166
2559
|
context[:gem_name] = 'aws-sdk-workspaces'
|
2167
|
-
context[:gem_version] = '1.
|
2560
|
+
context[:gem_version] = '1.48.0'
|
2168
2561
|
Seahorse::Client::Request.new(handlers, context)
|
2169
2562
|
end
|
2170
2563
|
|