Skip to content

Paginators#

Index > CloudWatch > Paginators

Auto-generated documentation for CloudWatch type annotations stubs module types-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 types_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 types_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)
  1. client: CloudWatchClient
  2. paginator: DescribeAlarmHistoryPaginator
  3. item: PageIterator[DescribeAlarmHistoryOutputTypeDef]

paginate#

Type annotations and code completion for DescribeAlarmHistoryPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    AlarmName: str = ...,
    AlarmContributorId: str = ...,
    AlarmTypes: Sequence[AlarmTypeType] = ...,  # (1)
    HistoryItemType: HistoryItemTypeType = ...,  # (2)
    StartDate: TimestampTypeDef = ...,
    EndDate: TimestampTypeDef = ...,
    ScanBy: ScanByType = ...,  # (3)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> botocore.paginate.PageIterator[DescribeAlarmHistoryOutputTypeDef]:  # (5)
    ...
  1. See Sequence[AlarmTypeType]
  2. See HistoryItemTypeType
  3. See ScanByType
  4. See PaginatorConfigTypeDef
  5. See PageIterator[DescribeAlarmHistoryOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: DescribeAlarmHistoryInputPaginateTypeDef = {  # (1)
    "AlarmName": ...,
}

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

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 types_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 types_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)
  1. client: CloudWatchClient
  2. paginator: DescribeAlarmsPaginator
  3. item: PageIterator[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)
) -> botocore.paginate.PageIterator[DescribeAlarmsOutputTypeDef]:  # (4)
    ...
  1. See Sequence[AlarmTypeType]
  2. See StateValueType
  3. See PaginatorConfigTypeDef
  4. See PageIterator[DescribeAlarmsOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: DescribeAlarmsInputPaginateTypeDef = {  # (1)
    "AlarmNames": ...,
}

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

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 types_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 types_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)
  1. client: CloudWatchClient
  2. paginator: DescribeAnomalyDetectorsPaginator
  3. item: PageIterator[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)
) -> botocore.paginate.PageIterator[DescribeAnomalyDetectorsOutputTypeDef]:  # (4)
    ...
  1. See Sequence[DimensionTypeDef]
  2. See Sequence[AnomalyDetectorTypeType]
  3. See PaginatorConfigTypeDef
  4. See PageIterator[DescribeAnomalyDetectorsOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: DescribeAnomalyDetectorsInputPaginateTypeDef = {  # (1)
    "Namespace": ...,
}

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

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 types_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 types_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)
  1. client: CloudWatchClient
  2. paginator: GetMetricDataPaginator
  3. item: PageIterator[GetMetricDataOutputTypeDef]

paginate#

Type annotations and code completion for GetMetricDataPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    MetricDataQueries: Sequence[MetricDataQueryUnionTypeDef],  # (1)
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    ScanBy: ScanByType = ...,  # (2)
    LabelOptions: LabelOptionsTypeDef = ...,  # (3)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> botocore.paginate.PageIterator[GetMetricDataOutputTypeDef]:  # (5)
    ...
  1. See Sequence[MetricDataQueryUnionTypeDef]
  2. See ScanByType
  3. See LabelOptionsTypeDef
  4. See PaginatorConfigTypeDef
  5. See PageIterator[GetMetricDataOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: GetMetricDataInputPaginateTypeDef = {  # (1)
    "MetricDataQueries": ...,
    "StartTime": ...,
    "EndTime": ...,
}

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

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 types_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 types_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)
  1. client: CloudWatchClient
  2. paginator: ListDashboardsPaginator
  3. item: PageIterator[ListDashboardsOutputTypeDef]

paginate#

Type annotations and code completion for ListDashboardsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DashboardNamePrefix: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListDashboardsOutputTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See PageIterator[ListDashboardsOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListDashboardsInputPaginateTypeDef = {  # (1)
    "DashboardNamePrefix": ...,
}

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

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 types_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 types_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)
  1. client: CloudWatchClient
  2. paginator: ListMetricsPaginator
  3. item: PageIterator[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)
) -> botocore.paginate.PageIterator[ListMetricsOutputTypeDef]:  # (4)
    ...
  1. See Sequence[DimensionFilterTypeDef]
  2. See RecentlyActiveType
  3. See PaginatorConfigTypeDef
  4. See PageIterator[ListMetricsOutputTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListMetricsInputPaginateTypeDef = {  # (1)
    "Namespace": ...,
}

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