DeleteSessions - Gerenciador de Sessões do Amazon DCV
Parâmetros de solicitaçãoParâmetros de respostaExemplo

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

DeleteSessions

Exclui a sessão especificada do Amazon DCV e a remove do cache do Agente.

Parâmetros de solicitação

SessionId

O ID da sessão a ser excluído.

Tipo: string

Obrigatório: Sim

Owner

O proprietário da sessão a ser excluído.

Tipo: string

Obrigatório: Sim

Force

Remove uma sessão do cache do agente ao tentar excluí-la do servidor Amazon DCV. Isso é útil para remover sessões desatualizadas do cache do Agente. Por exemplo, se um servidor Amazon DCV foi interrompido, mas as sessões ainda estiverem registradas no Agente, use esse sinalizador para limpar as sessões do cache do Agente.

Lembre-se de que, se a sessão ainda estiver ativa, ela será armazenada novamente em cache pelo Agente.

Valores válidos: true | false

Tipo: booliano

Obrigatório: Não

Parâmetros de resposta

SessionId

O ID da sessão

State

Retornado somente se as sessões foram excluídas com sucesso. Indica o estado atual da sessão. Se a solicitação for concluída com êxito, a sessão passará para o estado DELETING. Pode demorar alguns minutos para que a sessão seja excluída. Quando ele é excluído, o estado muda de DELETING para DELETED.

FailureReason

Retornado somente se algumas sessões não puderem ser excluídas. Indica por que a sessão não pôde ser excluída.

Exemplo

Python
Solicitação

O exemplo a seguir exclui duas sessões: uma sessão com um ID SessionId123 que pertence ao user1 e uma sessão com um ID SessionIdabc que pertence ao 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')])
Resposta

A seguir está a saída de exemplo. O SessionId123 foi excluído com sucesso, mas o SessionIdabc não pôde ser excluído.

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