Paginators

Index > Sustainability > Paginators

Auto-generated documentation for Sustainability type annotations stubs module mypy-boto3-sustainability.

GetEstimatedCarbonEmissionsDimensionValuesPaginator

Type annotations and code completion for boto3.client("sustainability").get_paginator("get_estimated_carbon_emissions_dimension_values"). boto3 documentation

# GetEstimatedCarbonEmissionsDimensionValuesPaginator usage example

from boto3.session import Session

from mypy_boto3_sustainability.paginator import GetEstimatedCarbonEmissionsDimensionValuesPaginator

def get_get_estimated_carbon_emissions_dimension_values_paginator() -> GetEstimatedCarbonEmissionsDimensionValuesPaginator:
    return Session().client("sustainability").get_paginator("get_estimated_carbon_emissions_dimension_values")

# GetEstimatedCarbonEmissionsDimensionValuesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_sustainability.paginator import GetEstimatedCarbonEmissionsDimensionValuesPaginator

session = Session()

client = Session().client("sustainability")  # (1)
paginator: GetEstimatedCarbonEmissionsDimensionValuesPaginator = client.get_paginator("get_estimated_carbon_emissions_dimension_values")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: SustainabilityClient
2. paginator: GetEstimatedCarbonEmissionsDimensionValuesPaginator
3. item: PageIterator[GetEstimatedCarbonEmissionsDimensionValuesResponseTypeDef]

paginate

Type annotations and code completion for GetEstimatedCarbonEmissionsDimensionValuesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    TimePeriod: TimePeriodUnionTypeDef,  # (1)
    Dimensions: Sequence[DimensionType],  # (2)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> botocore.paginate.PageIterator[GetEstimatedCarbonEmissionsDimensionValuesResponseTypeDef]:  # (4)
    ...

1. See TimePeriodUnionTypeDef
2. See Sequence[DimensionType]
3. See PaginatorConfigTypeDef
4. See PageIterator[GetEstimatedCarbonEmissionsDimensionValuesResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: GetEstimatedCarbonEmissionsDimensionValuesRequestPaginateTypeDef = {  # (1)
    "TimePeriod": ...,
    "Dimensions": ...,
}

parent.paginate(**kwargs)

1. See GetEstimatedCarbonEmissionsDimensionValuesRequestPaginateTypeDef

GetEstimatedCarbonEmissionsPaginator

Type annotations and code completion for boto3.client("sustainability").get_paginator("get_estimated_carbon_emissions"). boto3 documentation

# GetEstimatedCarbonEmissionsPaginator usage example

from boto3.session import Session

from mypy_boto3_sustainability.paginator import GetEstimatedCarbonEmissionsPaginator

def get_get_estimated_carbon_emissions_paginator() -> GetEstimatedCarbonEmissionsPaginator:
    return Session().client("sustainability").get_paginator("get_estimated_carbon_emissions")

# GetEstimatedCarbonEmissionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_sustainability.paginator import GetEstimatedCarbonEmissionsPaginator

session = Session()

client = Session().client("sustainability")  # (1)
paginator: GetEstimatedCarbonEmissionsPaginator = client.get_paginator("get_estimated_carbon_emissions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: SustainabilityClient
2. paginator: GetEstimatedCarbonEmissionsPaginator
3. item: PageIterator[GetEstimatedCarbonEmissionsResponseTypeDef]

paginate

Type annotations and code completion for GetEstimatedCarbonEmissionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    TimePeriod: TimePeriodUnionTypeDef,  # (1)
    GroupBy: Sequence[DimensionType] = ...,  # (2)
    FilterBy: FilterExpressionTypeDef = ...,  # (3)
    EmissionsTypes: Sequence[EmissionsTypeType] = ...,  # (4)
    Granularity: TimeGranularityType = ...,  # (5)
    GranularityConfiguration: GranularityConfigurationTypeDef = ...,  # (6)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (7)
) -> botocore.paginate.PageIterator[GetEstimatedCarbonEmissionsResponseTypeDef]:  # (8)
    ...

1. See TimePeriodUnionTypeDef
2. See Sequence[DimensionType]
3. See FilterExpressionTypeDef
4. See Sequence[EmissionsTypeType]
5. See TimeGranularityType
6. See GranularityConfigurationTypeDef
7. See PaginatorConfigTypeDef
8. See PageIterator[GetEstimatedCarbonEmissionsResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: GetEstimatedCarbonEmissionsRequestPaginateTypeDef = {  # (1)
    "TimePeriod": ...,
}

parent.paginate(**kwargs)

1. See GetEstimatedCarbonEmissionsRequestPaginateTypeDef