Skip to content

Paginators#

Index > Connect > Paginators

Auto-generated documentation for Connect type annotations stubs module mypy-boto3-connect.

GetMetricDataPaginator#

Type annotations and code completion for boto3.client("connect").get_paginator("get_metric_data"). boto3 documentation

# GetMetricDataPaginator usage example

from boto3.session import Session

from mypy_boto3_connect.paginator import GetMetricDataPaginator

def get_get_metric_data_paginator() -> GetMetricDataPaginator:
    return Session().client("connect").get_paginator("get_metric_data")
# GetMetricDataPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_connect.paginator import GetMetricDataPaginator

session = Session()

client = Session().client("connect")  # (1)
paginator: GetMetricDataPaginator = client.get_paginator("get_metric_data")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ConnectClient
  2. paginator: GetMetricDataPaginator
  3. item: GetMetricDataResponseTypeDef

paginate#

Type annotations and code completion for GetMetricDataPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    InstanceId: str,
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    Filters: FiltersTypeDef,  # (1)
    HistoricalMetrics: Sequence[HistoricalMetricTypeDef],  # (2)
    Groupings: Sequence[GroupingType] = ...,  # (3)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> _PageIterator[GetMetricDataResponseTypeDef]:  # (5)
    ...
  1. See FiltersTypeDef
  2. See HistoricalMetricTypeDef
  3. See GroupingType
  4. See PaginatorConfigTypeDef
  5. See GetMetricDataResponseTypeDef
# paginate method usage example with argument unpacking

kwargs: GetMetricDataRequestGetMetricDataPaginateTypeDef = {  # (1)
    "InstanceId": ...,
    "StartTime": ...,
    "EndTime": ...,
    "Filters": ...,
    "HistoricalMetrics": ...,
}

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

ListAgentStatusesPaginator#

Type annotations and code completion for boto3.client("connect").get_paginator("list_agent_statuses"). boto3 documentation

# ListAgentStatusesPaginator usage example

from boto3.session import Session

from mypy_boto3_connect.paginator import ListAgentStatusesPaginator

def get_list_agent_statuses_paginator() -> ListAgentStatusesPaginator:
    return Session().client("connect").get_paginator("list_agent_statuses")
# ListAgentStatusesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_connect.paginator import ListAgentStatusesPaginator

session = Session()

client = Session().client("connect")  # (1)
paginator: ListAgentStatusesPaginator = client.get_paginator("list_agent_statuses")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ConnectClient
  2. paginator: ListAgentStatusesPaginator
  3. item: ListAgentStatusResponseTypeDef

paginate#

Type annotations and code completion for ListAgentStatusesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    InstanceId: str,
    AgentStatusTypes: Sequence[AgentStatusTypeType] = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[ListAgentStatusResponseTypeDef]:  # (3)
    ...
  1. See AgentStatusTypeType
  2. See PaginatorConfigTypeDef
  3. See ListAgentStatusResponseTypeDef
# paginate method usage example with argument unpacking

kwargs: ListAgentStatusRequestListAgentStatusesPaginateTypeDef = {  # (1)
    "InstanceId": ...,
}

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

ListApprovedOriginsPaginator#

Type annotations and code completion for boto3.client("connect").get_paginator("list_approved_origins"). boto3 documentation

# ListApprovedOriginsPaginator usage example

from boto3.session import Session

from mypy_boto3_connect.paginator import ListApprovedOriginsPaginator

def get_list_approved_origins_paginator() -> ListApprovedOriginsPaginator:
    return Session().client("connect").get_paginator("list_approved_origins")
# ListApprovedOriginsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_connect.paginator import ListApprovedOriginsPaginator

session = Session()

client = Session().client("connect")  # (1)
paginator: ListApprovedOriginsPaginator = client.get_paginator("list_approved_origins")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ConnectClient
  2. paginator: ListApprovedOriginsPaginator
  3. item: