WorkSpaces アプリケーションのアプリケーション使用権限を管理するための API アクション - Amazon WorkSpaces アプリケーション

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

WorkSpaces アプリケーションのアプリケーション使用権限を管理するための API アクション

次の API オペレーションを使用して、WorkSpaces アプリケーションのアプリケーション使用権限を管理できます。

AddApplicationsRequest オペレーション

WorkSpaces Applications ユーザーのアプリケーションカタログにアプリケーションを追加します。WorkSpaces Applications に表示されるアプリケーションカタログには、この API オペレーションを使用して追加したアプリケーションと、イメージに追加したアプリケーションが含まれます。これらの方法の一方または両方を使用してアプリケーションを追加した後、ユーザーはアプリケーションを起動できます。

リクエストの構文

文字列 userSid;

list<Application> applications;

リクエストパラメータ

userSid

リクエストが適用されるユーザーの SID。

タイプ: 文字列

必須: はい

長さの制限: 最小長は 1、最大長は 208 文字。

applications

リクエストが適用されるアプリケーションのリスト。

タイプ: 文字列

必須: はい

Application オブジェクト

アプリケーションの表示と起動に必要なアプリケーションメタデータを記述します。アプリケーションの識別子は一意である必要があり、API オペレーションまたはイメージを介して指定された他のアプリケーションと競合してはなりません。

id

指定されているアプリケーションの ID。WorkSpaces アプリケーションレポートapplication_nameの値に対応するこの値は、ユーザーがアプリケーションを起動するときに提供されます。使用状況レポートを有効にすると、ユーザーがストリーミングセッション中に少なくとも 1 つのアプリケーションを起動する日ごとに、WorkSpaces Applications はアプリケーションレポートを 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 Applications はアプリケーションを閉じません。WorkSpaces Applications イメージで直接指定されたアプリケーションは削除できません。

リクエストの構文

文字列 userSid;

list<Application> applications;

リクエストパラメータ

userSid

リクエストが適用されるユーザーの SID。

タイプ: 文字列

必須: はい

長さの制限: 最小長は 1、最大長は 208 文字。

applications

リクエストが適用されるアプリケーションのリスト。

タイプ: 文字列

必須: はい

ClearApplicationsRequest オペレーション

AddApplicationsRequest オペレーションを使用して、アプリケーションカタログに追加されたすべてのアプリケーションを削除する必要があります。アプリケーションが削除されたら、起動することはできません。ClearApplicationsRequest オペレーションの使用時にアプリケーションが実行されている場合、WorkSpaces Applications はアプリケーションを閉じません。WorkSpaces Applications イメージで直接指定されたアプリケーションは削除できません。

リクエストの構文

文字列 userSid;

リクエストパラメータ

userSid

リクエストが適用されるユーザーの SID。

タイプ: 文字列

必須: はい

長さの制限: 最小長は 1、最大長は 208 文字。