本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# DeleteSessions
<a name="DeleteSessions"></a>

刪除指定的 Amazon DCV 工作階段，並將其從中介裝置的快取中移除。

**Topics**
+ [請求參數](#request)
+ [回應參數](#response)
+ [範例](#example)

## 請求參數
<a name="request"></a>

**`SessionId`**  
要刪除的工作階段 ID。  
類型：字串  
必要：是

**`Owner`**  
要刪除之工作階段的擁有者。  
類型：字串  
必要：是

**`Force`**  
從中介裝置的快取移除工作階段，並嘗試從 Amazon DCV 伺服器將其刪除。這有助於從中介裝置的快取中移除過時的工作階段。例如，如果 Amazon DCV 伺服器已停止，但工作階段仍在代理程式上註冊，請使用此旗標從代理程式的快取中清除工作階段。  
請記住，如果工作階段仍處於作用中狀態，則代理程式會重新快取該工作階段。  
有效值：`true` \| `false`  
類型：布林值  
必要：否

## 回應參數
<a name="response"></a>

**`SessionId`**  
工作階段的 ID

**`State`**  
只有在工作階段已成功刪除時才會傳回。指出工作階段的目前狀態。如果請求成功完成，工作階段會轉換為 `DELETING` 狀態。刪除工作階段可能需要幾分鐘的時間。刪除後，狀態會從 轉換為 `DELETING` `DELETED`。

**`FailureReason`**  
只有在無法刪除某些工作階段時才會傳回。指出無法刪除工作階段的原因。

## 範例
<a name="example"></a>

------
#### [ Python ]

**請求**  
下列範例會刪除兩個工作階段：具有 所擁有 ID `SessionId123`的工作階段`user1`，以及具有 所擁有 ID `SessionIdabc`的工作階段`user99`。

```
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"
        }
    ]
}
```

------