Skip to content

Commit d17a8d9

Browse files
author
AWS
committed
Amazon WorkSpaces Update: New APIs introduced to import WorkSpaces BYOL image using a new process that leveraged EC2 Image Builder. WorkSpaces tests and fixes your image's compatibility issues and supports customized VM images.
1 parent 1c51206 commit d17a8d9

File tree

2 files changed

+260
-1
lines changed

2 files changed

+260
-1
lines changed

‎.changes/next-release/feature-AmazonWorkSpaces-803ae02.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": "New APIs introduced to import WorkSpaces BYOL image using a new process that leveraged EC2 Image Builder. WorkSpaces tests and fixes your image's compatibility issues and supports customized VM images."
6+
}

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

Lines changed: 254 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -624,6 +624,20 @@
624624
],
625625
"documentation":"<p>Retrieves a list that describes the connection aliases used for cross-Region redirection. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/cross-region-redirection.html\"> Cross-Region Redirection for Amazon WorkSpaces</a>.</p>"
626626
},
627+
"DescribeCustomWorkspaceImageImport":{
628+
"name":"DescribeCustomWorkspaceImageImport",
629+
"http":{
630+
"method":"POST",
631+
"requestUri":"/"
632+
},
633+
"input":{"shape":"DescribeCustomWorkspaceImageImportRequest"},
634+
"output":{"shape":"DescribeCustomWorkspaceImageImportResult"},
635+
"errors":[
636+
{"shape":"AccessDeniedException"},
637+
{"shape":"ResourceNotFoundException"}
638+
],
639+
"documentation":"<p>Retrieves information about a WorkSpace BYOL image being imported via ImportCustomWorkspaceImage.</p>"
640+
},
627641
"DescribeImageAssociations":{
628642
"name":"DescribeImageAssociations",
629643
"http":{
@@ -892,6 +906,24 @@
892906
],
893907
"documentation":"<p>Imports client branding. Client branding allows you to customize your WorkSpace's client login portal. You can tailor your login portal company logo, the support email address, support link, link to reset password, and a custom message for users trying to sign in.</p> <p>After you import client branding, the default branding experience for the specified platform type is replaced with the imported experience</p> <note> <ul> <li> <p>You must specify at least one platform type when importing client branding.</p> </li> <li> <p>You can import up to 6 MB of data with each request. If your request exceeds this limit, you can import client branding for different platform types using separate requests.</p> </li> <li> <p>In each platform type, the <code>SupportEmail</code> and <code>SupportLink</code> parameters are mutually exclusive. You can specify only one parameter for each platform type, but not both.</p> </li> <li> <p>Imported data can take up to a minute to appear in the WorkSpaces client.</p> </li> </ul> </note>"
894908
},
909+
"ImportCustomWorkspaceImage":{
910+
"name":"ImportCustomWorkspaceImage",
911+
"http":{
912+
"method":"POST",
913+
"requestUri":"/"
914+
},
915+
"input":{"shape":"ImportCustomWorkspaceImageRequest"},
916+
"output":{"shape":"ImportCustomWorkspaceImageResult"},
917+
"errors":[
918+
{"shape":"AccessDeniedException"},
919+
{"shape":"InvalidParameterValuesException"},
920+
{"shape":"OperationNotSupportedException"},
921+
{"shape":"ResourceNotFoundException"},
922+
{"shape":"ResourceAlreadyExistsException"},
923+
{"shape":"ResourceLimitExceededException"}
924+
],
925+
"documentation":"<p>Imports the specified Windows 10 or 11 Bring Your Own License (BYOL) image into Amazon WorkSpaces using EC2 Image Builder. The image must be an already licensed image that is in your Amazon Web Services account, and you must own the image. For more information about creating BYOL images, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html\"> Bring Your Own Windows Desktop Licenses</a>. </p>"
926+
},
895927
"ImportWorkspaceImage":{
896928
"name":"ImportWorkspaceImage",
897929
"http":{
@@ -2751,6 +2783,41 @@
27512783
}
27522784
}
27532785
},
2786+
"CustomImageProtocol":{
2787+
"type":"string",
2788+
"enum":[
2789+
"PCOIP",
2790+
"DCV",
2791+
"BYOP"
2792+
]
2793+
},
2794+
"CustomWorkspaceImageImportErrorDetails":{
2795+
"type":"structure",
2796+
"members":{
2797+
"ErrorCode":{
2798+
"shape":"ErrorCode",
2799+
"documentation":"<p>The error code that is returned for the image import.</p>"
2800+
},
2801+
"ErrorMessage":{
2802+
"shape":"ImageErrorMessage",
2803+
"documentation":"<p>The text of the error message that is returned for the image import.</p>"
2804+
}
2805+
},
2806+
"documentation":"<p>Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.</p>"
2807+
},
2808+
"CustomWorkspaceImageImportErrorDetailsList":{
2809+
"type":"list",
2810+
"member":{"shape":"CustomWorkspaceImageImportErrorDetails"}
2811+
},
2812+
"CustomWorkspaceImageImportState":{
2813+
"type":"string",
2814+
"enum":[
2815+
"PENDING",
2816+
"IN_PROGRESS",
2817+
"COMPLETED",
2818+
"ERROR"
2819+
]
2820+
},
27542821
"DataReplication":{
27552822
"type":"string",
27562823
"enum":[
@@ -3131,6 +3198,10 @@
31313198
"DedicatedTenancyAccountType":{
31323199
"shape":"DedicatedTenancyAccountType",
31333200
"documentation":"<p>The type of linked account.</p>"
3201+
},
3202+
"Message":{
3203+
"shape":"Message",
3204+
"documentation":"<p>The text message to describe the status of BYOL.</p>"
31343205
}
31353206
}
31363207
},
@@ -3402,6 +3473,53 @@
34023473
}
34033474
}
34043475
},
3476+
"DescribeCustomWorkspaceImageImportRequest":{
3477+
"type":"structure",
3478+
"required":["ImageId"],
3479+
"members":{
3480+
"ImageId":{
3481+
"shape":"WorkspaceImageId",
3482+
"documentation":"<p>The identifier of the WorkSpace image.</p>"
3483+
}
3484+
}
3485+
},
3486+
"DescribeCustomWorkspaceImageImportResult":{
3487+
"type":"structure",
3488+
"members":{
3489+
"ImageId":{
3490+
"shape":"WorkspaceImageId",
3491+
"documentation":"<p>The identifier of the WorkSpace image.</p>"
3492+
},
3493+
"InfrastructureConfigurationArn":{
3494+
"shape":"InfrastructureConfigurationArn",
3495+
"documentation":"<p>The infrastructure configuration ARN that specifies how the WorkSpace image is built.</p>"
3496+
},
3497+
"State":{
3498+
"shape":"CustomWorkspaceImageImportState",
3499+
"documentation":"<p>The state of the WorkSpace image.</p>"
3500+
},
3501+
"Created":{
3502+
"shape":"Timestamp",
3503+
"documentation":"<p>The timestamp when the WorkSpace image import was created.</p>"
3504+
},
3505+
"LastUpdatedTime":{
3506+
"shape":"Timestamp",
3507+
"documentation":"<p>The timestamp when the WorkSpace image import was last updated.</p>"
3508+
},
3509+
"ImageSource":{
3510+
"shape":"ImageSourceIdentifier",
3511+
"documentation":"<p>Describes the image import source.</p>"
3512+
},
3513+
"ImageBuilderInstanceId":{
3514+
"shape":"NonEmptyString",
3515+
"documentation":"<p>The image builder instance ID of the WorkSpace image.</p>"
3516+
},
3517+
"ErrorDetails":{
3518+
"shape":"CustomWorkspaceImageImportErrorDetailsList",
3519+
"documentation":"<p>Describes in-depth details about the error. These details include the possible causes of the error and troubleshooting information.</p>"
3520+
}
3521+
}
3522+
},
34053523
"DescribeImageAssociationsRequest":{
34063524
"type":"structure",
34073525
"required":[
@@ -3999,13 +4117,24 @@
39994117
"type":"string",
40004118
"pattern":"^ami\\-([a-f0-9]{8}|[a-f0-9]{17})$"
40014119
},
4120+
"Ec2ImportTaskId":{
4121+
"type":"string",
4122+
"max":28,
4123+
"min":19,
4124+
"pattern":"^import-ami\\-([a-zA-Z0-9]{8}|[a-zA-Z0-9]{17})$"
4125+
},
40024126
"EndpointEncryptionMode":{
40034127
"type":"string",
40044128
"enum":[
40054129
"STANDARD_TLS",
40064130
"FIPS_VALIDATED"
40074131
]
40084132
},
4133+
"ErrorCode":{
4134+
"type":"string",
4135+
"max":256,
4136+
"min":1
4137+
},
40094138
"ErrorDetails":{
40104139
"type":"structure",
40114140
"members":{
@@ -4189,6 +4318,24 @@
41894318
"type":"list",
41904319
"member":{"shape":"ImageAssociatedResourceType"}
41914320
},
4321+
"ImageBuildVersionArn":{
4322+
"type":"string",
4323+
"max":2048,
4324+
"min":1,
4325+
"pattern":"^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):image/[a-z0-9-_]+/(?:(?:([0-9]+|x)\\.([0-9]+|x)\\.([0-9]+|x))|(?:[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+))$"
4326+
},
4327+
"ImageComputeType":{
4328+
"type":"string",
4329+
"enum":[
4330+
"BASE",
4331+
"GRAPHICS_G4DN"
4332+
]
4333+
},
4334+
"ImageErrorMessage":{
4335+
"type":"string",
4336+
"max":2048,
4337+
"min":1
4338+
},
41924339
"ImagePermission":{
41934340
"type":"structure",
41944341
"members":{
@@ -4241,6 +4388,25 @@
42414388
"type":"list",
42424389
"member":{"shape":"ImageResourceAssociation"}
42434390
},
4391+
"ImageSourceIdentifier":{
4392+
"type":"structure",
4393+
"members":{
4394+
"Ec2ImportTaskId":{
4395+
"shape":"Ec2ImportTaskId",
4396+
"documentation":"<p>The EC2 import task ID to import the image from the Amazon EC2 VM import process.</p>"
4397+
},
4398+
"ImageBuildVersionArn":{
4399+
"shape":"ImageBuildVersionArn",
4400+
"documentation":"<p>The ARN of the EC2 Image Builder image.</p>"
4401+
},
4402+
"Ec2ImageId":{
4403+
"shape":"Ec2ImageId",
4404+
"documentation":"<p>The identifier of the EC2 image.</p>"
4405+
}
4406+
},
4407+
"documentation":"<p>Describes the image import source.</p>",
4408+
"union":true
4409+
},
42444410
"ImageType":{
42454411
"type":"string",
42464412
"enum":[
@@ -4311,6 +4477,70 @@
43114477
}
43124478
}
43134479
},
4480+
"ImportCustomWorkspaceImageRequest":{
4481+
"type":"structure",
4482+
"required":[
4483+
"ImageName",
4484+
"ImageDescription",
4485+
"ComputeType",
4486+
"Protocol",
4487+
"ImageSource",
4488+
"InfrastructureConfigurationArn",
4489+
"Platform",
4490+
"OsVersion"
4491+
],
4492+
"members":{
4493+
"ImageName":{
4494+
"shape":"WorkspaceImageName",
4495+
"documentation":"<p>The name of the WorkSpace image.</p>"
4496+
},
4497+
"ImageDescription":{
4498+
"shape":"WorkspaceImageDescription",
4499+
"documentation":"<p>The description of the WorkSpace image.</p>"
4500+
},
4501+
"ComputeType":{
4502+
"shape":"ImageComputeType",
4503+
"documentation":"<p>The supported compute type for the WorkSpace image.</p>"
4504+
},
4505+
"Protocol":{
4506+
"shape":"CustomImageProtocol",
4507+
"documentation":"<p>The supported protocol for the WorkSpace image. Windows 11 does not support PCOIP protocol.</p>"
4508+
},
4509+
"ImageSource":{
4510+
"shape":"ImageSourceIdentifier",
4511+
"documentation":"<p>The options for image import source.</p>"
4512+
},
4513+
"InfrastructureConfigurationArn":{
4514+
"shape":"InfrastructureConfigurationArn",
4515+
"documentation":"<p>The infrastructure configuration ARN that specifies how the WorkSpace image is built.</p>"
4516+
},
4517+
"Platform":{
4518+
"shape":"Platform",
4519+
"documentation":"<p>The platform for the WorkSpace image source.</p>"
4520+
},
4521+
"OsVersion":{
4522+
"shape":"OSVersion",
4523+
"documentation":"<p>The OS version for the WorkSpace image source.</p>"
4524+
},
4525+
"Tags":{
4526+
"shape":"TagList",
4527+
"documentation":"<p>The resource tags. Each WorkSpaces resource can have a maximum of 50 tags.</p>"
4528+
}
4529+
}
4530+
},
4531+
"ImportCustomWorkspaceImageResult":{
4532+
"type":"structure",
4533+
"members":{
4534+
"ImageId":{
4535+
"shape":"WorkspaceImageId",
4536+
"documentation":"<p>The identifier of the WorkSpace image.</p>"
4537+
},
4538+
"State":{
4539+
"shape":"CustomWorkspaceImageImportState",
4540+
"documentation":"<p>The state of the WorkSpace image.</p>"
4541+
}
4542+
}
4543+
},
43144544
"ImportWorkspaceImageRequest":{
43154545
"type":"structure",
43164546
"required":[
@@ -4361,6 +4591,12 @@
43614591
"documentation":"<p>The specified application is not compatible with the resource.</p>",
43624592
"exception":true
43634593
},
4594+
"InfrastructureConfigurationArn":{
4595+
"type":"string",
4596+
"max":2048,
4597+
"min":1,
4598+
"pattern":"^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws):infrastructure-configuration/[a-z0-9-_]+$"
4599+
},
43644600
"InternalServerException":{
43654601
"type":"structure",
43664602
"members":{
@@ -4634,6 +4870,7 @@
46344870
"type":"integer",
46354871
"min":0
46364872
},
4873+
"Message":{"type":"string"},
46374874
"MicrosoftEntraConfig":{
46384875
"type":"structure",
46394876
"members":{
@@ -4730,7 +4967,12 @@
47304967
},
47314968
"ModifyAccountResult":{
47324969
"type":"structure",
4733-
"members":{}
4970+
"members":{
4971+
"Message":{
4972+
"shape":"Message",
4973+
"documentation":"<p>The text message to describe the status of BYOL modification.</p>"
4974+
}
4975+
}
47344976
},
47354977
"ModifyCertificateBasedAuthPropertiesRequest":{
47364978
"type":"structure",
@@ -4960,6 +5202,13 @@
49605202
"type":"string",
49615203
"min":1
49625204
},
5205+
"OSVersion":{
5206+
"type":"string",
5207+
"enum":[
5208+
"Windows_10",
5209+
"Windows_11"
5210+
]
5211+
},
49635212
"OperatingSystem":{
49645213
"type":"structure",
49655214
"members":{
@@ -5059,6 +5308,10 @@
50595308
"type":"list",
50605309
"member":{"shape":"PendingCreateStandbyWorkspacesRequest"}
50615310
},
5311+
"Platform":{
5312+
"type":"string",
5313+
"enum":["WINDOWS"]
5314+
},
50625315
"PoolsRunningMode":{
50635316
"type":"string",
50645317
"enum":[

0 commit comments

Comments
 (0)