Skip to content

Paginators#

Index > CloudWatchLogs > Paginators

Auto-generated documentation for CloudWatchLogs type annotations stubs module types-aiobotocore-logs.

DescribeDestinationsPaginator#

Type annotations and code completion for session.create_client("logs").get_paginator("describe_destinations"). boto3 documentation

# DescribeDestinationsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_logs.paginator import DescribeDestinationsPaginator

session = get_session()
async with session.create_client("logs") as client:  # (1)
    paginator: DescribeDestinationsPaginator = client.get_paginator("describe_destinations")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeDestinationsResponseTypeDef
        print(item)  # (3)
  1. client: CloudWatchLogsClient
  2. paginator: DescribeDestinationsPaginator
  3. item: DescribeDestinationsResponseTypeDef

paginate#

Type annotations and code completion for DescribeDestinationsPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeDestinationsRequestDescribeDestinationsPaginateTypeDef = {  # (1)
    "DestinationNamePrefix": ...,
}

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

DescribeExportTasksPaginator#

Type annotations and code completion for session.create_client("logs").get_paginator("describe_export_tasks"). boto3 documentation

# DescribeExportTasksPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_logs.paginator import DescribeExportTasksPaginator

session = get_session()
async with session.create_client("logs") as client:  # (1)
    paginator: DescribeExportTasksPaginator = client.get_paginator("describe_export_tasks")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeExportTasksResponseTypeDef
        print(item)  # (3)
  1. client: CloudWatchLogsClient
  2. paginator: DescribeExportTasksPaginator
  3. item: DescribeExportTasksResponseTypeDef

paginate#

Type annotations and code completion for DescribeExportTasksPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    taskId: str = ...,
    statusCode: ExportTaskStatusCodeType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> AsyncIterator[DescribeExportTasksResponseTypeDef]:  # (3)
    ...
  1. See ExportTaskStatusCodeType
  2. See PaginatorConfigTypeDef
  3. See DescribeExportTasksResponseTypeDef
# paginate method usage example with argument unpacking

kwargs: DescribeExportTasksRequestDescribeExportTasksPaginateTypeDef = {  # (1)
    "taskId": ...,
}

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

DescribeLogGroupsPaginator#

Type annotations and code completion for session.create_client("logs").get_paginator("describe_log_groups"). boto3 documentation

# DescribeLogGroupsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_logs.paginator import DescribeLogGroupsPaginator

session = get_session()
async with session.create_client("logs") as client:  # (1)
    paginator: DescribeLogGroupsPaginator = client.get_paginator("describe_log_groups")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeLogGroupsResponseTypeDef
        print(item)  # (3)
  1. client: CloudWatchLogsClient
  2. paginator: DescribeLogGroupsPaginator
  3. item: DescribeLogGroupsResponseTypeDef

paginate#

