iter_get_usage_plans ¶

iter_get_usage_plans(
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    position: Optional[String] = None,
    key_id: Optional[String] = None,
    limit: Optional[NullableInteger] = None,
) -> Iterator[UsagePlan]

Source code in docs_src/capo_api_gateway/_services/api_gateway.py

def iter_get_usage_plans(
    self,
    *,
    config_overrides: Optional[APIGatewayClientConfig] = None,
    position: Optional["capo_api_gateway.types.string.String"] = None,
    key_id: Optional["capo_api_gateway.types.string.String"] = None,
    limit: Optional[
        "capo_api_gateway.types.nullable_integer.NullableInteger"
    ] = None,
) -> "Iterator[capo_api_gateway.types.usage_plan.UsagePlan]":
    _token = position
    while True:
        _response = self.get_usage_plans(
            config_overrides=config_overrides,
            position=_token,
            key_id=key_id,
            limit=limit,
        )
        _page = _resolve_path(_response, ("items",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("position",))
        if not _token:
            break