Paginators#
Index > CloudWatchLogs > Paginators
Auto-generated documentation for CloudWatchLogs type annotations stubs module mypy-boto3-logs.
DescribeConfigurationTemplatesPaginator#
Type annotations and code completion for boto3.client("logs").get_paginator("describe_configuration_templates")
.
boto3 documentation
# DescribeConfigurationTemplatesPaginator usage example
from boto3.session import Session
from mypy_boto3_logs.paginator import DescribeConfigurationTemplatesPaginator
def get_describe_configuration_templates_paginator() -> DescribeConfigurationTemplatesPaginator:
return Session().client("logs").get_paginator("describe_configuration_templates")
# DescribeConfigurationTemplatesPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_logs.paginator import DescribeConfigurationTemplatesPaginator
session = Session()
client = Session().client("logs") # (1)
paginator: DescribeConfigurationTemplatesPaginator = client.get_paginator("describe_configuration_templates") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: CloudWatchLogsClient
- paginator: DescribeConfigurationTemplatesPaginator
- item: DescribeConfigurationTemplatesResponseTypeDef
paginate#
Type annotations and code completion for DescribeConfigurationTemplatesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
service: str = ...,
logTypes: Sequence[str] = ...,
resourceTypes: Sequence[str] = ...,
deliveryDestinationTypes: Sequence[DeliveryDestinationTypeType] = ..., # (1)
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[DescribeConfigurationTemplatesResponseTypeDef]: # (3)
...
- See DeliveryDestinationTypeType
- See PaginatorConfigTypeDef
- See DescribeConfigurationTemplatesResponseTypeDef
# paginate method usage example with argument unpacking
kwargs: DescribeConfigurationTemplatesRequestDescribeConfigurationTemplatesPaginateTypeDef = { # (1)
"service": ...,
}
parent.paginate(**kwargs)
DescribeDeliveriesPaginator#
Type annotations and code completion for boto3.client("logs").get_paginator("describe_deliveries")
.
boto3 documentation
# DescribeDeliveriesPaginator usage example
from boto3.session import Session
from mypy_boto3_logs.paginator import DescribeDeliveriesPaginator
def get_describe_deliveries_paginator() -> DescribeDeliveriesPaginator:
return Session().client("logs").get_paginator("describe_deliveries")
# DescribeDeliveriesPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_logs.paginator import DescribeDeliveriesPaginator
session = Session()
client = Session().client("logs") # (1)
paginator: DescribeDeliveriesPaginator = client.get_paginator("describe_deliveries") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: CloudWatchLogsClient
- paginator: DescribeDeliveriesPaginator
- item: DescribeDeliveriesResponseTypeDef
paginate#
Type annotations and code completion for DescribeDeliveriesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> _PageIterator[DescribeDeliveriesResponseTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeDeliveriesRequestDescribeDeliveriesPaginateTypeDef = { # (1)
"PaginationConfig": ...,
}
parent.paginate(**kwargs)
DescribeDeliveryDestinationsPaginator#
Type annotations and code completion for boto3.client("logs").get_paginator("describe_delivery_destinations")
.
boto3 documentation
# DescribeDeliveryDestinationsPaginator usage example
from boto3.session import Session
from mypy_boto3_logs.paginator import DescribeDeliveryDestinationsPaginator
def get_describe_delivery_destinations_paginator() -> DescribeDeliveryDestinationsPaginator:
return Session().client("logs").get_paginator("describe_delivery_destinations")
# DescribeDeliveryDestinationsPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_logs.paginator import DescribeDeliveryDestinationsPaginator
session = Session()
client = Session().client("logs") # (1)
paginator: DescribeDeliveryDestinationsPaginator = client.get_paginator("describe_delivery_destinations") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: CloudWatchLogsClient
- paginator: DescribeDeliveryDestinationsPaginator
- item: DescribeDeliveryDestinationsResponseTypeDef
paginate#
Type annotations and code completion for DescribeDeliveryDestinationsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> _PageIterator[DescribeDeliveryDestinationsResponseTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeDeliveryDestinationsRequestDescribeDeliveryDestinationsPaginateTypeDef = { # (1)
"PaginationConfig": ...,
}
parent.paginate(**kwargs)
DescribeDeliverySourcesPaginator#
Type annotations and code completion for boto3.client("logs").get_paginator("describe_delivery_sources")
.
boto3 documentation
# DescribeDeliverySourcesPaginator usage example
from boto3.session import Session
from mypy_boto3_logs.paginator import DescribeDeliverySourcesPaginator
def get_describe_delivery_sources_paginator() -> DescribeDeliverySourcesPaginator:
return Session().client("logs").get_paginator("describe_delivery_sources")
# DescribeDeliverySourcesPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_logs.paginator import DescribeDeliverySourcesPaginator
session = Session()
client = Session().client("logs") # (1)
paginator: DescribeDeliverySourcesPaginator = client.get_paginator("describe_delivery_sources") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: CloudWatchLogsClient
- paginator: DescribeDeliverySourcesPaginator
- item: DescribeDeliverySourcesResponseTypeDef
paginate#
Type annotations and code completion for DescribeDeliverySourcesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> _PageIterator[DescribeDeliverySourcesResponseTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeDeliverySourcesRequestDescribeDeliverySourcesPaginateTypeDef = { # (1)
"PaginationConfig": ...,
}
parent.paginate(**kwargs)
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)
- client: CloudWatchLogsClient
- paginator: DescribeDestinationsPaginator
- 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)
...
# paginate method usage example with argument unpacking
kwargs: DescribeDestinationsRequestDescribeDestinationsPaginateTypeDef = { # (1)
"DestinationNamePrefix": ...,
}
parent.paginate(**kwargs)
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)
- client: CloudWatchLogsClient
- paginator: DescribeExportTasksPaginator
- 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)
...
# paginate method usage example with argument unpacking
kwargs: DescribeExportTasksRequestDescribeExportTasksPaginateTypeDef = { # (1)
"taskId": ...,
}
parent.paginate(**kwargs)
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)
- client: CloudWatchLogsClient
- paginator: DescribeLogGroupsPaginator
- 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 = ...,
logGroupClass: LogGroupClassType = ..., # (1)
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[DescribeLogGroupsResponseTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: DescribeLogGroupsRequestDescribeLogGroupsPaginateTypeDef = { # (1)
"accountIdentifiers": ...,
}
parent.paginate(**kwargs)
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)
- client: CloudWatchLogsClient
- paginator: DescribeLogStreamsPaginator
- 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)
...
# paginate method usage example with argument unpacking
kwargs: DescribeLogStreamsRequestDescribeLogStreamsPaginateTypeDef = { # (1)
"logGroupName": ...,
}
parent.paginate(**kwargs)
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)
- client: CloudWatchLogsClient
- paginator: DescribeMetricFiltersPaginator
- 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)
...
# paginate method usage example with argument unpacking
kwargs: DescribeMetricFiltersRequestDescribeMetricFiltersPaginateTypeDef = { # (1)
"logGroupName": ...,
}
parent.paginate(**kwargs)
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)
- client: CloudWatchLogsClient
- paginator: DescribeQueriesPaginator
- 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)
...
# paginate method usage example with argument unpacking
kwargs: DescribeQueriesRequestDescribeQueriesPaginateTypeDef = { # (1)
"logGroupName": ...,
}
parent.paginate(**kwargs)
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)
- client: CloudWatchLogsClient
- paginator: DescribeResourcePoliciesPaginator
- item: DescribeResourcePoliciesResponseTypeDef
paginate#
Type annotations and code completion for DescribeResourcePoliciesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> _PageIterator[DescribeResourcePoliciesResponseTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeResourcePoliciesRequestDescribeResourcePoliciesPaginateTypeDef = { # (1)
"PaginationConfig": ...,
}
parent.paginate(**kwargs)
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)
- client: CloudWatchLogsClient
- paginator: DescribeSubscriptionFiltersPaginator
- 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)
...
# paginate method usage example with argument unpacking
kwargs: DescribeSubscriptionFiltersRequestDescribeSubscriptionFiltersPaginateTypeDef = { # (1)
"logGroupName": ...,
}
parent.paginate(**kwargs)
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)
- client: CloudWatchLogsClient
- paginator: FilterLogEventsPaginator
- 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)
...
# paginate method usage example with argument unpacking
kwargs: FilterLogEventsRequestFilterLogEventsPaginateTypeDef = { # (1)
"logGroupName": ...,
}
parent.paginate(**kwargs)
ListAnomaliesPaginator#
Type annotations and code completion for boto3.client("logs").get_paginator("list_anomalies")
.
boto3 documentation
# ListAnomaliesPaginator usage example
from boto3.session import Session
from mypy_boto3_logs.paginator import ListAnomaliesPaginator
def get_list_anomalies_paginator() -> ListAnomaliesPaginator:
return Session().client("logs").get_paginator("list_anomalies")
# ListAnomaliesPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_logs.paginator import ListAnomaliesPaginator
session = Session()
client = Session().client("logs") # (1)
paginator: ListAnomaliesPaginator = client.get_paginator("list_anomalies") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: CloudWatchLogsClient
- paginator: ListAnomaliesPaginator
- item: ListAnomaliesResponseTypeDef
paginate#
Type annotations and code completion for ListAnomaliesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
anomalyDetectorArn: str = ...,
suppressionState: SuppressionStateType = ..., # (1)
PaginationConfig: PaginatorConfigTypeDef = ..., # (2)
) -> _PageIterator[ListAnomaliesResponseTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: ListAnomaliesRequestListAnomaliesPaginateTypeDef = { # (1)
"anomalyDetectorArn": ...,
}
parent.paginate(**kwargs)
ListLogAnomalyDetectorsPaginator#
Type annotations and code completion for boto3.client("logs").get_paginator("list_log_anomaly_detectors")
.
boto3 documentation
# ListLogAnomalyDetectorsPaginator usage example
from boto3.session import Session
from mypy_boto3_logs.paginator import ListLogAnomalyDetectorsPaginator
def get_list_log_anomaly_detectors_paginator() -> ListLogAnomalyDetectorsPaginator:
return Session().client("logs").get_paginator("list_log_anomaly_detectors")
# ListLogAnomalyDetectorsPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_logs.paginator import ListLogAnomalyDetectorsPaginator
session = Session()
client = Session().client("logs") # (1)
paginator: ListLogAnomalyDetectorsPaginator = client.get_paginator("list_log_anomaly_detectors") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: CloudWatchLogsClient
- paginator: ListLogAnomalyDetectorsPaginator
- item: ListLogAnomalyDetectorsResponseTypeDef
paginate#
Type annotations and code completion for ListLogAnomalyDetectorsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
filterLogGroupArn: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> _PageIterator[ListLogAnomalyDetectorsResponseTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: ListLogAnomalyDetectorsRequestListLogAnomalyDetectorsPaginateTypeDef = { # (1)
"filterLogGroupArn": ...,
}
parent.paginate(**kwargs)