aws-sdk-workspaces 1.48.0 → 1.53.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.
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -3,7 +3,7 @@
3
3
  # WARNING ABOUT GENERATED CODE
4
4
  #
5
5
  # This file is generated. See the contributing guide for more information:
6
- # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
@@ -212,7 +212,14 @@ module Aws::WorkSpaces
212
212
  include Aws::Structure
213
213
  end
214
214
 
215
- # Describes the compute type.
215
+ # Describes the compute type of the bundle.
216
+ #
217
+ # @note When making an API call, you may pass ComputeType
218
+ # data as a hash:
219
+ #
220
+ # {
221
+ # name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO
222
+ # }
216
223
  #
217
224
  # @!attribute [rw] name
218
225
  # The compute type.
@@ -545,6 +552,90 @@ module Aws::WorkSpaces
545
552
  #
546
553
  class CreateTagsResult < Aws::EmptyStructure; end
547
554
 
555
+ # @note When making an API call, you may pass CreateWorkspaceBundleRequest
556
+ # data as a hash:
557
+ #
558
+ # {
559
+ # bundle_name: "WorkspaceBundleName", # required
560
+ # bundle_description: "WorkspaceBundleDescription", # required
561
+ # image_id: "WorkspaceImageId", # required
562
+ # compute_type: { # required
563
+ # name: "VALUE", # accepts VALUE, STANDARD, PERFORMANCE, POWER, GRAPHICS, POWERPRO, GRAPHICSPRO
564
+ # },
565
+ # user_storage: { # required
566
+ # capacity: "NonEmptyString",
567
+ # },
568
+ # root_storage: {
569
+ # capacity: "NonEmptyString",
570
+ # },
571
+ # tags: [
572
+ # {
573
+ # key: "TagKey", # required
574
+ # value: "TagValue",
575
+ # },
576
+ # ],
577
+ # }
578
+ #
579
+ # @!attribute [rw] bundle_name
580
+ # The name of the bundle.
581
+ # @return [String]
582
+ #
583
+ # @!attribute [rw] bundle_description
584
+ # The description of the bundle.
585
+ # @return [String]
586
+ #
587
+ # @!attribute [rw] image_id
588
+ # The identifier of the image that is used to create the bundle.
589
+ # @return [String]
590
+ #
591
+ # @!attribute [rw] compute_type
592
+ # Describes the compute type of the bundle.
593
+ # @return [Types::ComputeType]
594
+ #
595
+ # @!attribute [rw] user_storage
596
+ # Describes the user volume for a WorkSpace bundle.
597
+ # @return [Types::UserStorage]
598
+ #
599
+ # @!attribute [rw] root_storage
600
+ # Describes the root volume for a WorkSpace bundle.
601
+ # @return [Types::RootStorage]
602
+ #
603
+ # @!attribute [rw] tags
604
+ # The tags associated with the bundle.
605
+ #
606
+ # <note markdown="1"> To add tags at the same time when you're creating the bundle, you
607
+ # must create an IAM policy that grants your IAM user permissions to
608
+ # use `workspaces:CreateTags`.
609
+ #
610
+ # </note>
611
+ # @return [Array<Types::Tag>]
612
+ #
613
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaceBundleRequest AWS API Documentation
614
+ #
615
+ class CreateWorkspaceBundleRequest < Struct.new(
616
+ :bundle_name,
617
+ :bundle_description,
618
+ :image_id,
619
+ :compute_type,
620
+ :user_storage,
621
+ :root_storage,
622
+ :tags)
623
+ SENSITIVE = []
624
+ include Aws::Structure
625
+ end
626
+
627
+ # @!attribute [rw] workspace_bundle
628
+ # Describes a WorkSpace bundle.
629
+ # @return [Types::WorkspaceBundle]
630
+ #
631
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/CreateWorkspaceBundleResult AWS API Documentation
632
+ #
633
+ class CreateWorkspaceBundleResult < Struct.new(
634
+ :workspace_bundle)
635
+ SENSITIVE = []
636
+ include Aws::Structure
637
+ end
638
+
548
639
  # @note When making an API call, you may pass CreateWorkspacesRequest
549
640
  # data as a hash:
550
641
  #
@@ -757,6 +848,29 @@ module Aws::WorkSpaces
757
848
  #
758
849
  class DeleteTagsResult < Aws::EmptyStructure; end
759
850
 
851
+ # @note When making an API call, you may pass DeleteWorkspaceBundleRequest
852
+ # data as a hash:
853
+ #
854
+ # {
855
+ # bundle_id: "BundleId",
856
+ # }
857
+ #
858
+ # @!attribute [rw] bundle_id
859
+ # The identifier of the bundle.
860
+ # @return [String]
861
+ #
862
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteWorkspaceBundleRequest AWS API Documentation
863
+ #
864
+ class DeleteWorkspaceBundleRequest < Struct.new(
865
+ :bundle_id)
866
+ SENSITIVE = []
867
+ include Aws::Structure
868
+ end
869
+
870
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DeleteWorkspaceBundleResult AWS API Documentation
871
+ #
872
+ class DeleteWorkspaceBundleResult < Aws::EmptyStructure; end
873
+
760
874
  # @note When making an API call, you may pass DeleteWorkspaceImageRequest
761
875
  # data as a hash:
762
876
  #
@@ -831,8 +945,8 @@ module Aws::WorkSpaces
831
945
  # @return [Array<Types::AccountModification>]
832
946
  #
833
947
  # @!attribute [rw] next_token
834
- # The token to use to retrieve the next set of results, or null if no
835
- # more results are available.
948
+ # The token to use to retrieve the next page of results. This value is
949
+ # null when there are no more results to return.
836
950
  # @return [String]
837
951
  #
838
952
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeAccountModificationsResult AWS API Documentation
@@ -945,8 +1059,8 @@ module Aws::WorkSpaces
945
1059
  # @return [Array<Types::ConnectionAliasPermission>]
946
1060
  #
947
1061
  # @!attribute [rw] next_token
948
- # The token to use to retrieve the next set of results, or null if no
949
- # more results are available.
1062
+ # The token to use to retrieve the next page of results. This value is
1063
+ # null when there are no more results to return.
950
1064
  # @return [String]
951
1065
  #
952
1066
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliasPermissionsResult AWS API Documentation
@@ -1003,8 +1117,8 @@ module Aws::WorkSpaces
1003
1117
  # @return [Array<Types::ConnectionAlias>]
1004
1118
  #
1005
1119
  # @!attribute [rw] next_token
1006
- # The token to use to retrieve the next set of results, or null if no
1007
- # more results are available.
1120
+ # The token to use to retrieve the next page of results. This value is
1121
+ # null when there are no more results to return.
1008
1122
  # @return [String]
1009
1123
  #
1010
1124
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeConnectionAliasesResult AWS API Documentation
@@ -1053,8 +1167,8 @@ module Aws::WorkSpaces
1053
1167
  # @return [Array<Types::WorkspacesIpGroup>]
1054
1168
  #
1055
1169
  # @!attribute [rw] next_token
1056
- # The token to use to retrieve the next set of results, or null if no
1057
- # more results are available.
1170
+ # The token to use to retrieve the next page of results. This value is
1171
+ # null when there are no more results to return.
1058
1172
  # @return [String]
1059
1173
  #
1060
1174
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeIpGroupsResult AWS API Documentation
@@ -1117,8 +1231,9 @@ module Aws::WorkSpaces
1117
1231
  # The owner of the bundles. You cannot combine this parameter with any
1118
1232
  # other filter.
1119
1233
  #
1120
- # Specify `AMAZON` to describe the bundles provided by AWS or null to
1121
- # describe the bundles that belong to your account.
1234
+ # To describe the bundles provided by AWS, specify `AMAZON`. To
1235
+ # describe the bundles that belong to your account, don't specify a
1236
+ # value.
1122
1237
  # @return [String]
1123
1238
  #
1124
1239
  # @!attribute [rw] next_token
@@ -1141,9 +1256,9 @@ module Aws::WorkSpaces
1141
1256
  # @return [Array<Types::WorkspaceBundle>]
1142
1257
  #
1143
1258
  # @!attribute [rw] next_token
1144
- # The token to use to retrieve the next set of results, or null if
1145
- # there are no more results available. This token is valid for one day
1146
- # and must be used within that time frame.
1259
+ # The token to use to retrieve the next page of results. This value is
1260
+ # null when there are no more results to return. This token is valid
1261
+ # for one day and must be used within that time frame.
1147
1262
  # @return [String]