Type annotations and code completion for DescribeLogGroupsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    accountIdentifiers: Sequence[str] = ...,
    logGroupNamePrefix: str = ...,
    logGroupNamePattern: str = ...,
    includeLinkedAccounts: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[DescribeLogGroupsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeLogGroupsResponseTypeDef
# paginate method usage example with argument unpacking

kwargs: DescribeLogGroupsRequestDescribeLogGroupsPaginateTypeDef = {  # (1)
    "accountIdentifiers": ...,
}

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

DescribeLogStreamsPaginator#

Type annotations and code completion for session.create_client("logs").get_paginator("describe_log_streams"). boto3 documentation

# DescribeLogStreamsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_logs.paginator import DescribeLogStreamsPaginator

session = get_session()
async with session.create_client("logs") as client:  # (1)
    paginator: DescribeLogStreamsPaginator = client.get_paginator("describe_log_streams")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeLogStreamsResponseTypeDef
        print(item)  # (3)
  1. client: CloudWatchLogsClient
  2. paginator: DescribeLogStreamsPaginator
  3. item: DescribeLogStreamsResponseTypeDef

paginate#

Type annotations and code completion for DescribeLogStreamsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    logGroupName: str = ...,
    logGroupIdentifier: str = ...,
    logStreamNamePrefix: str = ...,
    orderBy: OrderByType = ...,  # (1)
    descending: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> AsyncIterator[DescribeLogStreamsResponseTypeDef]:  # (3)
    ...
  1. See OrderByType
  2. See PaginatorConfigTypeDef
  3. See DescribeLogStreamsResponseTypeDef
# paginate method usage example with argument unpacking

kwargs: DescribeLogStreamsRequestDescribeLogStreamsPaginateTypeDef = {  # (1)
    "logGroupName": ...,
}

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

DescribeMetricFiltersPaginator#

Type annotations and code completion for session.create_client("logs").get_paginator("describe_metric_filters"). boto3 documentation

# DescribeMetricFiltersPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_logs.paginator import DescribeMetricFiltersPaginator

session = get_session()
async with session.create_client("logs") as client:  # (1)
    paginator: DescribeMetricFiltersPaginator = client.get_paginator("describe_metric_filters")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeMetricFiltersResponseTypeDef
        print(item)  # (3)
  1. client: CloudWatchLogsClient
  2. paginator: DescribeMetricFiltersPaginator
  3. item: DescribeMetricFiltersResponseTypeDef

paginate#

Type annotations and code completion for DescribeMetricFiltersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    logGroupName: str = ...,
    filterNamePrefix: str = ...,
    metricName: str = ...,
    metricNamespace: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[DescribeMetricFiltersResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeMetricFiltersResponseTypeDef
# paginate method usage example with argument unpacking

kwargs: DescribeMetricFiltersRequestDescribeMetricFiltersPaginateTypeDef = {  # (1)
    "logGroupName": ...,
}

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

DescribeQueriesPaginator#

Type annotations and code completion for session.create_client("logs").get_paginator("describe_queries"). boto3 documentation

# DescribeQueriesPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_logs.paginator import DescribeQueriesPaginator

session = get_session()
async with session.create_client("logs") as client:  # (1)
    paginator: DescribeQueriesPaginator = client.get_paginator("describe_queries")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeQueriesResponseTypeDef
        print(item)  # (3)
  1. client: CloudWatchLogsClient
  2. paginator: DescribeQueriesPaginator
  3. item: DescribeQueriesResponseTypeDef

paginate#

Type annotations and code completion for DescribeQueriesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    logGroupName: str = ...,
    status: QueryStatusType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> AsyncIterator[DescribeQueriesResponseTypeDef]:  # (3)
    ...
  1. See QueryStatusType
  2. See PaginatorConfigTypeDef
  3. See DescribeQueriesResponseTypeDef
# paginate method usage example with argument unpacking

kwargs: DescribeQueriesRequestDescribeQueriesPaginateTypeDef = {  # (1)
    "logGroupName": ...,
}

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

DescribeResourcePoliciesPaginator#

Type annotations and code completion for session.create_client("logs").get_paginator("describe_resource_policies"). boto3 documentation

# DescribeResourcePoliciesPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_logs.paginator import DescribeResourcePoliciesPaginator

session = get_session()
async with session.create_client("logs") as client:  # (1)
    paginator: DescribeResourcePoliciesPaginator = client.get_paginator("describe_resource_policies")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeResourcePoliciesResponseTypeDef
        print(item)  # (3)
  1. client: CloudWatchLogsClient
  2. paginator: DescribeResourcePoliciesPaginator
  3. item: DescribeResourcePoliciesResponseTypeDef

paginate#

Type annotations and code completion for DescribeResourcePoliciesPaginator.paginate method.

# paginate method definition

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

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

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

DescribeSubscriptionFiltersPaginator#

Type annotations and code completion for session.create_client("logs").get_paginator("describe_subscription_filters"). boto3 documentation

# DescribeSubscriptionFiltersPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_logs.paginator import DescribeSubscriptionFiltersPaginator

session = get_session()
async with session.create_client("logs") as client:  # (1)
    paginator: DescribeSubscriptionFiltersPaginator = client.get_paginator("describe_subscription_filters")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeSubscriptionFiltersResponseTypeDef
        print(item)  # (3)
  1. client: CloudWatchLogsClient
  2. paginator: DescribeSubscriptionFiltersPaginator
  3. item: DescribeSubscriptionFiltersResponseTypeDef

paginate#

Type annotations and code completion for DescribeSubscriptionFiltersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    logGroupName: str,
    filterNamePrefix: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[DescribeSubscriptionFiltersResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeSubscriptionFiltersResponseTypeDef
# paginate method usage example with argument unpacking

kwargs: DescribeSubscriptionFiltersRequestDescribeSubscriptionFiltersPaginateTypeDef = {  # (1)
    "logGroupName": ...,
}

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

FilterLogEventsPaginator#

Type annotations and code completion for session.create_client("logs").get_paginator("filter_log_events"). boto3 documentation

# FilterLogEventsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_logs.paginator import FilterLogEventsPaginator

session = get_session()
async with session.create_client("logs") as client:  # (1)
    paginator: FilterLogEventsPaginator = client.get_paginator("filter_log_events")  # (2)
    async for item in paginator.paginate(...):
        item: FilterLogEventsResponseTypeDef
        print(item)  # (3)
  1. client: CloudWatchLogsClient
  2. paginator: FilterLogEventsPaginator
  3. item: FilterLogEventsResponseTypeDef

paginate#

Type annotations and code completion for FilterLogEventsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    logGroupName: str = ...,
    logGroupIdentifier: str = ...,
    logStreamNames: Sequence[str] = ...,
    logStreamNamePrefix: str = ...,
    startTime: int = ...,
    endTime: int = ...,
    filterPattern: str = ...,
    interleaved: bool = ...,
    unmask: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[FilterLogEventsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See FilterLogEventsResponseTypeDef
# paginate method usage example with argument unpacking

kwargs: FilterLogEventsRequestFilterLogEventsPaginateTypeDef = {  # (1)
    "logGroupName": ...,
}

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