GetSessionScreenshots

1 つ以上の Amazon DCVセッションのスクリーンショットを取得します。

スクリーンショットのイメージファイルのタイプと解像度は、セッションマネージャーブローカーの設定によって異なります。イメージファイルのタイプを変更するには、session-screenshot-format パラメータを設定します。解像度を変更するには、session-screenshot-max-width パラメータと session-screenshot-max-height パラメータを設定します。詳細については、「Amazon DCV Session Manager 管理者ガイド」の「ブローカー設定ファイル」を参照してください。

リクエストパラメータ

SessionId

スクリーンショットを取得する Amazon DCVセッションの ID。

タイプ: 文字列

必須: はい

レスポンスパラメータ

RequestId

リクエストの一意の ID。

SuccessfulList

成功したスクリーンショットに関する情報。このデータ構造には、次のネスト済みレスポンスパラメータが含まれます。

SessionScreenshot

スクリーンショットに関する情報。このデータ構造には、次のネスト済みレスポンスパラメータが含まれます。

SessionId

スクリーンショットが撮影された Amazon DCVセッションの ID。

Images

イメージに関する情報。このデータ構造には、次のネスト済みレスポンスパラメータが含まれます。

Format

イメージの形式。可能値には jpeg や png などがあります。

Data

スクリーンショットイメージの base64 エンコード形式。

CreationTime

スクリーンショットが撮影された日時。

Primary

スクリーンショットが Amazon DCVセッションのプライマリディスプレイであるかどうかを示します。

UnsuccessfulList

失敗したスクリーンショットに関する情報。このデータ構造には、次のネスト済みレスポンスパラメータが含まれます。

GetSesionScreenshotRequestData

失敗した元のリクエスト。

SessionId

スクリーンショットの取得元の Amazon DCVセッションの ID。

FailureReason

失敗の理由。

例

Python

リクエスト

次の例では、2 つのセッション (sessionId1 と sessionId2) からスクリーンショットを取得します。セッション sessionId2 は存在せず、失敗します。

from swagger_client.models.describe_servers_request_data import DescribeServersRequestData

def get_sessions_api():
    api_instance = swagger_client.ServersApi(swagger_client.ApiClient(get_client_configuration()))
    set_request_headers(api_instance.api_client)
    return api_instance

def get_session_screenshots(session_ids):
    request = [GetSessionScreenshotRequestData(session_id=session_id) for session_id in session_ids]
    print('Get Session Screenshots Request:', request)
    api_instance = get_sessions_api()
    api_response = api_instance.get_session_screenshots(body=request)
    print('Get Session Screenshots Response:', api_response)

def main():
    get_session_screenshots(["sessionId1", "sessionId2"])

レスポンス

以下は出力例です。

{
    "RequestId": "542735ef-f6ab-47d8-90e5-23df31d8d166",
    "SuccessfulList": [
        {
            "SessionScreenshot": {
                "SessionId": "sessionId1",
                "Images": [
                    {
                        "Format": "png",
                        "Data": "iVBORw0KGgoAAAANSUhEUgAAAEXAMPLE",
                        "CreationTime": "2021-03-30T15:47:06.822Z",
                        "Primary": true
                    }
                ]
            }
        }
    ],
    "UnsuccessfulList": [
        {
            "GetSessionScreenshotRequestData": {
                "SessionId": "sessionId2"
            },
            "FailureReason": "Dcv session not found."
        }
    ]
}