Skip to content

GameSessionDetail

Source code in docs_src/capo_gamelift/types/game_session_detail.py
class GameSessionDetail(TypedDict, closed=True):
    game_session: NotRequired["capo_gamelift.types.game_session.GameSession"]
    """<p>Object that describes a game session.</p>"""
    protection_policy: NotRequired[
        "capo_gamelift.types.protection_policy.ProtectionPolicy"
    ]
    """<p>Current status of protection for the game session.</p> <ul> <li> <p> <b>NoProtection</b> -- The game session can be terminated during a scale-down event.</p> </li> <li> <p> <b>FullProtection</b> -- If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li> </ul>"""

game_session instance-attribute

game_session: NotRequired[GameSession]

Object that describes a game session.

protection_policy instance-attribute

protection_policy: NotRequired[ProtectionPolicy]

Current status of protection for the game session.

  • NoProtection -- The game session can be terminated during a scale-down event.

  • FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.