Skip to content

Paginators#

Index > QBusiness > Paginators

Auto-generated documentation for QBusiness type annotations stubs module mypy-boto3-qbusiness.

GetChatControlsConfigurationPaginator#

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

# GetChatControlsConfigurationPaginator usage example

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import GetChatControlsConfigurationPaginator

def get_get_chat_controls_configuration_paginator() -> GetChatControlsConfigurationPaginator:
    return Session().client("qbusiness").get_paginator("get_chat_controls_configuration")
# GetChatControlsConfigurationPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import GetChatControlsConfigurationPaginator

session = Session()

client = Session().client("qbusiness")  # (1)
paginator: GetChatControlsConfigurationPaginator = client.get_paginator("get_chat_controls_configuration")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("qbusiness").get_paginator("list_applications"). boto3 documentation

# ListApplicationsPaginator usage example

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListApplicationsPaginator

def get_list_applications_paginator() -> ListApplicationsPaginator:
    return Session().client("qbusiness").get_paginator("list_applications")
# ListApplicationsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListApplicationsPaginator

session = Session()

client = Session().client("qbusiness")  # (1)
paginator: ListApplicationsPaginator = client.get_paginator("list_applications")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("qbusiness").get_paginator("list_conversations"). boto3 documentation

# ListConversationsPaginator usage example

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListConversationsPaginator

def get_list_conversations_paginator() -> ListConversationsPaginator:
    return Session().client("qbusiness").get_paginator("list_conversations")
# ListConversationsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListConversationsPaginator

session = Session()

client = Session().client("qbusiness")  # (1)
paginator: ListConversationsPaginator = client.get_paginator("list_conversations")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[ListConversationsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListConversationsResponseTypeDef 
# paginate method usage example with argument unpacking

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

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

ListDataSourceSyncJobsPaginator#

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

# ListDataSourceSyncJobsPaginator usage example

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListDataSourceSyncJobsPaginator

def get_list_data_source_sync_jobs_paginator() -> ListDataSourceSyncJobsPaginator:
    return Session().client("qbusiness").get_paginator("list_data_source_sync_jobs")
# ListDataSourceSyncJobsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListDataSourceSyncJobsPaginator

session = Session()

client = Session().client("qbusiness")  # (1)
paginator: ListDataSourceSyncJobsPaginator = client.get_paginator("list_data_source_sync_jobs")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("qbusiness").get_paginator("list_data_sources"). boto3 documentation

# ListDataSourcesPaginator usage example

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListDataSourcesPaginator

def get_list_data_sources_paginator() -> ListDataSourcesPaginator:
    return Session().client("qbusiness").get_paginator("list_data_sources")
# ListDataSourcesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListDataSourcesPaginator

session = Session()

client = Session().client("qbusiness")  # (1)
paginator: ListDataSourcesPaginator = client.get_paginator("list_data_sources")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("qbusiness").get_paginator("list_documents"). boto3 documentation

# ListDocumentsPaginator usage example

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListDocumentsPaginator

def get_list_documents_paginator() -> ListDocumentsPaginator:
    return Session().client("qbusiness").get_paginator("list_documents")
# ListDocumentsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListDocumentsPaginator

session = Session()

client = Session().client("qbusiness")  # (1)
paginator: ListDocumentsPaginator = client.get_paginator("list_documents")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("qbusiness").get_paginator("list_groups"). boto3 documentation

# ListGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListGroupsPaginator

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

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListGroupsPaginator

session = Session()

client = Session().client("qbusiness")  # (1)
paginator: ListGroupsPaginator = client.get_paginator("list_groups")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("qbusiness").get_paginator("list_indices"). boto3 documentation

# ListIndicesPaginator usage example

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListIndicesPaginator

def get_list_indices_paginator() -> ListIndicesPaginator:
    return Session().client("qbusiness").get_paginator("list_indices")
# ListIndicesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListIndicesPaginator

session = Session()

client = Session().client("qbusiness")  # (1)
paginator: ListIndicesPaginator = client.get_paginator("list_indices")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("qbusiness").get_paginator("list_messages"). boto3 documentation

# ListMessagesPaginator usage example

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListMessagesPaginator

def get_list_messages_paginator() -> ListMessagesPaginator:
    return Session().client("qbusiness").get_paginator("list_messages")
# ListMessagesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListMessagesPaginator

session = Session()

client = Session().client("qbusiness")  # (1)
paginator: ListMessagesPaginator = client.get_paginator("list_messages")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: QBusinessClient
  2. paginator: ListMessagesPaginator
  3. item: ListMessagesResponseTypeDef

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)
) -> _PageIterator[ListMessagesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListMessagesResponseTypeDef 
# paginate method usage example with argument unpacking

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

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

ListPluginsPaginator#

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

# ListPluginsPaginator usage example

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListPluginsPaginator

def get_list_plugins_paginator() -> ListPluginsPaginator:
    return Session().client("qbusiness").get_paginator("list_plugins")
# ListPluginsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListPluginsPaginator

session = Session()

client = Session().client("qbusiness")  # (1)
paginator: ListPluginsPaginator = client.get_paginator("list_plugins")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("qbusiness").get_paginator("list_retrievers"). boto3 documentation

# ListRetrieversPaginator usage example

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListRetrieversPaginator

def get_list_retrievers_paginator() -> ListRetrieversPaginator:
    return Session().client("qbusiness").get_paginator("list_retrievers")
# ListRetrieversPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListRetrieversPaginator

session = Session()

client = Session().client("qbusiness")  # (1)
paginator: ListRetrieversPaginator = client.get_paginator("list_retrievers")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("qbusiness").get_paginator("list_web_experiences"). boto3 documentation

# ListWebExperiencesPaginator usage example

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListWebExperiencesPaginator

def get_list_web_experiences_paginator() -> ListWebExperiencesPaginator:
    return Session().client("qbusiness").get_paginator("list_web_experiences")
# ListWebExperiencesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_qbusiness.paginator import ListWebExperiencesPaginator

session = Session()

client = Session().client("qbusiness")  # (1)
paginator: ListWebExperiencesPaginator = client.get_paginator("list_web_experiences")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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