1148
1263
  #
1149
1264
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceBundlesResult AWS API Documentation
@@ -1193,8 +1308,8 @@ module Aws::WorkSpaces
1193
1308
  # @return [Array<Types::WorkspaceDirectory>]
1194
1309
  #
1195
1310
  # @!attribute [rw] next_token
1196
- # The token to use to retrieve the next set of results, or null if no
1197
- # more results are available.
1311
+ # The token to use to retrieve the next page of results. This value is
1312
+ # null when there are no more results to return.
1198
1313
  # @return [String]
1199
1314
  #
1200
1315
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceDirectoriesResult AWS API Documentation
@@ -1248,8 +1363,8 @@ module Aws::WorkSpaces
1248
1363
  # @return [Array<Types::ImagePermission>]
1249
1364
  #
1250
1365
  # @!attribute [rw] next_token
1251
- # The token to use to retrieve the next set of results, or null if no
1252
- # more results are available.
1366
+ # The token to use to retrieve the next page of results. This value is
1367
+ # null when there are no more results to return.
1253
1368
  # @return [String]
1254
1369
  #
1255
1370
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImagePermissionsResult AWS API Documentation
@@ -1305,8 +1420,8 @@ module Aws::WorkSpaces
1305
1420
  # @return [Array<Types::WorkspaceImage>]
1306
1421
  #
1307
1422
  # @!attribute [rw] next_token
1308
- # The token to use to retrieve the next set of results, or null if no
1309
- # more results are available.
1423
+ # The token to use to retrieve the next page of results. This value is
1424
+ # null when there are no more results to return.
1310
1425
  # @return [String]
1311
1426
  #
1312
1427
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspaceImagesResult AWS API Documentation
@@ -1389,8 +1504,8 @@ module Aws::WorkSpaces
1389
1504
  # @return [Array<Types::WorkspaceConnectionStatus>]
1390
1505
  #
1391
1506
  # @!attribute [rw] next_token
1392
- # The token to use to retrieve the next set of results, or null if no
1393
- # more results are available.
1507
+ # The token to use to retrieve the next page of results. This value is
1508
+ # null when there are no more results to return.
1394
1509
  # @return [String]
1395
1510
  #
1396
1511
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesConnectionStatusResult AWS API Documentation
@@ -1471,8 +1586,8 @@ module Aws::WorkSpaces
1471
1586
  # @return [Array<Types::Workspace>]
1472
1587
  #
1473
1588
  # @!attribute [rw] next_token
1474
- # The token to use to retrieve the next set of results, or null if no
1475
- # more results are available.
1589
+ # The token to use to retrieve the next page of results. This value is
1590
+ # null when there are no more results to return.
1476
1591
  # @return [String]
1477
1592
  #
1478
1593
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/DescribeWorkspacesResult AWS API Documentation
@@ -1615,7 +1730,7 @@ module Aws::WorkSpaces
1615
1730
  #
1616
1731
  # {
1617
1732
  # ec2_image_id: "Ec2ImageId", # required
1618
- # ingestion_process: "BYOL_REGULAR", # required, accepts BYOL_REGULAR, BYOL_GRAPHICS, BYOL_GRAPHICSPRO
1733
+ # ingestion_process: "BYOL_REGULAR", # required, accepts BYOL_REGULAR, BYOL_GRAPHICS, BYOL_GRAPHICSPRO, BYOL_REGULAR_WSP
1619
1734
  # image_name: "WorkspaceImageName", # required
1620
1735
  # image_description: "WorkspaceImageDescription", # required
1621
1736
  # tags: [
@@ -1632,9 +1747,15 @@ module Aws::WorkSpaces
1632
1747
  # @return [String]
1633
1748
  #
1634
1749
  # @!attribute [rw] ingestion_process
