Paginators

Index > CloudWatch > Paginators

Auto-generated documentation for CloudWatch type annotations stubs module types-aiobotocore-cloudwatch.

DescribeAlarmHistoryPaginator

Type annotations and code completion for session.create_client("cloudwatch").get_paginator("describe_alarm_history"). boto3 documentation

# DescribeAlarmHistoryPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_cloudwatch.paginator import DescribeAlarmHistoryPaginator

session = get_session()
async with session.create_client("cloudwatch") as client:  # (1)
    paginator: DescribeAlarmHistoryPaginator = client.get_paginator("describe_alarm_history")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeAlarmHistoryOutputTypeDef
        print(item)  # (3)

1. client: CloudWatchClient
2. paginator: DescribeAlarmHistoryPaginator
3. 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)
) -> AsyncIterator[DescribeAlarmHistoryOutputTypeDef]:  # (5)
    ...

1. See AlarmTypeType
2. See HistoryItemTypeType
3. See ScanByType
4. See PaginatorConfigTypeDef
5. See DescribeAlarmHistoryOutputTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See DescribeAlarmHistoryInputDescribeAlarmHistoryPaginateTypeDef

DescribeAlarmsPaginator

Type annotations and code completion for session.create_client("cloudwatch").get_paginator("describe_alarms"). boto3 documentation

# DescribeAlarmsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_cloudwatch.paginator import DescribeAlarmsPaginator

session = get_session()
async with session.create_client("cloudwatch") as client:  # (1)
    paginator: DescribeAlarmsPaginator = client.get_paginator("describe_alarms")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeAlarmsOutputTypeDef
        print(item)  # (3)

1. client: CloudWatchClient
2. paginator: DescribeAlarmsPaginator
3. 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)
) -> AsyncIterator[DescribeAlarmsOutputTypeDef]:  # (4)
    ...

1. See AlarmTypeType
2. See StateValueType
3. See PaginatorConfigTypeDef
4. See DescribeAlarmsOutputTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See DescribeAlarmsInputDescribeAlarmsPaginateTypeDef

DescribeAnomalyDetectorsPaginator

Type annotations and code completion for session.create_client("cloudwatch").get_paginator("describe_anomaly_detectors"). boto3 documentation

# DescribeAnomalyDetectorsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_cloudwatch.paginator import DescribeAnomalyDetectorsPaginator

session = get_session()
async with session.create_client("cloudwatch") as client:  # (1)
    paginator: DescribeAnomalyDetectorsPaginator = client.get_paginator("describe_anomaly_detectors")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeAnomalyDetectorsOutputMetricTypeDef
        print(item)  # (3)

1. client: CloudWatchClient
2. paginator: DescribeAnomalyDetectorsPaginator
3. item: DescribeAnomalyDetectorsOutputMetricTypeDef

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)
) -> AsyncIterator[DescribeAnomalyDetectorsOutputMetricTypeDef]:  # (4)
    ...

1. See DimensionTypeDef
2. See AnomalyDetectorTypeType
3. See PaginatorConfigTypeDef
4. See DescribeAnomalyDetectorsOutputMetricTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See DescribeAnomalyDetectorsInputDescribeAnomalyDetectorsPaginateTypeDef

GetMetricDataPaginator

Type annotations and code completion for session.create_client("cloudwatch").get_paginator("get_metric_data"). boto3 documentation

# GetMetricDataPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_cloudwatch.paginator import GetMetricDataPaginator

session = get_session()
async with session.create_client("cloudwatch") as client:  # (1)
    paginator: GetMetricDataPaginator = client.get_paginator("get_metric_data")  # (2)
    async for item in paginator.paginate(...):
        item: GetMetricDataOutputTypeDef
        print(item)  # (3)

1. client: CloudWatchClient
2. paginator: GetMetricDataPaginator
3. item: GetMetricDataOutputTypeDef

paginate

Type annotations and code completion for GetMetricDataPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    MetricDataQueries: Sequence[MetricDataQueryTypeDef],  # (1)
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    ScanBy: ScanByType = ...,  # (2)
    LabelOptions: LabelOptionsTypeDef = ...,  # (3)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> AsyncIterator[GetMetricDataOutputTypeDef]:  # (5)
    ...

1. See MetricDataQueryTypeDef
2. See ScanByType
3. See LabelOptionsTypeDef
4. See PaginatorConfigTypeDef
5. See GetMetricDataOutputTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See GetMetricDataInputGetMetricDataPaginateTypeDef

ListDashboardsPaginator

Type annotations and code completion for session.create_client("cloudwatch").get_paginator("list_dashboards"). boto3 documentation

# ListDashboardsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_cloudwatch.paginator import ListDashboardsPaginator

session = get_session()
async with session.create_client("cloudwatch") as client:  # (1)
    paginator: ListDashboardsPaginator = client.get_paginator("list_dashboards")  # (2)
    async for item in paginator.paginate(...):
        item: ListDashboardsOutputTypeDef
        print(item)  # (3)

1. client: CloudWatchClient
2. paginator: ListDashboardsPaginator
3. item: ListDashboardsOutputTypeDef

paginate

Type annotations and code completion for ListDashboardsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DashboardNamePrefix: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> AsyncIterator[ListDashboardsOutputTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See ListDashboardsOutputTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See ListDashboardsInputListDashboardsPaginateTypeDef

ListMetricsPaginator

Type annotations and code completion for session.create_client("cloudwatch").get_paginator("list_metrics"). boto3 documentation

# ListMetricsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_cloudwatch.paginator import ListMetricsPaginator

session = get_session()
async with session.create_client("cloudwatch") as client:  # (1)
    paginator: ListMetricsPaginator = client.get_paginator("list_metrics")  # (2)
    async for item in paginator.paginate(...):
        item: ListMetricsOutputTypeDef
        print(item)  # (3)

1. client: CloudWatchClient
2. paginator: ListMetricsPaginator
3. 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)
) -> AsyncIterator[ListMetricsOutputTypeDef]:  # (4)
    ...

1. See DimensionFilterTypeDef
2. See RecentlyActiveType
3. See PaginatorConfigTypeDef
4. See ListMetricsOutputTypeDef

# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)

1. See ListMetricsInputListMetricsPaginateTypeDef