Paginators

Index > QBusiness > Paginators

Auto-generated documentation for QBusiness type annotations stubs module types-aiobotocore-qbusiness.

GetChatControlsConfigurationPaginator

Type annotations and code completion for session.client("qbusiness").get_paginator("get_chat_controls_configuration"). boto3 documentation

# GetChatControlsConfigurationPaginator usage example

from aioboto3.session import Session

from types_aiobotocore_qbusiness.paginator import GetChatControlsConfigurationPaginator

session = Session()

session = get_session()
async with session.client("qbusiness") as client:  # (1)
    paginator: GetChatControlsConfigurationPaginator = client.get_paginator("get_chat_controls_configuration")  # (2)
    async for item in paginator.paginate(...):
        item: GetChatControlsConfigurationResponseTypeDef
        print(item)  # (3)

1. client: QBusinessClient
2. paginator: GetChatControlsConfigurationPaginator
3. item: GetChatControlsConfigurationResponseTypeDef

paginate

Type annotations and code completion for GetChatControlsConfigurationPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    applicationId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[GetChatControlsConfigurationResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See GetChatControlsConfigurationResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: GetChatControlsConfigurationRequestGetChatControlsConfigurationPaginateTypeDef = {  # (1)
    "applicationId": ...,
}

parent.paginate(**kwargs)

1. See GetChatControlsConfigurationRequestGetChatControlsConfigurationPaginateTypeDef

ListApplicationsPaginator

Type annotations and code completion for session.client("qbusiness").get_paginator("list_applications"). boto3 documentation

# ListApplicationsPaginator usage example

from aioboto3.session import Session

from types_aiobotocore_qbusiness.paginator import ListApplicationsPaginator

session = Session()

session = get_session()
async with session.client("qbusiness") as client:  # (1)
    paginator: ListApplicationsPaginator = client.get_paginator("list_applications")  # (2)
    async for item in paginator.paginate(...):
        item: ListApplicationsResponseTypeDef
        print(item)  # (3)

1. client: QBusinessClient
2. paginator: ListApplicationsPaginator
3. item: ListApplicationsResponseTypeDef

paginate

Type annotations and code completion for ListApplicationsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListApplicationsResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListApplicationsResponseTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See ListApplicationsRequestListApplicationsPaginateTypeDef

ListConversationsPaginator

Type annotations and code completion for session.client("qbusiness").get_paginator("list_conversations"). boto3 documentation

# ListConversationsPaginator usage example

from aioboto3.session import Session

from types_aiobotocore_qbusiness.paginator import ListConversationsPaginator

session = Session()

session = get_session()
async with session.client("qbusiness") as client:  # (1)
    paginator: ListConversationsPaginator = client.get_paginator("list_conversations")  # (2)
    async for item in paginator.paginate(...):
        item: ListConversationsResponseTypeDef
        print(item)  # (3)

1. client: QBusinessClient
2. paginator: ListConversationsPaginator
3. item: ListConversationsResponseTypeDef

paginate

Type annotations and code completion for ListConversationsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    applicationId: str,
    userId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListConversationsResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListConversationsResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: ListConversationsRequestListConversationsPaginateTypeDef = {  # (1)
    "applicationId": ...,
    "userId": ...,
}

parent.paginate(**kwargs)

1. See ListConversationsRequestListConversationsPaginateTypeDef

ListDataSourceSyncJobsPaginator

Type annotations and code completion for session.client("qbusiness").get_paginator("list_data_source_sync_jobs"). boto3 documentation

# ListDataSourceSyncJobsPaginator usage example

from aioboto3.session import Session

from types_aiobotocore_qbusiness.paginator import ListDataSourceSyncJobsPaginator

session = Session()

session = get_session()
async with session.client("qbusiness") as client:  # (1)
    paginator: ListDataSourceSyncJobsPaginator = client.get_paginator("list_data_source_sync_jobs")  # (2)
    async for item in paginator.paginate(...):
        item: ListDataSourceSyncJobsResponseTypeDef
        print(item)  # (3)

1. client: QBusinessClient
2. paginator: ListDataSourceSyncJobsPaginator
3. item: ListDataSourceSyncJobsResponseTypeDef

paginate

Type annotations and code completion for ListDataSourceSyncJobsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    applicationId: str,
    dataSourceId: str,
    indexId: str,
    endTime: Union[datetime, str] = ...,
    startTime: Union[datetime, str] = ...,
    statusFilter: DataSourceSyncJobStatusType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> AsyncIterator[ListDataSourceSyncJobsResponseTypeDef]:  # (3)
    ...

1. See DataSourceSyncJobStatusType
2. See PaginatorConfigTypeDef
3. See ListDataSourceSyncJobsResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: ListDataSourceSyncJobsRequestListDataSourceSyncJobsPaginateTypeDef = {  # (1)
    "applicationId": ...,
    "dataSourceId": ...,
    "indexId": ...,
}

parent.paginate(**kwargs)

1. See ListDataSourceSyncJobsRequestListDataSourceSyncJobsPaginateTypeDef

ListDataSourcesPaginator

Type annotations and code completion for session.client("qbusiness").get_paginator("list_data_sources"). boto3 documentation

# ListDataSourcesPaginator usage example

from aioboto3.session import Session

from types_aiobotocore_qbusiness.paginator import ListDataSourcesPaginator

session = Session()

session = get_session()
async with session.client("qbusiness") as client:  # (1)
    paginator: ListDataSourcesPaginator = client.get_paginator("list_data_sources")  # (2)
    async for item in paginator.paginate(...):
        item: ListDataSourcesResponseTypeDef
        print(item)  # (3)

1. client: QBusinessClient
2. paginator: ListDataSourcesPaginator
3. item: ListDataSourcesResponseTypeDef

paginate

Type annotations and code completion for ListDataSourcesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    applicationId: str,
    indexId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListDataSourcesResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListDataSourcesResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: ListDataSourcesRequestListDataSourcesPaginateTypeDef = {  # (1)
    "applicationId": ...,
    "indexId": ...,
}

parent.paginate(**kwargs)

1. See ListDataSourcesRequestListDataSourcesPaginateTypeDef

ListDocumentsPaginator

Type annotations and code completion for session.client("qbusiness").get_paginator("list_documents"). boto3 documentation

# ListDocumentsPaginator usage example

from aioboto3.session import Session

from types_aiobotocore_qbusiness.paginator import ListDocumentsPaginator

session = Session()

session = get_session()
async with session.client("qbusiness") as client:  # (1)
    paginator: ListDocumentsPaginator = client.get_paginator("list_documents")  # (2)
    async for item in paginator.paginate(...):
        item: ListDocumentsResponseTypeDef
        print(item)  # (3)

1. client: QBusinessClient
2. paginator: ListDocumentsPaginator
3. item: ListDocumentsResponseTypeDef

paginate

Type annotations and code completion for ListDocumentsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    applicationId: str,
    indexId: str,
    dataSourceIds: Sequence[str] = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListDocumentsResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListDocumentsResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: ListDocumentsRequestListDocumentsPaginateTypeDef = {  # (1)
    "applicationId": ...,
    "indexId": ...,
}

parent.paginate(**kwargs)

1. See ListDocumentsRequestListDocumentsPaginateTypeDef

ListGroupsPaginator

Type annotations and code completion for session.client("qbusiness").get_paginator("list_groups"). boto3 documentation

# ListGroupsPaginator usage example

from aioboto3.session import Session

from types_aiobotocore_qbusiness.paginator import ListGroupsPaginator

session = Session()

session = get_session()
async with session.client("qbusiness") as client:  # (1)
    paginator: ListGroupsPaginator = client.get_paginator("list_groups")  # (2)
    async for item in paginator.paginate(...):
        item: ListGroupsResponseTypeDef
        print(item)  # (3)

1. client: QBusinessClient
2. paginator: ListGroupsPaginator
3. item: ListGroupsResponseTypeDef

paginate

Type annotations and code completion for ListGroupsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    applicationId: str,
    indexId: str,
    updatedEarlierThan: Union[datetime, str],
    dataSourceId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListGroupsResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListGroupsResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: ListGroupsRequestListGroupsPaginateTypeDef = {  # (1)
    "applicationId": ...,
    "indexId": ...,
    "updatedEarlierThan": ...,
}

parent.paginate(**kwargs)

1. See ListGroupsRequestListGroupsPaginateTypeDef

ListIndicesPaginator

Type annotations and code completion for session.client("qbusiness").get_paginator("list_indices"). boto3 documentation

# ListIndicesPaginator usage example

from aioboto3.session import Session

from types_aiobotocore_qbusiness.paginator import ListIndicesPaginator

session = Session()

session = get_session()
async with session.client("qbusiness") as client:  # (1)
    paginator: ListIndicesPaginator = client.get_paginator("list_indices")  # (2)
    async for item in paginator.paginate(...):
        item: ListIndicesResponseTypeDef
        print(item)  # (3)

1. client: QBusinessClient
2. paginator: ListIndicesPaginator
3. item: ListIndicesResponseTypeDef

paginate

Type annotations and code completion for ListIndicesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    applicationId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListIndicesResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListIndicesResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: ListIndicesRequestListIndicesPaginateTypeDef = {  # (1)
    "applicationId": ...,
}

parent.paginate(**kwargs)

1. See ListIndicesRequestListIndicesPaginateTypeDef

ListMessagesPaginator

Type annotations and code completion for session.client("qbusiness").get_paginator("list_messages"). boto3 documentation

# ListMessagesPaginator usage example

from aioboto3.session import Session

from types_aiobotocore_qbusiness.paginator import ListMessagesPaginator

session = Session()

session = get_session()
async with session.client("qbusiness") as client:  # (1)
    paginator: ListMessagesPaginator = client.get_paginator("list_messages")  # (2)
    async for item in paginator.paginate(...):
        item: ListMessagesResponsePaginatorTypeDef
        print(item)  # (3)

1. client: QBusinessClient
2. paginator: ListMessagesPaginator
3. item: ListMessagesResponsePaginatorTypeDef

paginate

Type annotations and code completion for ListMessagesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    applicationId: str,
    conversationId: str,
    userId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListMessagesResponsePaginatorTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListMessagesResponsePaginatorTypeDef

# paginate method usage example with argument unpacking

kwargs: ListMessagesRequestListMessagesPaginateTypeDef = {  # (1)
    "applicationId": ...,
    "conversationId": ...,
    "userId": ...,
}

parent.paginate(**kwargs)

1. See ListMessagesRequestListMessagesPaginateTypeDef

ListPluginsPaginator

Type annotations and code completion for session.client("qbusiness").get_paginator("list_plugins"). boto3 documentation

# ListPluginsPaginator usage example

from aioboto3.session import Session

from types_aiobotocore_qbusiness.paginator import ListPluginsPaginator

session = Session()

session = get_session()
async with session.client("qbusiness") as client:  # (1)
    paginator: ListPluginsPaginator = client.get_paginator("list_plugins")  # (2)
    async for item in paginator.paginate(...):
        item: ListPluginsResponseTypeDef
        print(item)  # (3)

1. client: QBusinessClient
2. paginator: ListPluginsPaginator
3. item: ListPluginsResponseTypeDef

paginate

Type annotations and code completion for ListPluginsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    applicationId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListPluginsResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListPluginsResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: ListPluginsRequestListPluginsPaginateTypeDef = {  # (1)
    "applicationId": ...,
}

parent.paginate(**kwargs)

1. See ListPluginsRequestListPluginsPaginateTypeDef

ListRetrieversPaginator

Type annotations and code completion for session.client("qbusiness").get_paginator("list_retrievers"). boto3 documentation

# ListRetrieversPaginator usage example

from aioboto3.session import Session

from types_aiobotocore_qbusiness.paginator import ListRetrieversPaginator

session = Session()

session = get_session()
async with session.client("qbusiness") as client:  # (1)
    paginator: ListRetrieversPaginator = client.get_paginator("list_retrievers")  # (2)
    async for item in paginator.paginate(...):
        item: ListRetrieversResponseTypeDef
        print(item)  # (3)

1. client: QBusinessClient
2. paginator: ListRetrieversPaginator
3. item: ListRetrieversResponseTypeDef

paginate

Type annotations and code completion for ListRetrieversPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    applicationId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListRetrieversResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListRetrieversResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: ListRetrieversRequestListRetrieversPaginateTypeDef = {  # (1)
    "applicationId": ...,
}

parent.paginate(**kwargs)

1. See ListRetrieversRequestListRetrieversPaginateTypeDef

ListWebExperiencesPaginator

Type annotations and code completion for session.client("qbusiness").get_paginator("list_web_experiences"). boto3 documentation

# ListWebExperiencesPaginator usage example

from aioboto3.session import Session

from types_aiobotocore_qbusiness.paginator import ListWebExperiencesPaginator

session = Session()

session = get_session()
async with session.client("qbusiness") as client:  # (1)
    paginator: ListWebExperiencesPaginator = client.get_paginator("list_web_experiences")  # (2)
    async for item in paginator.paginate(...):
        item: ListWebExperiencesResponseTypeDef
        print(item)  # (3)

1. client: QBusinessClient
2. paginator: ListWebExperiencesPaginator
3. item: ListWebExperiencesResponseTypeDef

paginate

Type annotations and code completion for ListWebExperiencesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    applicationId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListWebExperiencesResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListWebExperiencesResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: ListWebExperiencesRequestListWebExperiencesPaginateTypeDef = {  # (1)
    "applicationId": ...,
}

parent.paginate(**kwargs)

1. See ListWebExperiencesRequestListWebExperiencesPaginateTypeDef