Skip to content

Paginators#

Index > CognitoIdentityProvider > Paginators

Auto-generated documentation for CognitoIdentityProvider type annotations stubs module mypy-boto3-cognito-idp.

AdminListGroupsForUserPaginator#

Type annotations and code completion for boto3.client("cognito-idp").get_paginator("admin_list_groups_for_user"). boto3 documentation

# AdminListGroupsForUserPaginator usage example

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import AdminListGroupsForUserPaginator

def get_admin_list_groups_for_user_paginator() -> AdminListGroupsForUserPaginator:
    return Session().client("cognito-idp").get_paginator("admin_list_groups_for_user")
# AdminListGroupsForUserPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import AdminListGroupsForUserPaginator

session = Session()

client = Session().client("cognito-idp")  # (1)
paginator: AdminListGroupsForUserPaginator = client.get_paginator("admin_list_groups_for_user")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CognitoIdentityProviderClient
  2. paginator: AdminListGroupsForUserPaginator
  3. item: AdminListGroupsForUserResponseTypeDef

paginate#

Type annotations and code completion for AdminListGroupsForUserPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Username: str,
    UserPoolId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[AdminListGroupsForUserResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See AdminListGroupsForUserResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: AdminListGroupsForUserRequestPaginateTypeDef = {  # (1)
    "Username": ...,
    "UserPoolId": ...,
}

parent.paginate(**kwargs)
  1. See AdminListGroupsForUserRequestPaginateTypeDef

AdminListUserAuthEventsPaginator#

Type annotations and code completion for boto3.client("cognito-idp").get_paginator("admin_list_user_auth_events"). boto3 documentation

# AdminListUserAuthEventsPaginator usage example

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import AdminListUserAuthEventsPaginator

def get_admin_list_user_auth_events_paginator() -> AdminListUserAuthEventsPaginator:
    return Session().client("cognito-idp").get_paginator("admin_list_user_auth_events")
# AdminListUserAuthEventsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import AdminListUserAuthEventsPaginator

session = Session()

client = Session().client("cognito-idp")  # (1)
paginator: AdminListUserAuthEventsPaginator = client.get_paginator("admin_list_user_auth_events")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CognitoIdentityProviderClient
  2. paginator: AdminListUserAuthEventsPaginator
  3. item: AdminListUserAuthEventsResponseTypeDef

paginate#

Type annotations and code completion for AdminListUserAuthEventsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    UserPoolId: str,
    Username: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[AdminListUserAuthEventsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See AdminListUserAuthEventsResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: AdminListUserAuthEventsRequestPaginateTypeDef = {  # (1)
    "UserPoolId": ...,
    "Username": ...,
}

parent.paginate(**kwargs)
  1. See AdminListUserAuthEventsRequestPaginateTypeDef

ListGroupsPaginator#

Type annotations and code completion for boto3.client("cognito-idp").get_paginator("list_groups"). boto3 documentation

# ListGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import ListGroupsPaginator

def get_list_groups_paginator() -> ListGroupsPaginator:
    return Session().client("cognito-idp").get_paginator("list_groups")
# ListGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import ListGroupsPaginator

session = Session()

client = Session().client("cognito-idp")  # (1)
paginator: ListGroupsPaginator = client.get_paginator("list_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CognitoIdentityProviderClient
  2. paginator: ListGroupsPaginator
  3. item: ListGroupsResponseTypeDef

paginate#

Type annotations and code completion for ListGroupsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    UserPoolId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListGroupsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListGroupsResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListGroupsRequestPaginateTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.paginate(**kwargs)
  1. See ListGroupsRequestPaginateTypeDef

ListIdentityProvidersPaginator#

Type annotations and code completion for boto3.client("cognito-idp").get_paginator("list_identity_providers"). boto3 documentation

# ListIdentityProvidersPaginator usage example

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import ListIdentityProvidersPaginator

def get_list_identity_providers_paginator() -> ListIdentityProvidersPaginator:
    return Session().client("cognito-idp").get_paginator("list_identity_providers")
# ListIdentityProvidersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import ListIdentityProvidersPaginator

session = Session()

client = Session().client("cognito-idp")  # (1)
paginator: ListIdentityProvidersPaginator = client.get_paginator("list_identity_providers")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CognitoIdentityProviderClient
  2. paginator: ListIdentityProvidersPaginator
  3. item: ListIdentityProvidersResponseTypeDef

paginate#

Type annotations and code completion for ListIdentityProvidersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    UserPoolId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListIdentityProvidersResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListIdentityProvidersResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListIdentityProvidersRequestPaginateTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.paginate(**kwargs)
  1. See ListIdentityProvidersRequestPaginateTypeDef

ListResourceServersPaginator#

Type annotations and code completion for boto3.client("cognito-idp").get_paginator("list_resource_servers"). boto3 documentation

# ListResourceServersPaginator usage example

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import ListResourceServersPaginator

def get_list_resource_servers_paginator() -> ListResourceServersPaginator:
    return Session().client("cognito-idp").get_paginator("list_resource_servers")
# ListResourceServersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import ListResourceServersPaginator

session = Session()

client = Session().client("cognito-idp")  # (1)
paginator: ListResourceServersPaginator = client.get_paginator("list_resource_servers")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CognitoIdentityProviderClient
  2. paginator: ListResourceServersPaginator
  3. item: ListResourceServersResponseTypeDef

paginate#

Type annotations and code completion for ListResourceServersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    UserPoolId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListResourceServersResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListResourceServersResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListResourceServersRequestPaginateTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.paginate(**kwargs)
  1. See ListResourceServersRequestPaginateTypeDef

ListUserPoolClientsPaginator#

Type annotations and code completion for boto3.client("cognito-idp").get_paginator("list_user_pool_clients"). boto3 documentation

# ListUserPoolClientsPaginator usage example

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import ListUserPoolClientsPaginator

def get_list_user_pool_clients_paginator() -> ListUserPoolClientsPaginator:
    return Session().client("cognito-idp").get_paginator("list_user_pool_clients")
# ListUserPoolClientsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import ListUserPoolClientsPaginator

session = Session()

client = Session().client("cognito-idp")  # (1)
paginator: ListUserPoolClientsPaginator = client.get_paginator("list_user_pool_clients")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CognitoIdentityProviderClient
  2. paginator: ListUserPoolClientsPaginator
  3. item: ListUserPoolClientsResponseTypeDef

paginate#

Type annotations and code completion for ListUserPoolClientsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    UserPoolId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListUserPoolClientsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListUserPoolClientsResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListUserPoolClientsRequestPaginateTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.paginate(**kwargs)
  1. See ListUserPoolClientsRequestPaginateTypeDef

ListUserPoolsPaginator#

Type annotations and code completion for boto3.client("cognito-idp").get_paginator("list_user_pools"). boto3 documentation

# ListUserPoolsPaginator usage example

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import ListUserPoolsPaginator

def get_list_user_pools_paginator() -> ListUserPoolsPaginator:
    return Session().client("cognito-idp").get_paginator("list_user_pools")
# ListUserPoolsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import ListUserPoolsPaginator

session = Session()

client = Session().client("cognito-idp")  # (1)
paginator: ListUserPoolsPaginator = client.get_paginator("list_user_pools")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CognitoIdentityProviderClient
  2. paginator: ListUserPoolsPaginator
  3. item: ListUserPoolsResponseTypeDef

paginate#

Type annotations and code completion for ListUserPoolsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListUserPoolsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListUserPoolsResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListUserPoolsRequestPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)
  1. See ListUserPoolsRequestPaginateTypeDef

ListUsersInGroupPaginator#

Type annotations and code completion for boto3.client("cognito-idp").get_paginator("list_users_in_group"). boto3 documentation

# ListUsersInGroupPaginator usage example

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import ListUsersInGroupPaginator

def get_list_users_in_group_paginator() -> ListUsersInGroupPaginator:
    return Session().client("cognito-idp").get_paginator("list_users_in_group")
# ListUsersInGroupPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import ListUsersInGroupPaginator

session = Session()

client = Session().client("cognito-idp")  # (1)
paginator: ListUsersInGroupPaginator = client.get_paginator("list_users_in_group")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CognitoIdentityProviderClient
  2. paginator: ListUsersInGroupPaginator
  3. item: ListUsersInGroupResponseTypeDef

paginate#

Type annotations and code completion for ListUsersInGroupPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    UserPoolId: str,
    GroupName: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListUsersInGroupResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListUsersInGroupResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListUsersInGroupRequestPaginateTypeDef = {  # (1)
    "UserPoolId": ...,
    "GroupName": ...,
}

parent.paginate(**kwargs)
  1. See ListUsersInGroupRequestPaginateTypeDef

ListUsersPaginator#

Type annotations and code completion for boto3.client("cognito-idp").get_paginator("list_users"). boto3 documentation

# ListUsersPaginator usage example

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import ListUsersPaginator

def get_list_users_paginator() -> ListUsersPaginator:
    return Session().client("cognito-idp").get_paginator("list_users")
# ListUsersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_cognito_idp.paginator import ListUsersPaginator

session = Session()

client = Session().client("cognito-idp")  # (1)
paginator: ListUsersPaginator = client.get_paginator("list_users")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: CognitoIdentityProviderClient
  2. paginator: ListUsersPaginator
  3. item: ListUsersResponseTypeDef

paginate#

Type annotations and code completion for ListUsersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    UserPoolId: str,
    AttributesToGet: Sequence[str] = ...,
    Filter: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListUsersResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListUsersResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListUsersRequestPaginateTypeDef = {  # (1)
    "UserPoolId": ...,
}

parent.paginate(**kwargs)
  1. See ListUsersRequestPaginateTypeDef