Skip to content

Commit d5256d6

Browse files
author
AWS
committed
Amazon WorkSpaces Update: The release introduces CreateStandbyWorkspaces, an API that allows you to create standby WorkSpaces associated with a primary WorkSpace in another Region. DescribeWorkspaces now includes related WorkSpaces properties. DescribeWorkspaceBundles and CreateWorkspaceBundle now return more bundle details.
1 parent 601e4f2 commit d5256d6

File tree

2 files changed

+203
-3
lines changed

2 files changed

+203
-3
lines changed

‎.changes/next-release/feature-AmazonWorkSpaces-21da592.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": "The release introduces CreateStandbyWorkspaces, an API that allows you to create standby WorkSpaces associated with a primary WorkSpace in another Region. DescribeWorkspaces now includes related WorkSpaces properties. DescribeWorkspaceBundles and CreateWorkspaceBundle now return more bundle details."
6+
}

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

Lines changed: 197 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,23 @@
136136
],
137137
"documentation":"<p>Creates an IP access control group.</p> <p>An IP access control group provides you with the ability to control the IP addresses from which users are allowed to access their WorkSpaces. To specify the CIDR address ranges, add rules to your IP access control group and then associate the group with your directory. You can add rules when you create the group or at any time using <a>AuthorizeIpRules</a>.</p> <p>There is a default IP access control group associated with your directory. If you don't associate an IP access control group with your directory, the default group is used. The default group includes a default rule that allows users to access their WorkSpaces from anywhere. You cannot modify the default IP access control group for your directory.</p>"
138138
},
139+
"CreateStandbyWorkspaces":{
140+
"name":"CreateStandbyWorkspaces",
141+
"http":{
142+
"method":"POST",
143+
"requestUri":"/"
144+
},
145+
"input":{"shape":"CreateStandbyWorkspacesRequest"},
146+
"output":{"shape":"CreateStandbyWorkspacesResult"},
147+
"errors":[
148+
{"shape":"AccessDeniedException"},
149+
{"shape":"InvalidParameterValuesException"},
150+
{"shape":"OperationNotSupportedException"},
151+
{"shape":"ResourceNotFoundException"},
152+
{"shape":"ResourceLimitExceededException"}
153+
],
154+
"documentation":"<p>Creates a Standby WorkSpace in a secondary region.</p>"
155+
},
139156
"CreateTags":{
140157
"name":"CreateTags",
141158
"http":{
@@ -810,7 +827,8 @@
810827
"errors":[
811828
{"shape":"InvalidParameterValuesException"},
812829
{"shape":"InvalidResourceStateException"},
813-
{"shape":"ResourceNotFoundException"}
830+
{"shape":"ResourceNotFoundException"},
831+
{"shape":"OperationNotSupportedException"}
814832
],
815833
"documentation":"<p>Sets the state of the specified WorkSpace.</p> <p>To maintain a WorkSpace without being interrupted, set the WorkSpace state to <code>ADMIN_MAINTENANCE</code>. WorkSpaces in this state do not respond to requests to reboot, stop, start, rebuild, or restore. An AutoStop WorkSpace in this state is not stopped. Users cannot log into a WorkSpace in the <code>ADMIN_MAINTENANCE</code> state.</p>"
816834
},
@@ -822,6 +840,9 @@
822840
},
823841
"input":{"shape":"RebootWorkspacesRequest"},
824842
"output":{"shape":"RebootWorkspacesResult"},
843+
"errors":[
844+
{"shape":"OperationNotSupportedException"}
845+
],
825846
"documentation":"<p>Reboots the specified WorkSpaces.</p> <p>You cannot reboot a WorkSpace unless its state is <code>AVAILABLE</code> or <code>UNHEALTHY</code>.</p> <p>This operation is asynchronous and returns before the WorkSpaces have rebooted.</p>"
826847
},
827848
"RebuildWorkspaces":{
@@ -832,6 +853,9 @@
832853
},
833854
"input":{"shape":"RebuildWorkspacesRequest"},
834855
"output":{"shape":"RebuildWorkspacesResult"},
856+
"errors":[
857+
{"shape":"OperationNotSupportedException"}
858+
],
835859
"documentation":"<p>Rebuilds the specified WorkSpace.</p> <p>You cannot rebuild a WorkSpace unless its state is <code>AVAILABLE</code>, <code>ERROR</code>, <code>UNHEALTHY</code>, <code>STOPPED</code>, or <code>REBOOTING</code>.</p> <p>Rebuilding a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/reset-workspace.html\">Rebuild a WorkSpace</a>.</p> <p>This operation is asynchronous and returns before the WorkSpaces have been completely rebuilt.</p>"
836860
},
837861
"RegisterWorkspaceDirectory":{
@@ -865,7 +889,8 @@
865889
"errors":[
866890
{"shape":"InvalidParameterValuesException"},
867891
{"shape":"ResourceNotFoundException"},
868-
{"shape":"AccessDeniedException"}
892+
{"shape":"AccessDeniedException"},
893+
{"shape":"OperationNotSupportedException"}
869894
],
870895
"documentation":"<p>Restores the specified WorkSpace to its last known healthy state.</p> <p>You cannot restore a WorkSpace unless its state is <code> AVAILABLE</code>, <code>ERROR</code>, <code>UNHEALTHY</code>, or <code>STOPPED</code>.</p> <p>Restoring a WorkSpace is a potentially destructive action that can result in the loss of data. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/restore-workspace.html\">Restore a WorkSpace</a>.</p> <p>This operation is asynchronous and returns before the WorkSpace is completely restored.</p>"
871896
},
@@ -978,7 +1003,8 @@
9781003
{"shape":"AccessDeniedException"},
9791004
{"shape":"InvalidParameterValuesException"},
9801005
{"shape":"ResourceNotFoundException"},
981-
{"shape":"ResourceUnavailableException"}
1006+
{"shape":"ResourceUnavailableException"},
1007+
{"shape":"OperationNotSupportedException"}
9821008
],
9831009
"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>"
9841010
},
@@ -1186,6 +1212,13 @@
11861212
"member":{"shape":"WorkspaceBundle"}
11871213
},
11881214
"BundleOwner":{"type":"string"},
1215+
"BundleType":{
1216+
"type":"string",
1217+
"enum":[
1218+
"REGULAR",
1219+
"STANDBY"
1220+
]
1221+
},
11891222
"CertificateAuthorityArn":{
11901223
"type":"string",
11911224
"max":200,
@@ -1585,6 +1618,36 @@
15851618
}
15861619
}
15871620
},
1621+
"CreateStandbyWorkspacesRequest":{
1622+
"type":"structure",
1623+
"required":[
1624+
"PrimaryRegion",
1625+
"StandbyWorkspaces"
1626+
],
1627+
"members":{
1628+
"PrimaryRegion":{
1629+
"shape":"Region",
1630+
"documentation":"<p>The Region of the primary WorkSpace.</p>"
1631+
},
1632+
"StandbyWorkspaces":{
1633+
"shape":"StandbyWorkspacesList",
1634+
"documentation":"<p>Information about the Standby WorkSpace to be created.</p>"
1635+
}
1636+
}
1637+
},
1638+
"CreateStandbyWorkspacesResult":{
1639+
"type":"structure",
1640+
"members":{
1641+
"FailedStandbyRequests":{
1642+
"shape":"FailedCreateStandbyWorkspacesRequestList",
1643+
"documentation":"<p>Information about the Standby WorkSpace that could not be created. </p>"
1644+
},
1645+
"PendingStandbyRequests":{
1646+
"shape":"PendingCreateStandbyWorkspacesRequestList",
1647+
"documentation":"<p>Information about the Standby WorkSpace that was created.</p>"
1648+
}
1649+
}
1650+
},
15881651
"CreateTagsRequest":{
15891652
"type":"structure",
15901653
"required":[
@@ -2572,6 +2635,28 @@
25722635
"ErrorType":{"type":"string"},
25732636
"ExceptionErrorCode":{"type":"string"},
25742637
"ExceptionMessage":{"type":"string"},
2638+
"FailedCreateStandbyWorkspacesRequest":{
2639+
"type":"structure",
2640+
"members":{
2641+
"StandbyWorkspaceRequest":{
2642+
"shape":"StandbyWorkspace",
2643+
"documentation":"<p>Information about the Standby WorkSpace that could not be created.</p>"
2644+
},
2645+
"ErrorCode":{
2646+
"shape":"WorkspaceErrorCode",
2647+
"documentation":"<p>The error code that is returned if the Standby WorkSpace could not be created.</p>"
2648+
},
2649+
"ErrorMessage":{
2650+
"shape":"Description",
2651+
"documentation":"<p>The text of the error message that is returned if the Standby WorkSpace could not be created.</p>"
2652+
}
2653+
},
2654+
"documentation":"<p>Describes the Standby WorkSpace that could not be created.</p>"
2655+
},
2656+
"FailedCreateStandbyWorkspacesRequestList":{
2657+
"type":"list",
2658+
"member":{"shape":"FailedCreateStandbyWorkspacesRequest"}
2659+
},
25752660
"FailedCreateWorkspaceRequest":{
25762661
"type":"structure",
25772662
"members":{
@@ -3262,6 +3347,32 @@
32623347
"max":2048,
32633348
"min":1
32643349
},
3350+
"PendingCreateStandbyWorkspacesRequest":{
3351+
"type":"structure",
3352+
"members":{
3353+
"UserName":{
3354+
"shape":"UserName",
3355+
"documentation":"<p>Describes the Standby WorkSpace that was created.</p> <p>Because this operation is asynchronous, the identifier returned is not immediately available for use with other operations. For example, if you call <a href=\"https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaces.html\"> DescribeWorkspaces</a> before the WorkSpace is created, the information returned can be incomplete. </p>"
3356+
},
3357+
"DirectoryId":{
3358+
"shape":"DirectoryId",
3359+
"documentation":"<p>The identifier of the directory for the Standby WorkSpace.</p>"
3360+
},
3361+
"State":{
3362+
"shape":"WorkspaceState",
3363+
"documentation":"<p>The operational state of the Standby WorkSpace.</p>"
3364+
},
3365+
"WorkspaceId":{
3366+
"shape":"WorkspaceId",
3367+
"documentation":"<p>The identifier of the Standby WorkSpace.</p>"
3368+
}
3369+
},
3370+
"documentation":"<p>Information about the Standby WorkSpace.</p>"
3371+
},
3372+
"PendingCreateStandbyWorkspacesRequestList":{
3373+
"type":"list",
3374+
"member":{"shape":"PendingCreateStandbyWorkspacesRequest"}
3375+
},
32653376
"Protocol":{
32663377
"type":"string",
32673378
"enum":[
@@ -3401,6 +3512,32 @@
34013512
"max":20,
34023513
"min":1
34033514
},
3515+
"RelatedWorkspaceProperties":{
3516+
"type":"structure",
3517+
"members":{
3518+
"WorkspaceId":{
3519+
"shape":"WorkspaceId",
3520+
"documentation":"<p>The identifier of the related WorkSpace.</p>"
3521+
},
3522+
"Region":{
3523+
"shape":"Region",
3524+
"documentation":"<p>The Region of the related WorkSpace.</p>"
3525+
},
3526+
"State":{
3527+
"shape":"WorkspaceState",
3528+
"documentation":"<p>Indicates the state of the WorkSpace.</p>"
3529+
},
3530+
"Type":{
3531+
"shape":"StandbyWorkspaceRelationshipType",
3532+
"documentation":"<p>Indicates the type of WorkSpace.</p>"
3533+
}
3534+
},
3535+
"documentation":"<p>Describes the related WorkSpace. The related WorkSpace could be a Standby WorkSpace or Primary WorkSpace related to the specified WorkSpace.</p>"
3536+
},
3537+
"RelatedWorkspaces":{
3538+
"type":"list",
3539+
"member":{"shape":"RelatedWorkspaceProperties"}
3540+
},
34043541
"ResourceAlreadyExistsException":{
34053542
"type":"structure",
34063543
"members":{
@@ -3607,6 +3744,43 @@
36073744
"type":"list",
36083745
"member":{"shape":"Snapshot"}
36093746
},
3747+
"StandbyWorkspace":{
3748+
"type":"structure",
3749+
"required":[
3750+
"PrimaryWorkspaceId",
3751+
"DirectoryId"
3752+
],
3753+
"members":{
3754+
"PrimaryWorkspaceId":{
3755+
"shape":"WorkspaceId",
3756+
"documentation":"<p>The identifier of the Standby WorkSpace.</p>"
3757+
},
3758+
"VolumeEncryptionKey":{
3759+
"shape":"VolumeEncryptionKey",
3760+
"documentation":"<p>The volume encryption key of the Standby WorkSpace.</p>"
3761+
},
3762+
"DirectoryId":{
3763+
"shape":"DirectoryId",
3764+
"documentation":"<p>The identifier of the directory for the Standby WorkSpace.</p>"
3765+
},
3766+
"Tags":{
3767+
"shape":"TagList",
3768+
"documentation":"<p>The tags associated with the Standby WorkSpace.</p>"
3769+
}
3770+
},
3771+
"documentation":"<p>Describes a Standby WorkSpace.</p>"
3772+
},
3773+
"StandbyWorkspaceRelationshipType":{
3774+
"type":"string",
3775+
"enum":[
3776+
"PRIMARY",
3777+
"STANDBY"
3778+
]
3779+
},
3780+
"StandbyWorkspacesList":{
3781+
"type":"list",
3782+
"member":{"shape":"StandbyWorkspace"}
3783+
},
36103784
"StartRequest":{
36113785
"type":"structure",
36123786
"members":{
@@ -4005,6 +4179,10 @@
40054179
"ModificationStates":{
40064180
"shape":"ModificationStateList",
40074181
"documentation":"<p>The modification states of the WorkSpace.</p>"
4182+
},
4183+
"RelatedWorkspaces":{
4184+
"shape":"RelatedWorkspaces",
4185+
"documentation":"<p>The Standby WorkSpace or Primary WorkSpace related to the specified WorkSpace.</p>"
40084186
}
40094187
},
40104188
"documentation":"<p>Describes a WorkSpace.</p>"
@@ -4089,6 +4267,14 @@
40894267
"CreationTime":{
40904268
"shape":"Timestamp",
40914269
"documentation":"<p>The time when the bundle was created.</p>"
4270+
},
4271+
"State":{
4272+
"shape":"WorkspaceBundleState",
4273+
"documentation":"<p>The state of the WorkSpace bundle.</p>"
4274+
},
4275+
"BundleType":{
4276+
"shape":"BundleType",
4277+
"documentation":"<p>The type of WorkSpace bundle.</p>"
40924278
}
40934279
},
40944280
"documentation":"<p>Describes a WorkSpace bundle.</p>"
@@ -4105,6 +4291,14 @@
41054291
"min":1,
41064292
"pattern":"^[a-zA-Z0-9_./()\\\\-]+$"
41074293
},
4294+
"WorkspaceBundleState":{
4295+
"type":"string",
4296+
"enum":[
4297+
"AVAILABLE",
4298+
"PENDING",
4299+
"ERROR"
4300+
]
4301+
},
41084302
"WorkspaceConnectionStatus":{
41094303
"type":"structure",
41104304
"members":{

0 commit comments

Comments
 (0)