Skip to content

Paginators#

Index > CloudWatchLogs > Paginators

Auto-generated documentation for CloudWatchLogs type annotations stubs module mypy-boto3-logs.

DescribeDestinationsPaginator#

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

# DescribeDestinationsPaginator usage example

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeDestinationsPaginator

def get_describe_destinations_paginator() -> DescribeDestinationsPaginator:
    return Session().client("logs").get_paginator("describe_destinations")
# DescribeDestinationsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeDestinationsPaginator

session = Session()

client = Session().client("logs")  # (1)
paginator: DescribeDestinationsPaginator = client.get_paginator("describe_destinations")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("logs").get_paginator("describe_export_tasks"). boto3 documentation

# DescribeExportTasksPaginator usage example

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeExportTasksPaginator

def get_describe_export_tasks_paginator() -> DescribeExportTasksPaginator:
    return Session().client("logs").get_paginator("describe_export_tasks")
# DescribeExportTasksPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeExportTasksPaginator

session = Session()

client = Session().client("logs")  # (1)
paginator: DescribeExportTasksPaginator = client.get_paginator("describe_export_tasks")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("logs").get_paginator("describe_log_groups"). boto3 documentation

# DescribeLogGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeLogGroupsPaginator

def get_describe_log_groups_paginator() -> DescribeLogGroupsPaginator:
    return Session().client("logs").get_paginator("describe_log_groups")
# DescribeLogGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeLogGroupsPaginator

session = Session()

client = Session().client("logs")  # (1)
paginator: DescribeLogGroupsPaginator = client.get_paginator("describe_log_groups")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("logs").get_paginator("describe_log_streams"). boto3 documentation

# DescribeLogStreamsPaginator usage example

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeLogStreamsPaginator

def get_describe_log_streams_paginator() -> DescribeLogStreamsPaginator:
    return Session().client("logs").get_paginator("describe_log_streams")
# DescribeLogStreamsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeLogStreamsPaginator

session = Session()

client = Session().client("logs")  # (1)
paginator: DescribeLogStreamsPaginator = client.get_paginator("describe_log_streams")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("logs").get_paginator("describe_metric_filters"). boto3 documentation

# DescribeMetricFiltersPaginator usage example

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeMetricFiltersPaginator

def get_describe_metric_filters_paginator() -> DescribeMetricFiltersPaginator:
    return Session().client("logs").get_paginator("describe_metric_filters")
# DescribeMetricFiltersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeMetricFiltersPaginator

session = Session()

client = Session().client("logs")  # (1)
paginator: DescribeMetricFiltersPaginator = client.get_paginator("describe_metric_filters")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("logs").get_paginator("describe_queries"). boto3 documentation

# DescribeQueriesPaginator usage example

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeQueriesPaginator

def get_describe_queries_paginator() -> DescribeQueriesPaginator:
    return Session().client("logs").get_paginator("describe_queries")
# DescribeQueriesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeQueriesPaginator

session = Session()

client = Session().client("logs")  # (1)
paginator: DescribeQueriesPaginator = client.get_paginator("describe_queries")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("logs").get_paginator("describe_resource_policies"). boto3 documentation

# DescribeResourcePoliciesPaginator usage example

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeResourcePoliciesPaginator

def get_describe_resource_policies_paginator() -> DescribeResourcePoliciesPaginator:
    return Session().client("logs").get_paginator("describe_resource_policies")
# DescribeResourcePoliciesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeResourcePoliciesPaginator

session = Session()

client = Session().client("logs")  # (1)
paginator: DescribeResourcePoliciesPaginator = client.get_paginator("describe_resource_policies")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("logs").get_paginator("describe_subscription_filters"). boto3 documentation

# DescribeSubscriptionFiltersPaginator usage example

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeSubscriptionFiltersPaginator

def get_describe_subscription_filters_paginator() -> DescribeSubscriptionFiltersPaginator:
    return Session().client("logs").get_paginator("describe_subscription_filters")
# DescribeSubscriptionFiltersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeSubscriptionFiltersPaginator

session = Session()

client = Session().client("logs")  # (1)
paginator: DescribeSubscriptionFiltersPaginator = client.get_paginator("describe_subscription_filters")  # (2)
for item in paginator.paginate(...):
    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)
) -> _PageIterator[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 boto3.client("logs").get_paginator("filter_log_events"). boto3 documentation

# FilterLogEventsPaginator usage example

from boto3.session import Session

from mypy_boto3_logs.paginator import FilterLogEventsPaginator

def get_filter_log_events_paginator() -> FilterLogEventsPaginator:
    return Session().client("logs").get_paginator("filter_log_events")
# FilterLogEventsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_logs.paginator import FilterLogEventsPaginator

session = Session()

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