DeleteSessions - Amazon DCV セッションマネージャー

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

DeleteSessions

指定された Amazon DCV セッションが消去され、ブローカーのキャッシュから削除されます。

パラメータのリクエスト

SessionId

削除するセッションの ID。

タイプ: 文字列

必須: はい

Owner

削除するセッションの所有者。

タイプ: 文字列

必須: はい

Force

Amazon DCV サーバーからセッションを削除しようとすると、そのセッションがブローカーのキャッシュから削除されます。これは、ブローカーのキャッシュから古いセッションを削除する場合に便利です。例えば、Amazon DCV サーバーが停止されたにもかかわらずセッションがブローカーに登録されている場合、このフラグを使用してブローカーのキャッシュからセッションを消去します。

それでもセッションがアクティブである場合は、ブローカーによって再キャッシュされることに注意してください。

有効な値: true | false

型: ブール値

必須: いいえ

レスポンスパラメータ

SessionId

セッションの ID

State

セッションが正常に削除された場合にのみ返されます。セッションの現在の状態を示します。リクエストが正常に完了すると、セッションが DELETING 状態に移行します。セッションが削除されるまでに数分かかることがあります。セッションは削除されると状態が DELETING から DELETED に移行します。

FailureReason

一部のセッションを削除できなかった場合にのみ返されます。セッションを削除できなかった理由を示します。

Python
リクエスト

次の例では 2 つのセッションを削除します。1 つは ID が SessionId123 であり user1 に所有されているセッションで、もう 1 つは ID が SessionIdabcuser99 に所有されているセッションです。

from swagger_client.models.delete_session_request_data import DeleteSessionRequestData 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 delete_sessions(sessions_to_delete, force=False): delete_sessions_request = list() for session_id, owner in sessions_to_delete: a_request = DeleteSessionRequestData(session_id=session_id, owner=owner, force=force) delete_sessions_request.append(a_request) print('Delete Sessions Request:', delete_sessions_request) api_instance = get_sessions_api() api_response = api_instance.delete_sessions(body=delete_sessions_request) print('Delete Sessions Response', api_response) def main(): delete_sessions([('SessionId123', 'an owner user1'), ('SessionIdabc', 'user99')])
応答

以下はサンプル出力です。SessionId123 は正常に削除されましたが、SessionIdabc は削除されませんでした。

{ "RequestId": "10311636-df90-4cd1-bcf7-474e9675b7cd", "SuccessfulList": [ { "SessionId": "SessionId123", "State": "DELETING" } ], "UnsuccessfulList": [ { "SessionId": "SessionIdabc", "FailureReason": "The requested dcvSession does not exist" } ] }