Paginators#
Index > CloudWatch > Paginators
Auto-generated documentation for CloudWatch type annotations stubs module mypy-boto3-cloudwatch.
DescribeAlarmHistoryPaginator#
Type annotations and code completion for boto3.client("cloudwatch").get_paginator("describe_alarm_history")
.
boto3 documentation
# DescribeAlarmHistoryPaginator usage example
from boto3.session import Session
from mypy_boto3_cloudwatch.paginator import DescribeAlarmHistoryPaginator
def get_describe_alarm_history_paginator() -> DescribeAlarmHistoryPaginator:
return Session().client("cloudwatch").get_paginator("describe_alarm_history")
# DescribeAlarmHistoryPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_cloudwatch.paginator import DescribeAlarmHistoryPaginator
session = Session()
client = Session().client("cloudwatch") # (1)
paginator: DescribeAlarmHistoryPaginator = client.get_paginator("describe_alarm_history") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: CloudWatchClient
- paginator: DescribeAlarmHistoryPaginator
- item: DescribeAlarmHistoryOutputTypeDef
paginate#
Type annotations and code completion for DescribeAlarmHistoryPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
AlarmName: str = ...,
AlarmTypes: Sequence[AlarmTypeType] = ..., # (1)
HistoryItemType: HistoryItemTypeType = ..., # (2)
StartDate: Union[datetime, str] = ...,
EndDate: Union[datetime, str] = ...,
ScanBy: ScanByType = ..., # (3)
PaginationConfig: PaginatorConfigTypeDef = ..., # (4)
) -> _PageIterator[DescribeAlarmHistoryOutputTypeDef]: # (5)
...
- See AlarmTypeType
- See HistoryItemTypeType
- See ScanByType
- See PaginatorConfigTypeDef
- See DescribeAlarmHistoryOutputTypeDef
# paginate method usage example with argument unpacking
kwargs: DescribeAlarmHistoryInputDescribeAlarmHistoryPaginateTypeDef = { # (1)
"AlarmName": ...,
}
parent.paginate(**kwargs)
DescribeAlarmsPaginator#
Type annotations and code completion for boto3.client("cloudwatch").get_paginator("describe_alarms")
.
boto3 documentation
# DescribeAlarmsPaginator usage example
from boto3.session import Session
from mypy_boto3_cloudwatch.paginator import DescribeAlarmsPaginator
def get_describe_alarms_paginator() -> DescribeAlarmsPaginator:
return Session().client("cloudwatch").get_paginator("describe_alarms")
# DescribeAlarmsPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_cloudwatch.paginator import DescribeAlarmsPaginator
session = Session()
client = Session().client("cloudwatch") # (1)
paginator: DescribeAlarmsPaginator = client.get_paginator("describe_alarms") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: CloudWatchClient
- paginator: DescribeAlarmsPaginator
- item: DescribeAlarmsOutputTypeDef
paginate#
Type annotations and code completion for DescribeAlarmsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
AlarmNames: Sequence[str] = ...,
AlarmNamePrefix: str = ...,
AlarmTypes: Sequence[AlarmTypeType] = ..., # (1)
ChildrenOfAlarmName: str = ...,
ParentsOfAlarmName: str = ...,
StateValue: StateValueType = ..., # (2)
ActionPrefix: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (3)
) -> _PageIterator[DescribeAlarmsOutputTypeDef]: # (4)
...
- See AlarmTypeType
- See StateValueType
- See PaginatorConfigTypeDef
- See DescribeAlarmsOutputTypeDef
# paginate method usage example with argument unpacking
kwargs: DescribeAlarmsInputDescribeAlarmsPaginateTypeDef = { # (1)
"AlarmNames": ...,
}
parent.paginate(**kwargs)
DescribeAnomalyDetectorsPaginator#
Type annotations and code completion for boto3.client("cloudwatch").get_paginator("describe_anomaly_detectors")
.
boto3 documentation
# DescribeAnomalyDetectorsPaginator usage example
from boto3.session import Session
from mypy_boto3_cloudwatch.paginator import DescribeAnomalyDetectorsPaginator
def get_describe_anomaly_detectors_paginator() -> DescribeAnomalyDetectorsPaginator:
return Session().client("cloudwatch").get_paginator("describe_anomaly_detectors")
# DescribeAnomalyDetectorsPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_cloudwatch.paginator import DescribeAnomalyDetectorsPaginator
session = Session()
client = Session().client("cloudwatch") # (1)
paginator: DescribeAnomalyDetectorsPaginator = client.get_paginator("describe_anomaly_detectors") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: CloudWatchClient
- paginator: DescribeAnomalyDetectorsPaginator
- item: DescribeAnomalyDetectorsOutputTypeDef
paginate#
Type annotations and code completion for DescribeAnomalyDetectorsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
Namespace: str = ...,
MetricName: str = ...,
Dimensions: Sequence[DimensionTypeDef] = ..., # (1)
AnomalyDetectorTypes: Sequence[AnomalyDetectorTypeType] = ..., # (2)
PaginationConfig: PaginatorConfigTypeDef = ..., # (3)
) -> _PageIterator[DescribeAnomalyDetectorsOutputTypeDef]: # (4)
...
- See DimensionTypeDef
- See AnomalyDetectorTypeType
- See PaginatorConfigTypeDef
- See DescribeAnomalyDetectorsOutputTypeDef
# paginate method usage example with argument unpacking
kwargs: DescribeAnomalyDetectorsInputDescribeAnomalyDetectorsPaginateTypeDef = { # (1)
"Namespace": ...,
}
parent.paginate(**kwargs)
GetMetricDataPaginator#
Type annotations and code completion for boto3.client("cloudwatch").get_paginator("get_metric_data")
.
boto3 documentation
# GetMetricDataPaginator usage example
from boto3.session import Session
from mypy_boto3_cloudwatch.paginator import GetMetricDataPaginator
def get_get_metric_data_paginator() -> GetMetricDataPaginator:
return Session().client("cloudwatch").get_paginator("get_metric_data")
# GetMetricDataPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_cloudwatch.paginator import GetMetricDataPaginator
session = Session()
client = Session().client("cloudwatch") # (1)
paginator: GetMetricDataPaginator = client.get_paginator("get_metric_data") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: CloudWatchClient
- paginator: GetMetricDataPaginator
- item: GetMetricDataOutputTypeDef
paginate#
Type annotations and code completion for GetMetricDataPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
MetricDataQueries: Sequence[Union[MetricDataQueryTypeDef, MetricDataQueryExtraOutputTypeDef]], # (1)
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
ScanBy: ScanByType = ..., # (2)
LabelOptions: LabelOptionsTypeDef = ..., # (3)
PaginationConfig: PaginatorConfigTypeDef = ..., # (4)
) -> _PageIterator[GetMetricDataOutputTypeDef]: # (5)
...
- See MetricDataQueryTypeDef MetricDataQueryExtraOutputTypeDef
- See ScanByType
- See LabelOptionsTypeDef
- See PaginatorConfigTypeDef
- See GetMetricDataOutputTypeDef
# paginate method usage example with argument unpacking
kwargs: GetMetricDataInputGetMetricDataPaginateTypeDef = { # (1)
"MetricDataQueries": ...,
"StartTime": ...,
"EndTime": ...,
}
parent.paginate(**kwargs)
ListDashboardsPaginator#
Type annotations and code completion for boto3.client("cloudwatch").get_paginator("list_dashboards")
.
boto3 documentation
# ListDashboardsPaginator usage example
from boto3.session import Session
from mypy_boto3_cloudwatch.paginator import ListDashboardsPaginator
def get_list_dashboards_paginator() -> ListDashboardsPaginator:
return Session().client("cloudwatch").get_paginator("list_dashboards")
# ListDashboardsPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_cloudwatch.paginator import ListDashboardsPaginator
session = Session()
client = Session().client("cloudwatch") # (1)
paginator: ListDashboardsPaginator = client.get_paginator("list_dashboards") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: CloudWatchClient
- paginator: ListDashboardsPaginator
- item: ListDashboardsOutputTypeDef
paginate#
Type annotations and code completion for ListDashboardsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
DashboardNamePrefix: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> _PageIterator[ListDashboardsOutputTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: ListDashboardsInputListDashboardsPaginateTypeDef = { # (1)
"DashboardNamePrefix": ...,
}
parent.paginate(**kwargs)
ListMetricsPaginator#
Type annotations and code completion for boto3.client("cloudwatch").get_paginator("list_metrics")
.
boto3 documentation
# ListMetricsPaginator usage example
from boto3.session import Session
from mypy_boto3_cloudwatch.paginator import ListMetricsPaginator
def get_list_metrics_paginator() -> ListMetricsPaginator:
return Session().client("cloudwatch").get_paginator("list_metrics")
# ListMetricsPaginator usage example with type annotations
from boto3.session import Session
from mypy_boto3_cloudwatch.paginator import ListMetricsPaginator
session = Session()
client = Session().client("cloudwatch") # (1)
paginator: ListMetricsPaginator = client.get_paginator("list_metrics") # (2)
for item in paginator.paginate(...):
print(item) # (3)
- client: CloudWatchClient
- paginator: ListMetricsPaginator
- item: ListMetricsOutputTypeDef
paginate#
Type annotations and code completion for ListMetricsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
Namespace: str = ...,
MetricName: str = ...,
Dimensions: Sequence[DimensionFilterTypeDef] = ..., # (1)
RecentlyActive: RecentlyActiveType = ..., # (2)
IncludeLinkedAccounts: bool = ...,
OwningAccount: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (3)
) -> _PageIterator[ListMetricsOutputTypeDef]: # (4)
...
- See DimensionFilterTypeDef
- See RecentlyActiveType
- See