管理 WorkSpaces 應用程式應用程式權利的 API 動作 - Amazon WorkSpaces 應用程式

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

管理 WorkSpaces 應用程式應用程式權利的 API 動作

您可以使用下列 API 操作來管理 WorkSpaces 應用程式的應用程式權利。

AddApplicationsRequest 操作

將應用程式新增至 WorkSpaces 應用程式使用者的應用程式目錄。WorkSpaces 應用程式顯示的應用程式目錄包含您使用此 API 操作新增的應用程式,以及您在映像中新增的應用程式。在您使用上述方法之一或兩者來新增應用程式之後,使用者即可啟動應用程式。

請求語法

string userSid;

list<Application> applications;

請求參數

userSid

要套用請求的使用者 SID。

類型:字串

必要:是

長度限制:長度下限 1 個字元,長度上限 208 個字元。

應用程式

要套用請求的應用程式清單。

類型:字串

必要:是

Application 物件

描述顯示和啟動應用程式所需的應用程式中繼資料。應用程式識別符必須是唯一的,而且不能與透過 API 操作或映像指定的其他應用程式衝突。

id

要指定的應用程式識別符。此值對應於 WorkSpaces 應用程式報告中application_name的值,會在使用者啟動應用程式時提供。當您啟用用量報告時,在使用者在其串流工作階段期間啟動至少一個應用程式的每一天,WorkSpaces 應用程式都會將應用程式報告匯出到您的 Amazon S3 儲存貯體。如需有關應用程式報告的詳細資訊,請參閱應用程式報告欄位

類型:字串

必要:是

長度限制:長度下限 1 個字元,長度上限 512 個字元。

displayName

要指定的應用程式顯示名稱。使用者會在應用程式目錄中看到此名稱。

類型:字串

必要:是

長度限制:長度下限 1 個字元,長度上限 512 個字元。

launchPath

要啟動之應用程式執行檔的 Windows 檔案系統路徑。

類型:字串

必要:是

長度限制:長度下限 1 個字元,長度上限 32,767 個字元。

iconData

要顯示在應用程式目錄中的 base-64 編碼映像。此影像必須為下列其中一個格式:.png、.jpeg 或是 .jpg。

類型:字串

必要:是

長度限制:長度下限 1 個字元,長度上限 1,000,000 個字元。

launchParams

用來啟動應用程式的參數。

類型:字串

必要:否

長度限制:長度上限 32,000 個字元。

workingDirectory

要在其中啟動應用程式之工作目錄的 Windows 檔案系統路徑。

類型:字串

必要:否

長度限制:長度上限 32,767 個字元。

RemoveApplicationsRequest 操作

使用 AddApplicationsRequest 操作移除之前新增的應用程式。即可從使用者的應用程式目錄中移除應用程式。在移除應用程式後,即無法啟動這些應用程式。如果應用程式仍在執行,WorkSpaces 應用程式不會將其關閉。直接在 WorkSpaces 應用程式映像中指定的應用程式無法移除。

請求語法

string userSid;

list<Application> applications;

請求參數

userSid

對其套用請求的使用者 SID。

類型:字串

必要:是

長度限制:長度下限 1 個字元,長度上限 208 個字元。

應用程式

要套用請求的應用程式清單。

類型:字串

必要:是

ClearApplicationsRequest 操作

使用 AddApplicationsRequest 操作,移除之前新增至應用程式目錄的所有應用程式。在移除應用程式後,即無法啟動這些應用程式。如果應用程式在使用 ClearApplicationsRequest操作時正在執行,WorkSpaces 應用程式不會將其關閉。直接在 WorkSpaces 應用程式映像中指定的應用程式無法移除。

請求語法

string userSid;

請求參數

userSid

對其套用請求的使用者 SID。

類型:字串

必要:是

長度限制:長度下限 1 個字元,長度上限 208 個字元。