iter_list_users `async` ¶

iter_list_users(
    user_pool_id: UserPoolIdType,
    *,
    config_overrides: Optional[AsyncCognitoIdentityProviderClientConfig] = None,
    attributes_to_get: Optional[SearchedAttributeNamesListType] = None,
    limit: Optional[QueryLimitType] = None,
    pagination_token: Optional[SearchPaginationTokenType] = None,
    filter: Optional[UserFilterType] = None,
) -> AsyncIterator[UserType]

Source code in docs_src/capo_cognito_identity_provider/_services/async_cognito_identity_provider.py

async def iter_list_users(
    self,
    user_pool_id: "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType",
    *,
    config_overrides: Optional[AsyncCognitoIdentityProviderClientConfig] = None,
    attributes_to_get: Optional[
        "capo_cognito_identity_provider.types.searched_attribute_names_list_type.SearchedAttributeNamesListType"
    ] = None,
    limit: Optional[
        "capo_cognito_identity_provider.types.query_limit_type.QueryLimitType"
    ] = None,
    pagination_token: Optional[
        "capo_cognito_identity_provider.types.search_pagination_token_type.SearchPaginationTokenType"
    ] = None,
    filter: Optional[
        "capo_cognito_identity_provider.types.user_filter_type.UserFilterType"
    ] = None,
) -> "AsyncIterator[capo_cognito_identity_provider.types.user_type.UserType]":
    _token = pagination_token
    while True:
        _response = await self.list_users(
            user_pool_id,
            config_overrides=config_overrides,
            attributes_to_get=attributes_to_get,
            limit=limit,
            pagination_token=_token,
            filter=filter,
        )
        _page = _resolve_path(_response, ("users",))
        for _item in _page or []:
            yield _item
        _token = _resolve_path(_response, ("pagination_token",))
        if not _token:
            break

iter_list_users async ¶

iter_list_users `async` ¶