翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# DescribeSessions
1 つ以上の Amazon DCV セッションを記述します。
**Topics**
+ [
## リクエストパラメータ
](#request)
+ [
## レスポンスパラメータ
](#response)
+ [
## 例
](#example)
## リクエストパラメータ
**`SessionIds`**
記述するセッションの ID。
タイプ: 文字列
必須: いいえ
**`NextToken`**
次の結果ページの取得に使用するトークン。
タイプ: 文字列
必須: いいえ
**`Filters`**
リクエストに適用する追加のフィルター。サポートされているフィルターは次のとおりです。
+ tag:key — セッションに割り当てられたタグ。
+ owner — セッションの所有者。
タイプ: 文字列
必須: いいえ
## レスポンスパラメータ
**`Id`**
セッションの一意の ID。
**`Name`**
セッションの名前。
**`Owner`**
セッションの所有者。
**`Server`**
セッションが実行されているサーバーに関する情報。このデータ構造には、次のネスト済みレスポンスパラメータが含まれます。
**`Ip`**
Amazon DCV サーバーホストの IP アドレス。
**`Hostname`**
Amazon DCV サーバーホストのホスト名。
**`Port`**
Amazon DCV サーバーが Amazon DCV クライアントと通信するポート。
**`Endpoints`**
Amazon DCV サーバーのエンドポイントに関する情報。このデータ構造には、次のネスト済みレスポンスパラメータが含まれます。
**`IpAddress`**
サーバーエンドポイントの IP アドレス。
**`Port`**
サーバーエンドポイントのポート。
**`Protocol`**
サーバーエンドポイントで使用されるプロトコル。可能な値は以下のとおりです:
+ `HTTP` — エンドポイントでは WebSocket (TCP) プロトコルが使用されます。
+ `QUIC` — エンドポイントでは QUIC (UDP) プロトコルが使用されます。
**`WebUrlPath`**
サーバーエンドポイントのウェブ URL パス。HTTP プロトコルでのみ使用できます。
**`Tags`**
サーバーに割り当てられているタグ。このデータ構造には、次のネスト済みレスポンスパラメータが含まれます。
**`Key`**
タグキー。
**`Value`**
タグ値。
**`Type`**
セッションのタイプ。
**`State`**
セッションの現在の状態。可能な値は以下のとおりです。
+ `CREATING` — ブローカーでセッションが作成されています。
+ `READY` — セッションはクライアント接続を受け入れる準備が整っている状態です。
+ `DELETING` — セッションが削除されています。
+ `DELETED` — セッションが削除されました。
+ `UNKNOWN` — セッションの状態を判別できません。ブローカーとエージェントが通信できない可能性があります。
**`Substate`**
セッションの現在のサブステート。可能な値は以下のとおりです。
+ `SESSION_PLACING` - セッションは利用可能な DCV サーバーに配置されるのを待っています。
+ `PENDING_PREPARATION` - セッションは作成済みですが使用できません。DCV サーバーに接続されています。
**`CreationTime`**
セッションが作成された日時。
**`LastDisconnectionTime`**
クライアントが最後に切断された日時。
**`NumOfConnections`**
アクティブなクライアント接続の数。
**`StorageRoot`**
セッションストレージに使用されるフォルダのパスを指定します。Amazon DCV セッションストレージの詳細については、「*Amazon DCV 管理者ガイド*」の「[セッションストレージの有効化](https://docs.aws.amazon.com/dcv/latest/adminguide/manage-storage.html)」を参照してください。
タイプ: 文字列
必須: いいえ
## 例
------
#### [ Python ]
**リクエスト**
次の例では、`user1` により所有されており `os=windows` のタグがあるセッションについて説明します。
```
from swagger_client.models.describe_sessions_request_data import DescribeSessionsRequestData
from swagger_client.models.key_value_pair import KeyValuePair
def get_sessions_api():
api_instance = swagger_client.SessionsApi(swagger_client.ApiClient(get_client_configuration()))
set_request_headers(api_instance.api_client)
return api_instance
def describe_sessions(session_ids=None, next_token=None, tags=None, owner=None):
filters = list()
if tags:
for tag in tags:
filter_key_value_pair = KeyValuePair(key='tag:' + tag['Key'], value=tag['Value'])
filters.append(filter_key_value_pair)
if owner:
filter_key_value_pair = KeyValuePair(key='owner', value=owner)
filters.append(filter_key_value_pair)
request = DescribeSessionsRequestData(session_ids=session_ids, filters=filters, next_token=next_token)
print('Describe Sessions Request:', request)
api_instance = get_sessions_api()
api_response = api_instance.describe_sessions(body=request)
print('Describe Sessions Response', api_response)
def main():
describe_sessions(
owner='user1',
tags=[{'Key': 'os', 'Value': 'windows'}])
```
**応答**
以下は出力例です。
```
{
"Sessions": [
{
"Id": "SessionId1897",
"Name": "a session name",
"Owner": "an owner 1890",
"Server": {
"Ip": "1.1.1.123",
"Hostname": "server hostname",
"Port": "1222",
"Endpoints": [
{
"IpAddress": "x.x.x.x",
"Port": 8443,
"WebUrlPath": "/",
"Protocol": "HTTP"
},
{
"IpAddress": "x.x.x.x",
"Port": 9443,
"WebUrlPath": "/",
"Protocol": "HTTP"
},
{
"IpAddress": "x.x.x.x",
"Port": 8443,
"WebUrlPath": "",
"Protocol": "QUIC"
}
],
"Tags": [
{
"Key": "os",
"Value": "windows"
},
{
"Key": "ram",
"Value": "4gb"
}
]
},
"Type": "VIRTUAL",
"State": "READY",
"CreationTime": "2020-10-06T10:15:31.633Z",
"LastDisconnectionTime": "2020-10-06T10:15:31.633Z",
"NumOfConnections": 2,
"StorageRoot" : "/storage/root"
},
{
"Id": "SessionId1895",
"Name": "a session name",
"Owner": "an owner 1890",
"Server": {
"Ip": "1.1.1.123",
"Hostname": "server hostname",
"Port": "1222",
"Endpoints": [
{
"IpAddress": "x.x.x.x",
"Port": 8443,
"WebUrlPath": "/",
"Protocol": "HTTP"
},
{
"IpAddress": "x.x.x.x",
"Port": 9443,
"WebUrlPath": "/",
"Protocol": "HTTP"
},
{
"IpAddress": "x.x.x.x",
"Port": 8443,
"WebUrlPath": "",
"Protocol": "QUIC"
}
],
"Tags": [
{
"Key": "os",
"Value": "windows"
},
{
"Key": "ram",
"Value": "4gb"
}
]
},
"Type": "VIRTUAL",
"State": "DELETING",
"CreationTime": "2020-10-06T10:15:31.633Z",
"LastDisconnectionTime": "2020-10-06T10:15:31.633Z",
"NumOfConnections": 2,
"StorageRoot" : "/storage/root"
}
]
}
```
------