翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# GetSessionScreenshots
1 つ以上の Amazon DCV セッションのスクリーンショットを取得します。
イメージ形式を変更するには、セッションマネージャーブローカー設定で `session-screenshot-format` パラメータを設定します。詳細については、「*Amazon DCV セッションマネージャー管理者ガイド*」の「[ブローカー設定ファイル](https://docs.aws.amazon.com/dcv/latest/sm-admin/broker-file.html)」を参照してください。
`GetSessionScreenshots` リクエストの `MaxWidth` または `MaxHeight` パラメータが指定されていない場合は、セッションマネージャーブローカー設定ファイルで設定された `session-screenshot-max-width` および `session-screenshot-max-height` の値が使用されます。これらのパラメータを変更するには、「*Amazon DCV セッションマネージャー管理者ガイド*」の「[ブローカー設定ファイル](https://docs.aws.amazon.com/dcv/latest/sm-admin/broker-file.html)」も参照してください。
スクリーンショット解像度の上限値は、リモートセッション解像度に制限されます。`MaxWidth` および `MaxHeight` パラメータが現在のリモートセッション解像度よりも高い値に設定されている場合、結果のスクリーンショットは実際のセッション解像度に制限されます。
**注記**
アクセスコンソールからこれらの値を変更するには、「*Amazon DCV アクセスコンソール管理者ガイド*」の「[ウェブクライアント設定ファイル](https://docs.aws.amazon.com/dcv/latest/access-console/web-client-config-files.html)」を参照してください。Session Manager CLI でこれらの値を変更するには、「*Amazon DCV CLI ガイド*」の「`get-session-screenshots`」を参照してください。
**Topics**
+ [リクエストパラメータ](#request)
+ [レスポンスパラメータ](#response)
+ [例](#example)
## リクエストパラメータ
**`SessionId`**
スクリーンショットの取得元となる Amazon DCV セッションの ID。
タイプ: 文字列
必須: はい
**`MaxWidth`**
セッションスクリーンショットの最大幅、ピクセル単位。指定しない場合、セッションマネージャーブローカー設定の値が適用されます。指定した場合、0 より大きい数値である必要があります。
タイプ: 整数
必須: いいえ
**`MaxHeight`**
セッションスクリーンショットの最大高さ、ピクセル単位。指定しない場合、セッションマネージャーブローカー設定の値が適用されます。指定した場合、0 より大きい数値である必要があります。
タイプ: 整数
必須: はい
## レスポンスパラメータ
**`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`**
失敗の理由。
**`GetSessionScreenshotRequestData`**
失敗した元のリクエスト。
## 例
------
#### [ Python ]
**リクエスト**
次の例では、最大幅を 800 に設定し、最大高さを 600 に設定して、2 つのセッション (`sessionId1` および `sessionId2`) からスクリーンショットを取得します。セッション `sessionId2` は存在せず、失敗します。
```
from swagger_client.models.describe_servers_request_data import GetSessionScreenshotRequestData
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, max_width=None, max_height=None):
request = [GetSessionScreenshotRequestData(session_id=session_id, max_width=max_width, max_height=max_height) 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"]), 800, 600)
```
**応答**
以下は出力例です。
```
{
"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."
}
]
}
```
------