1635
- # The ingestion process to be used when importing the image. For
1636
- # non-GPU-enabled bundles (bundles other than Graphics or
1637
- # GraphicsPro), specify `BYOL_REGULAR`.
1750
+ # The ingestion process to be used when importing the image, depending
1751
+ # on which protocol you want to use for your BYOL Workspace image,
1752
+ # either PCoIP or WorkSpaces Streaming Protocol (WSP). To use WSP,
1753
+ # specify a value that ends in `_WSP`. To use PCoIP, specify a value
1754
+ # that does not end in `_WSP`.
1755
+ #
1756
+ # For non-GPU-enabled bundles (bundles other than Graphics or
1757
+ # GraphicsPro), specify `BYOL_REGULAR` or `BYOL_REGULAR_WSP`,
1758
+ # depending on the protocol.
1638
1759
  # @return [String]
1639
1760
  #
1640
1761
  # @!attribute [rw] image_name
@@ -1784,8 +1905,8 @@ module Aws::WorkSpaces
1784
1905
  # @return [Array<String>]
1785
1906
  #
1786
1907
  # @!attribute [rw] next_token
1787
- # The token to use to retrieve the next set of results, or null if no
1788
- # more results are available.
1908
+ # The token to use to retrieve the next page of results. This value is
1909
+ # null when there are no more results to return.
1789
1910
  # @return [String]
1790
1911
  #
1791
1912
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/ListAvailableManagementCidrRangesResult AWS API Documentation
@@ -1974,6 +2095,7 @@ module Aws::WorkSpaces
1974
2095
  # device_type_android: "ALLOW", # accepts ALLOW, DENY
1975
2096
  # device_type_chrome_os: "ALLOW", # accepts ALLOW, DENY
1976
2097
  # device_type_zero_client: "ALLOW", # accepts ALLOW, DENY
2098
+ # device_type_linux: "ALLOW", # accepts ALLOW, DENY
1977
2099
  # },
1978
2100
  # }
1979
2101
  #
@@ -2478,6 +2600,13 @@ module Aws::WorkSpaces
2478
2600
 
2479
2601
  # Describes the root volume for a WorkSpace bundle.
2480
2602
  #
2603
+ # @note When making an API call, you may pass RootStorage
2604
+ # data as a hash:
2605
+ #
2606
+ # {
2607
+ # capacity: "NonEmptyString",
2608
+ # }
2609
+ #
2481
2610
  # @!attribute [rw] capacity
2482
2611
  # The size of the root volume.
2483
2612
  # @return [String]
@@ -2861,6 +2990,35 @@ module Aws::WorkSpaces
2861
2990
  #
2862
2991
  class UpdateRulesOfIpGroupResult < Aws::EmptyStructure; end
2863
2992
 
2993
+ # @note When making an API call, you may pass UpdateWorkspaceBundleRequest
2994
+ # data as a hash:
2995
+ #
2996
+ # {
2997
+ # bundle_id: "BundleId",
2998
+ # image_id: "WorkspaceImageId",
2999
+ # }
3000
+ #
3001
+ # @!attribute [rw] bundle_id
3002
+ # The identifier of the bundle.
3003
+ # @return [String]
3004
+ #
3005
+ # @!attribute [rw] image_id
3006
+ # The identifier of the image.
3007
+ # @return [String]
3008
+ #
3009
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceBundleRequest AWS API Documentation
3010
+ #
3011
+ class UpdateWorkspaceBundleRequest < Struct.new(
3012
+ :bundle_id,
3013
+ :image_id)
3014
+ SENSITIVE = []
3015
+ include Aws::Structure
3016
+ end
3017
+
3018
+ # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UpdateWorkspaceBundleResult AWS API Documentation
3019
+ #
3020
+ class UpdateWorkspaceBundleResult < Aws::EmptyStructure; end
3021
+
2864
3022
  # @note When making an API call, you may pass UpdateWorkspaceImagePermissionRequest
2865
3023
  # data as a hash:
2866
3024
  #
@@ -2901,10 +3059,17 @@ module Aws::WorkSpaces
2901
3059
  #
2902
3060
  class UpdateWorkspaceImagePermissionResult < Aws::EmptyStructure; end
2903
3061
 
2904
- # Describes the user storage for a WorkSpace bundle.
3062
+ # Describes the user volume for a WorkSpace bundle.
3063
+ #
3064
+ # @note When making an API call, you may pass UserStorage
3065
+ # data as a hash:
3066
+ #
3067
+ # {
3068
+ # capacity: "NonEmptyString",
3069
+ # }
2905
3070
  #
2906
3071
  # @!attribute [rw] capacity
