AppStream / Client / drain_session_instance

drain_session_instance¶

AppStream.Client.drain_session_instance(**kwargs)¶

Drains the instance hosting the specified streaming session. The instance stops accepting new sessions while existing sessions continue uninterrupted. Once all sessions end, the instance is reclaimed and replaced. This only applies to multi-session fleets.

Request Syntax

response = client.drain_session_instance(
    SessionId='string'
)

Parameters:

SessionId (string) –

[REQUIRED]

The identifier of the streaming session.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

AppStream.Client.exceptions.ResourceNotFoundException
AppStream.Client.exceptions.ConcurrentModificationException
AppStream.Client.exceptions.OperationNotPermittedException