Skip to content

iter_describe_player_sessions

iter_describe_player_sessions(
    *,
    config_overrides: Optional[GameLiftClientConfig] = None,
    game_session_id: Optional[ArnStringModel] = None,
    player_id: Optional[PlayerId] = None,
    player_session_id: Optional[PlayerSessionId] = None,
    player_session_status_filter: Optional[NonZeroAndMaxString] = None,
    limit: Optional[PositiveInteger] = None,
    next_token: Optional[NonZeroAndMaxString] = None,
) -> Iterator[PlayerSession]
Source code in docs_src/capo_gamelift/_services/game_lift.py
def iter_describe_player_sessions(
    self,
    *,
    config_overrides: Optional[GameLiftClientConfig] = None,
    game_session_id: Optional[
        "capo_gamelift.types.arn_string_model.ArnStringModel"
    ] = None,
    player_id: Optional["capo_gamelift.types.player_id.PlayerId"] = None,
    player_session_id: Optional[
        "capo_gamelift.types.player_session_id.PlayerSessionId"
    ] = None,
    player_session_status_filter: Optional[
        "capo_gamelift.types.non_zero_and_max_string.NonZeroAndMaxString"
    ] = None,
    limit: Optional["capo_gamelift.types.positive_integer.PositiveInteger"] = None,
    next_token: Optional[
        "capo_gamelift.types.non_zero_and_max_string.NonZeroAndMaxString"
    ] = None,
) -> "Iterator[capo_gamelift.types.player_session.PlayerSession]":
    _token = next_token
    while True:
        _response = self.describe_player_sessions(
            config_overrides=config_overrides,
            game_session_id=game_session_id,
            player_id=player_id,
            player_session_id=player_session_id,
            player_session_status_filter=player_session_status_filter,
            limit=limit,
            next_token=_token,
        )
        _page = _resolve_path(_response, ("player_sessions",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("next_token",))
        if not _token:
            break