2907
- # The size of the user storage.
3072
+ # The size of the user volume.
2908
3073
  # @return [String]
2909
3074
  #
2910
3075
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/UserStorage AWS API Documentation
@@ -3041,6 +3206,7 @@ module Aws::WorkSpaces
3041
3206
  # device_type_android: "ALLOW", # accepts ALLOW, DENY
3042
3207
  # device_type_chrome_os: "ALLOW", # accepts ALLOW, DENY
3043
3208
  # device_type_zero_client: "ALLOW", # accepts ALLOW, DENY
3209
+ # device_type_linux: "ALLOW", # accepts ALLOW, DENY
3044
3210
  # }
3045
3211
  #
3046
3212
  # @!attribute [rw] device_type_windows
@@ -3092,6 +3258,11 @@ module Aws::WorkSpaces
3092
3258
  # WorkSpaces.
3093
3259
  # @return [String]
3094
3260
  #
3261
+ # @!attribute [rw] device_type_linux
3262
+ # Indicates whether users can use Linux clients to access their
3263
+ # WorkSpaces.
3264
+ # @return [String]
3265
+ #
3095
3266
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceAccessProperties AWS API Documentation
3096
3267
  #
3097
3268
  class WorkspaceAccessProperties < Struct.new(
@@ -3101,7 +3272,8 @@ module Aws::WorkSpaces
3101
3272
  :device_type_ios,
3102
3273
  :device_type_android,
3103
3274
  :device_type_chrome_os,
3104
- :device_type_zero_client)
3275
+ :device_type_zero_client,
3276
+ :device_type_linux)
3105
3277
  SENSITIVE = []
3106
3278
  include Aws::Structure
3107
3279
  end
@@ -3109,7 +3281,7 @@ module Aws::WorkSpaces
3109
3281
  # Describes a WorkSpace bundle.
3110
3282
  #
3111
3283
  # @!attribute [rw] bundle_id
3112
- # The bundle identifier.
3284
+ # The identifier of the bundle.
3113
3285
  # @return [String]
3114
3286
  #
3115
3287
  # @!attribute [rw] name
@@ -3122,11 +3294,11 @@ module Aws::WorkSpaces
3122
3294
  # @return [String]
3123
3295
  #
3124
3296
  # @!attribute [rw] description
3125
- # A description.
3297
+ # The description of the bundle.
3126
3298
  # @return [String]
3127
3299
  #
3128
3300
  # @!attribute [rw] image_id
3129
- # The image identifier of the bundle.
3301
+ # The identifier of the image that was used to create the bundle.
3130
3302
  # @return [String]
3131
3303
  #
3132
3304
  # @!attribute [rw] root_storage
@@ -3134,12 +3306,12 @@ module Aws::WorkSpaces
3134
3306
  # @return [Types::RootStorage]
3135
3307
  #
3136
3308
  # @!attribute [rw] user_storage
3137
- # The size of the user storage.
3309
+ # The size of the user volume.
3138
3310
  # @return [Types::UserStorage]
3139
3311
  #
3140
3312
  # @!attribute [rw] compute_type
3141
- # The compute type. For more information, see [Amazon WorkSpaces
3142
- # Bundles][1].
3313
+ # The compute type of the bundle. For more information, see [Amazon
3314
+ # WorkSpaces Bundles][1].
3143
3315
  #
3144
3316
  #
3145
3317
  #
@@ -3150,6 +3322,10 @@ module Aws::WorkSpaces
3150
3322
  # The last time that the bundle was updated.
3151
3323
  # @return [Time]
3152
3324
  #
3325
+ # @!attribute [rw] creation_time
3326
+ # The time when the bundle was created.
3327
+ # @return [Time]
3328
+ #
3153
3329
  # @see http://docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceBundle AWS API Documentation
3154
3330
  #
3155
3331
  class WorkspaceBundle < Struct.new(
@@ -3161,7 +3337,8 @@ module Aws::WorkSpaces
3161
3337
  :root_storage,
3162
3338
  :user_storage,
3163
3339
  :compute_type,
3164
- :last_updated_time)
3340
+ :last_updated_time,
3341
+ :creation_time)
3165
3342
  SENSITIVE = []
3166
3343
  include Aws::Structure
3167
3344
  end