本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
建立和管理 Amazon WorkSpaces 應用程式映像的映像助理 CLI 操作
本節說明可用來建立和管理 WorkSpaces 應用程式映像的映像助理 CLI 操作。
在 Windows 映像建置器上，包含命令列介面的可執行檔位於：C:\Program Files\Amazon\Photon\ConsoleImageBuilder\Image-Assistant.exe。為方便起見，這個可執行檔會包含在 Windows PATH 變數中。這可讓您呼叫映像助理 CLI 操作，無需指定可執行檔的絕對路徑。若要呼叫這些操作，請輸入 image-assistant.exe 命令。
在 Linux 映像建置器上，映像助理工具位於 /usr/local/appstream/image-assistant/AppStreamImageAssistant，且符號連結位於 /bin/AppStreamImageAssistant。
help 操作
擷取所有映像助理 CLI 操作的清單。已針對此清單中的每個操作提供描述和用法語法。若要顯示特定操作的說明，輸入該操作的名稱，並指定 --help 參數。例如：
add-application --help
概要
help
輸出
列印可用操作清單與其功能描述的標準輸出。
add-application 操作
將應用程式新增至 WorkSpaces 應用程式使用者的應用程式清單。這個清單中的應用程式會包含在應用程式型錄中。應用程式目錄會在使用者登入 WorkSpaces 應用程式串流工作階段時顯示。
注意
如果您需要變更應用程式組態，請移除應用程式，並新增包含更新設定的應用程式。
概要
add-application --name <value> --absolute-app-path <value> [--display-name <value>] [--absolute-icon-path <value>] [--working-directory <value>] [--launch-parameters <""-escaped value>] [--absolute-manifest-path <value>]
選項
--name(string)-
應用程式的唯一名稱。長度上限為 256 個字元。您可以新增最多 50 個應用程式。您不能使用空白字元。
--absolute-app-path(string)-
可執行檔、批次檔案或應用程式指令碼的絕對路徑。路徑必須指向有效的檔案。
--display-name(string)-
在應用程式型錄中顯示的應用程式名稱。如果您未指定顯示名稱，WorkSpaces 應用程式會建立衍生自可執行檔名稱的名稱。名稱建立時沒有副檔名且其中以底線代替空格。長度上限為 256 個字元。
--absolute-icon-path(string)-
應用程式圖示的絕對路徑。路徑必須指向以下其中一個類型的有效圖示檔案：.jpg、.png 或 .bmp。最大尺寸為 256 px x 256 px。如果您沒有指定路徑，則會使用可執行檔的預設圖示 (如果可用)。如果可執行檔無法使用預設圖示，則會使用預設 WorkSpaces 應用程式圖示。
--working-directory(string)-
啟動應用程式時，應用程式的初始工作目錄。
--absolute-manifest-path(string)-
以新行分隔之文字檔案的路徑。該檔案會指定檔案的絕對路徑，以在將機群執行個體供使用者用於串流前進行最佳化。路徑必須指向有效的文字檔案。
訊息輸出
| 結束程式碼 | 列印為標準輸出的訊息 | 說明 |
|---|---|---|
| 0 | {"狀態": 0, "訊息": "成功"} | 已成功新增應用程式。 |
| 1 | {"狀態": 1, "訊息": "需要管理員權限才能執行此操作"} | 需要管理員權限才能完成此操作。 |
| 1 | {"狀態": 1, "訊息": "無法將超過 50 個應用程式新增到型錄。"} | 無法新增應用程式，因為可新增至 WorkSpaces 應用程式應用程式目錄的應用程式數目上限為 50。 |
| 1 | {"狀態": 1, "訊息": "名稱不是唯一的"} | WorkSpaces 應用程式目錄中已存在具有該名稱的應用程式。 |
| 1 | {"狀態": 1, "訊息": "找不到檔案 (absolute-app-path)"} | 找不到指定的 absolute-app-path 檔案。 |
| 1 | {"狀態": 1, "訊息": "不支援的副檔名"} | 此 Absolute-app-path 參數僅支援以下檔案類型：.exe 和 .bat。 |
| 1 | {"狀態": 1, "訊息": "找不到目錄 (working-directory)" | 找不到指定的 working-directory 目錄。 |
| 1 | {"狀態": 1, "訊息": "找不到最佳化資訊清單：<filename>"} | 找不到指定的 optimization-manifest 檔案。 |
| 1 | {"狀態": 1, "訊息": "找不到檔案：<filename>"} | 找不到在最佳化資訊清單中指定的檔案。 |
| 255 | {"狀態": 255, "訊息": <error message>} | 發生未預期的錯誤。再次嘗試請求。如果錯誤仍然存在，請聯絡 AWS 支援 尋求協助。如需詳細資訊，請參閱 AWS 支援 中心 |
remove-application 操作
從 WorkSpaces 應用程式映像的應用程式清單中移除應用程式。應用程式不會解除安裝或修改，但使用者將無法從 WorkSpaces 應用程式目錄啟動它。
概要
remove-application --name <value>
選項
--name(string)-
要移除的應用程式唯一識別符。
訊息輸出
| 結束程式碼 | 列印為標準輸出的訊息 | 說明 |
|---|---|---|
| 0 | {"狀態": 0, "訊息": "成功"} | 已成功移除應用程式。 |
| 1 | {"狀態": 1, "訊息": "需要管理員權限才能執行此操作"} | 需要管理員權限才能完成此操作。 |
| 1 | {"狀態": 1, "訊息": "找不到應用程式"} | WorkSpaces 應用程式目錄中找不到指定的應用程式。 |
| 255 | {"狀態": 255, "訊息": <error message>} | 發生未預期的錯誤。再次嘗試請求。如果錯誤仍然存在，請聯絡 AWS 支援 尋求協助。如需詳細資訊，請參閱 AWS 支援 中心 |
list-applications 操作
列出在應用程式型錄中指定的所有應用程式。
概要
list-applications
訊息輸出
| 結束程式碼 | 列印為標準輸出的訊息 | 說明 |
|---|---|---|
| 0 | {"狀態": 0, "訊息": "成功", "應用程式": [ {..app1.. }, { ..app2.. }]} | WorkSpaces 應用程式目錄中的應用程式清單。 |
| 255 | {"狀態": 255, "訊息": <error message>} | 發生未預期的錯誤。再次嘗試請求。如果錯誤仍然存在，請聯絡 AWS 支援 尋求協助。如需詳細資訊，請參閱 AWS 支援 中心 |
update-default-profile 操作
將指定的 Windows 使用者描述檔複製到 Windows 預設使用者描述檔中。串流的新使用者會繼承在指定描述檔中存放的設定。
注意
Linux 映像助理 CLI 工具不支援此操作。
概要
update-default-profile [--profile <value>]
選項
--profile(string)-
要將其 Windows 描述檔複製到 Windows 預設使用者描述檔的使用者名稱。使用下列名稱格式：
"<domain>\<username>"
如果映像建置器未加入 Microsoft Active Directory 網域，請在網域中輸入句號「.」。如果您未指定使用者，則會使用 WorkSpaces 應用程式範本使用者帳戶。
訊息輸出
| 結束程式碼 | 列印為標準輸出的訊息 | 說明 |
|---|---|---|
| 0 | {"狀態": 0, "訊息": "成功"} | 已成功將使用者設定複製到預設的 Windows 描述檔。 |
| 1 | {"狀態": 1, "訊息": "需要管理員權限才能執行此操作"} | 需要管理員權限才能完成此操作。 |
| 1 | {"狀態": 1, "訊息": "無法複製檔案或資料夾：<path>。<reason>"} | 檔案或資料夾無法使用，因此無法複製使用者設定。 |
| 1 | {"狀態": 1, "訊息": "未加入網域時，無法複製網域使用者""} | 已指定 Microsoft Active Directory 網域使用者，但映像建置器未加入 Active Directory 網域。 |
| 255 | {"狀態": 255, "訊息": <error message>} | 發生未預期的錯誤。再次嘗試請求。如果錯誤仍然存在，請聯絡 AWS 支援 尋求協助。如需詳細資訊，請參閱 AWS 支援 中心 |
reset-user-profile 操作
刪除指定使用者的 Windows 使用者描述檔。
注意
Linux 映像助理 CLI 工具不支援此操作。
概要
reset-user-profile [--profile <value>]
選項
--profile(string)-
其 Windows 描述檔將遭到刪除的 Windows 使用者名稱。使用下列名稱格式：
"<domain>\<username>"
如果映像建置器未加入 Microsoft Active Directory 網域，請在網域中輸入句號「.」。
訊息輸出
| 結束程式碼 | 列印為標準輸出的訊息 | 說明 |
|---|---|---|
| 0 | {"狀態": 0, "訊息": "成功"} | 已成功刪除指定的使用者設定。 |
| 1 | {"狀態": 1, "訊息": "需要管理員權限才能執行此操作"} | 需要管理員權限才能完成此操作。 |
| 1 | {"狀態": 1, "訊息": "無法複製檔案或資料夾：<path>。<reason>"} | 檔案或資料夾無法使用，因此無法重設使用者設定。 |
| 1 | {"狀態": 1, "訊息": "未加入網域時，無法複製網域使用者""} | 已指定 Microsoft Active Directory 網域使用者，但映像建置器未加入 Active Directory 網域。 |
| 255 | {"狀態": 255, "訊息": <error message>} | 發生未預期的錯誤。再次嘗試請求。如果錯誤仍然存在，請聯絡 AWS 支援 尋求協助。如需詳細資訊，請參閱 AWS 支援 中心 |
create-image 操作
啟動映像建立工作流程，產生可用於 WorkSpaces 應用程式機群的 WorkSpaces 應用程式映像。
概要
create-image --name <value> [--description <value>] [--display-name <value>] [--enable-dynamic-app-catalog] | [--no-enable-dynamic-app-catalog] [--use-latest-agent-version] | [--no-use-latest-agent-version] [--tags <value>] [--dry-run]
選項
--name(string)-
WorkSpaces 應用程式映像的名稱。名稱在 Amazon Web Services 帳戶和 AWS 區域中必須是唯一的。長度上限為 100 個字元。允許的字元如下：
a-z、A-Z、0-9、底線 (_)、連字號 (-) 和句號 (.)
映像名稱不得以下列任何前綴為開頭：「aws」、「appstream」及「amazon」。這些字首已保留給 AWS 使用。
--description(string)-
要顯示的映像描述。長度上限為 256 個字元。
--display-name(string)-
要顯示的映像名稱。長度上限為 256 個字元。
--enable-dynamic-app-catalog|--no-enable-dynamic-app-catalog-
啟用或停用 WorkSpaces 應用程式動態應用程式架構的支援。如果您沒有指定參數，則不會啟用對動態應用程式架構的支援。
動態應用程式架構提供 WorkSpaces 應用程式串流執行個體內的操作，您可以用來建置動態應用程式提供者。動態應用程式提供者可使用這些操作，來修改使用者可以即時存取的應用程式型錄。如需詳細資訊，請參閱使用 WorkSpaces 應用程式動態應用程式架構來建置動態應用程式提供者。
--use-latest-agent-version|--no-use-latest-agent-version-
指定要將映像鎖定到目前安裝的 WorkSpaces 應用程式代理程式版本，還是一律使用最新的代理程式版本。如果您未指定任一參數，映像會固定到目前安裝的 WorkSpaces 應用程式代理程式版本。如需詳細資訊，請參閱管理 WorkSpaces 應用程式代理程式版本。
--tags(string)-
要與此映像關聯的標籤。標籤是索引鍵值組。使用下列格式：
--tags "mykey" "myval" "mykey2" "myval2"
如需標籤的詳細資訊，請參閱標記 Amazon WorkSpaces 應用程式資源。
--dry-run(string)-
執行驗證，但不建立映像。使用此命令來在建立映像前識別其中是否有任何問題。
訊息輸出
| 結束程式碼 | 列印為標準輸出的訊息 | 說明 |
|---|---|---|
| 0 | {"狀態": 0, "訊息": "成功"} | 已成功啟動建立映像的工作流程。 |
| 1 | {"狀態": 1, "訊息": "需要管理員權限才能執行此操作"} | 需要管理員權限才能完成此操作。 |
| 1 | {"狀態": 1, "訊息": "具指定名稱的映像已存在"} | Amazon Web Services 帳戶中已有此指定名稱的映像。 |
| 1 | {"狀態": 1, "訊息": "無效值 (標籤)"} | 指定的標籤無效。 |
| 255 | {"狀態": 255, "訊息": <error message>} | 發生未預期的錯誤。再次嘗試請求。如果錯誤仍然存在，請聯絡 AWS 支援 尋求協助。如需詳細資訊，請參閱 AWS 支援 中心 |
