Skip to content

Sustainability module#

Index > Sustainability

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

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.42.80' mypy-boto3-builder
  2. Select boto3 AWS SDK.
  3. Add Sustainability service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and Sustainability.

From PyPI with pip#

Install types-boto3 for Sustainability service.

# install with boto3 type annotations
python -m pip install 'types-boto3[sustainability]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[sustainability]'

# standalone installation
python -m pip install types-boto3-sustainability

How to uninstall#

python -m pip uninstall -y types-boto3-sustainability

Usage#

Code samples can be found in Examples.

SustainabilityClient#

Type annotations and code completion for boto3.client("sustainability") as SustainabilityClient boto3 documentation

# SustainabilityClient usage example

from boto3.session import Session

from types_boto3_sustainability.client import SustainabilityClient

def get_client() -> SustainabilityClient:
    return Session().client("sustainability")

Paginators#

Type annotations and code completion for paginators from boto3.client("sustainability").get_paginator("...").

# GetEstimatedCarbonEmissionsDimensionValuesPaginator usage example

from boto3.session import Session

from types_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"))

Literals#

Type annotations for literals used in methods and schema.

# DimensionType usage example

from types_boto3_sustainability.literals import DimensionType

def get_value() -> DimensionType:
    return "REGION"

Type definitions#

Type annotations for type definitions used in methods and schema.