Skip to content

Commit db00544

Browse files
author
AWS
committed
Amazon WorkSpaces Update: Adds API support for WorkSpaces bundle management operations.
1 parent 24ba349 commit db00544

File tree

2 files changed

+161
-20
lines changed

2 files changed

+161
-20
lines changed

‎.changes/next-release/feature-AmazonWorkSpaces-50231c6.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon WorkSpaces",
4+
"contributor": "",
5+
"description": "Adds API support for WorkSpaces bundle management operations."
6+
}

‎services/workspaces/src/main/resources/codegen-resources/service-2.json

Lines changed: 155 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,24 @@
134134
],
135135
"documentation":"<p>Creates the specified tags for the specified WorkSpaces resource.</p>"
136136
},
137+
"CreateWorkspaceBundle":{
138+
"name":"CreateWorkspaceBundle",
139+
"http":{
140+
"method":"POST",
141+
"requestUri":"/"
142+
},
143+
"input":{"shape":"CreateWorkspaceBundleRequest"},
144+
"output":{"shape":"CreateWorkspaceBundleResult"},
145+
"errors":[
146+
{"shape":"ResourceUnavailableException"},
147+
{"shape":"ResourceAlreadyExistsException"},
148+
{"shape":"ResourceLimitExceededException"},
149+
{"shape":"InvalidParameterValuesException"},
150+
{"shape":"ResourceNotFoundException"},
151+
{"shape":"AccessDeniedException"}
152+
],
153+
"documentation":"<p>Creates the specified WorkSpace bundle. For more information about creating WorkSpace bundles, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/create-custom-bundle.html\"> Create a Custom WorkSpaces Image and Bundle</a>.</p>"
154+
},
137155
"CreateWorkspaces":{
138156
"name":"CreateWorkspaces",
139157
"http":{
@@ -196,6 +214,22 @@
196214
],
197215
"documentation":"<p>Deletes the specified tags from the specified WorkSpaces resource.</p>"
198216
},
217+
"DeleteWorkspaceBundle":{
218+
"name":"DeleteWorkspaceBundle",
219+
"http":{
220+
"method":"POST",
221+
"requestUri":"/"
222+
},
223+
"input":{"shape":"DeleteWorkspaceBundleRequest"},
224+
"output":{"shape":"DeleteWorkspaceBundleResult"},
225+
"errors":[
226+
{"shape":"InvalidParameterValuesException"},
227+
{"shape":"ResourceNotFoundException"},
228+
{"shape":"ResourceAssociatedException"},
229+
{"shape":"AccessDeniedException"}
230+
],
231+
"documentation":"<p>Deletes the specified WorkSpace bundle. For more information about deleting WorkSpace bundles, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/delete_bundle.html\"> Delete a Custom WorkSpaces Bundle or Image</a>.</p>"
232+
},
199233
"DeleteWorkspaceImage":{
200234
"name":"DeleteWorkspaceImage",
201235
"http":{
@@ -754,6 +788,22 @@
754788
],
755789
"documentation":"<p>Replaces the current rules of the specified IP access control group with the specified rules.</p>"
756790
},
791+
"UpdateWorkspaceBundle":{
792+
"name":"UpdateWorkspaceBundle",
793+
"http":{
794+
"method":"POST",
795+
"requestUri":"/"
796+
},
797+
"input":{"shape":"UpdateWorkspaceBundleRequest"},
798+
"output":{"shape":"UpdateWorkspaceBundleResult"},
799+
"errors":[
800+
{"shape":"AccessDeniedException"},
801+
{"shape":"InvalidParameterValuesException"},
802+
{"shape":"ResourceNotFoundException"},
803+
{"shape":"ResourceUnavailableException"}
804+
],
805+
"documentation":"<p>Updates a WorkSpace bundle with a new image. For more information about updating WorkSpace bundles, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/update-custom-bundle.html\"> Update a Custom WorkSpaces Bundle</a>.</p> <important> <p>Existing WorkSpaces aren't automatically updated when you update the bundle that they're based on. To update existing WorkSpaces that are based on a bundle that you've updated, you must either rebuild the WorkSpaces or delete and recreate them.</p> </important>"
806+
},
757807
"UpdateWorkspaceImagePermission":{
758808
"name":"UpdateWorkspaceImagePermission",
759809
"http":{
@@ -988,7 +1038,7 @@
9881038
"documentation":"<p>The compute type.</p>"
9891039
}
9901040
},
991-
"documentation":"<p>Describes the compute type.</p>"
1041+
"documentation":"<p>Describes the compute type of the bundle.</p>"
9921042
},
9931043
"ComputerName":{"type":"string"},
9941044
"ConnectionAlias":{
@@ -1230,6 +1280,43 @@
12301280
"members":{
12311281
}
12321282
},
1283+
"CreateWorkspaceBundleRequest":{
1284+
"type":"structure",
1285+
"required":[
1286+
"BundleName",
1287+
"BundleDescription",
1288+
"ImageId",
1289+
"ComputeType",
1290+
"UserStorage"
1291+
],
1292+
"members":{
1293+
"BundleName":{
1294+
"shape":"WorkspaceBundleName",
1295+
"documentation":"<p>The name of the bundle.</p>"
1296+
},
1297+
"BundleDescription":{
1298+
"shape":"WorkspaceBundleDescription",
1299+
"documentation":"<p>The description of the bundle.</p>"
1300+
},
1301+
"ImageId":{
1302+
"shape":"WorkspaceImageId",
1303+
"documentation":"<p>The identifier of the image that is used to create the bundle.</p>"
1304+
},
1305+
"ComputeType":{"shape":"ComputeType"},
1306+
"UserStorage":{"shape":"UserStorage"},
1307+
"RootStorage":{"shape":"RootStorage"},
1308+
"Tags":{
1309+
"shape":"TagList",
1310+
"documentation":"<p>The tags associated with the bundle.</p> <note> <p>To add tags at the same time that you're creating the bundle, you must create an IAM policy that grants your IAM user permissions to use <code>workspaces:CreateTags</code>. </p> </note>"
1311+
}
1312+
}
1313+
},
1314+
"CreateWorkspaceBundleResult":{
1315+
"type":"structure",
1316+
"members":{
1317+
"WorkspaceBundle":{"shape":"WorkspaceBundle"}
1318+
}
1319+
},
12331320
"CreateWorkspacesRequest":{
12341321
"type":"structure",
12351322
"required":["Workspaces"],
@@ -1363,6 +1450,20 @@
13631450
"members":{
13641451
}
13651452
},
1453+
"DeleteWorkspaceBundleRequest":{
1454+
"type":"structure",
1455+
"members":{
1456+
"BundleId":{
1457+
"shape":"BundleId",
1458+
"documentation":"<p>The identifier of the bundle.</p>"
1459+
}
1460+
}
1461+
},
1462+
"DeleteWorkspaceBundleResult":{
1463+
"type":"structure",
1464+
"members":{
1465+
}
1466+
},
13661467
"DeleteWorkspaceImageRequest":{
13671468
"type":"structure",
13681469
"required":["ImageId"],
@@ -1411,7 +1512,7 @@
14111512
},
14121513
"NextToken":{
14131514
"shape":"PaginationToken",
1414-
"documentation":"<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>"
1515+
"documentation":"<p>The token to use to retrieve the next page of results. This value is null when there are no more results to return. </p>"
14151516
}
14161517
}
14171518
},
@@ -1483,7 +1584,7 @@
14831584
},
14841585
"NextToken":{
14851586
"shape":"PaginationToken",
1486-
"documentation":"<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>"
1587+
"documentation":"<p>The token to use to retrieve the next page of results. This value is null when there are no more results to return. </p>"
14871588
}
14881589
}
14891590
},
@@ -1517,7 +1618,7 @@
15171618
},
15181619
"NextToken":{
15191620
"shape":"PaginationToken",
1520-
"documentation":"<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>"
1621+
"documentation":"<p>The token to use to retrieve the next page of results. This value is null when there are no more results to return. </p>"
15211622
}
15221623
}
15231624
},
@@ -1547,7 +1648,7 @@
15471648
},
15481649
"NextToken":{
15491650
"shape":"PaginationToken",
1550-
"documentation":"<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>"
1651+
"documentation":"<p>The token to use to retrieve the next page of results. This value is null when there are no more results to return. </p>"
15511652
}
15521653
}
15531654
},
@@ -1579,7 +1680,7 @@
15791680
},
15801681
"Owner":{
15811682
"shape":"BundleOwner",
1582-
"documentation":"<p>The owner of the bundles. You cannot combine this parameter with any other filter.</p> <p>Specify <code>AMAZON</code> to describe the bundles provided by AWS or null to describe the bundles that belong to your account.</p>"
1683+
"documentation":"<p>The owner of the bundles. You cannot combine this parameter with any other filter.</p> <p>To describe the bundles provided by AWS, specify <code>AMAZON</code>. To describe the bundles that belong to your account, don't specify a value.</p>"
15831684
},
15841685
"NextToken":{
15851686
"shape":"PaginationToken",
@@ -1596,7 +1697,7 @@
15961697
},
15971698
"NextToken":{
15981699
"shape":"PaginationToken",
1599-
"documentation":"<p>The token to use to retrieve the next set of results, or null if there are no more results available. This token is valid for one day and must be used within that time frame.</p>"
1700+
"documentation":"<p>The token to use to retrieve the next page of results. This value is null when there are no more results to return. This token is valid for one day and must be used within that time frame.</p>"
16001701
}
16011702
}
16021703
},
@@ -1626,7 +1727,7 @@
16261727
},
16271728
"NextToken":{
16281729
"shape":"PaginationToken",
1629-
"documentation":"<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>"
1730+
"documentation":"<p>The token to use to retrieve the next page of results. This value is null when there are no more results to return. </p>"
16301731
}
16311732
}
16321733
},
@@ -1661,7 +1762,7 @@
16611762
},
16621763
"NextToken":{
16631764
"shape":"PaginationToken",
1664-
"documentation":"<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>"
1765+
"documentation":"<p>The token to use to retrieve the next page of results. This value is null when there are no more results to return. </p>"
16651766
}
16661767
}
16671768
},
@@ -1695,7 +1796,7 @@
16951796
},
16961797
"NextToken":{
16971798
"shape":"PaginationToken",
1698-
"documentation":"<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>"
1799+
"documentation":"<p>The token to use to retrieve the next page of results. This value is null when there are no more results to return. </p>"
16991800
}
17001801
}
17011802
},
@@ -1744,7 +1845,7 @@
17441845
},
17451846
"NextToken":{
17461847
"shape":"PaginationToken",
1747-
"documentation":"<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>"
1848+
"documentation":"<p>The token to use to retrieve the next page of results. This value is null when there are no more results to return. </p>"
17481849
}
17491850
}
17501851
},
@@ -1786,7 +1887,7 @@
17861887
},
17871888
"NextToken":{
17881889
"shape":"PaginationToken",
1789-
"documentation":"<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>"
1890+
"documentation":"<p>The token to use to retrieve the next page of results. This value is null when there are no more results to return. </p>"
17901891
}
17911892
}
17921893
},
@@ -2066,7 +2167,7 @@
20662167
},
20672168
"NextToken":{
20682169
"shape":"PaginationToken",
2069-
"documentation":"<p>The token to use to retrieve the next set of results, or null if no more results are available.</p>"
2170+
"documentation":"<p>The token to use to retrieve the next page of results. This value is null when there are no more results to return. </p>"
20702171
}
20712172
}
20722173
},
@@ -2859,6 +2960,24 @@
28592960
"members":{
28602961
}
28612962
},
2963+
"UpdateWorkspaceBundleRequest":{
2964+
"type":"structure",
2965+
"members":{
2966+
"BundleId":{
2967+
"shape":"BundleId",
2968+
"documentation":"<p>The identifier of the bundle.</p>"
2969+
},
2970+
"ImageId":{
2971+
"shape":"WorkspaceImageId",
2972+
"documentation":"<p>The identifier of the image.</p>"
2973+
}
2974+
}
2975+
},
2976+
"UpdateWorkspaceBundleResult":{
2977+
"type":"structure",
2978+
"members":{
2979+
}
2980+
},
28622981
"UpdateWorkspaceImagePermissionRequest":{
28632982
"type":"structure",
28642983
"required":[
@@ -2896,10 +3015,10 @@
28963015
"members":{
28973016
"Capacity":{
28983017
"shape":"NonEmptyString",
2899-
"documentation":"<p>The size of the user storage.</p>"
3018+
"documentation":"<p>The size of the user volume.</p>"
29003019
}
29013020
},
2902-
"documentation":"<p>Describes the user storage for a WorkSpace bundle.</p>"
3021+
"documentation":"<p>Describes the user volume for a WorkSpace bundle.</p>"
29033022
},
29043023
"UserVolumeSizeGib":{"type":"integer"},
29053024
"VolumeEncryptionKey":{"type":"string"},
@@ -3008,7 +3127,7 @@
30083127
"members":{
30093128
"BundleId":{
30103129
"shape":"BundleId",
3011-
"documentation":"<p>The bundle identifier.</p>"
3130+
"documentation":"<p>The identifier of the bundle.</p>"
30123131
},
30133132
"Name":{
30143133
"shape":"NonEmptyString",
@@ -3020,31 +3139,47 @@
30203139
},
30213140
"Description":{
30223141
"shape":"Description",
3023-
"documentation":"<p>A description.</p>"
3142+
"documentation":"<p>The description of the bundle.</p>"
30243143
},
30253144
"ImageId":{
30263145
"shape":"WorkspaceImageId",
3027-
"documentation":"<p>The image identifier of the bundle.</p>"
3146+
"documentation":"<p>The identifier of the image that was used to create the bundle.</p>"
30283147
},
30293148
"RootStorage":{
30303149
"shape":"RootStorage",
30313150
"documentation":"<p>The size of the root volume.</p>"
30323151
},
30333152
"UserStorage":{
30343153
"shape":"UserStorage",
3035-
"documentation":"<p>The size of the user storage.</p>"
3154+
"documentation":"<p>The size of the user volume.</p>"
30363155
},
30373156
"ComputeType":{
30383157
"shape":"ComputeType",
3039-
"documentation":"<p>The compute type. For more information, see <a href=\"http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles\">Amazon WorkSpaces Bundles</a>.</p>"
3158+
"documentation":"<p>The compute type of the bundle. For more information, see <a href=\"http://aws.amazon.com/workspaces/details/#Amazon_WorkSpaces_Bundles\">Amazon WorkSpaces Bundles</a>.</p>"
30403159
},
30413160
"LastUpdatedTime":{
30423161
"shape":"Timestamp",
30433162
"documentation":"<p>The last time that the bundle was updated.</p>"
3163+
},
3164+
"CreationTime":{
3165+
"shape":"Timestamp",
3166+
"documentation":"<p>The time when the bundle was created.</p>"
30443167
}
30453168
},
30463169
"documentation":"<p>Describes a WorkSpace bundle.</p>"
30473170
},
3171+
"WorkspaceBundleDescription":{
3172+
"type":"string",
3173+
"max":255,
3174+
"min":1,
3175+
"pattern":"^[a-zA-Z0-9_./() -]+$"
3176+
},
3177+
"WorkspaceBundleName":{
3178+
"type":"string",
3179+
"max":64,
3180+
"min":1,
3181+
"pattern":"^[a-zA-Z0-9_./()\\\\-]+$"
3182+
},
30483183
"WorkspaceConnectionStatus":{
30493184
"type":"structure",
30503185
"members":{

0 commit comments

Comments
 (0)