Skip to content

SustainabilityClient#

Index > Sustainability > SustainabilityClient

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

SustainabilityClient#

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

# SustainabilityClient usage example

from boto3.session import Session
from types_boto3_sustainability.client import SustainabilityClient

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

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("sustainability").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("sustainability")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.InternalServerException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_sustainability.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("sustainability").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("sustainability").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_estimated_carbon_emissions#

Returns estimated carbon emission values based on customer grouping and filtering parameters.

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

# get_estimated_carbon_emissions method definition

def get_estimated_carbon_emissions(
    self,
    *,
    TimePeriod: TimePeriodUnionTypeDef,  # (1)
    GroupBy: Sequence[DimensionType] = ...,  # (2)
    FilterBy: FilterExpressionTypeDef = ...,  # (3)
    EmissionsTypes: Sequence[EmissionsTypeType] = ...,  # (4)
    Granularity: TimeGranularityType = ...,  # (5)
    GranularityConfiguration: GranularityConfigurationTypeDef = ...,  # (6)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetEstimatedCarbonEmissionsResponseTypeDef:  # (7)
    ...
  1. See TimePeriodUnionTypeDef
  2. See Sequence[DimensionType]
  3. See FilterExpressionTypeDef
  4. See Sequence[EmissionsTypeType]
  5. See TimeGranularityType
  6. See GranularityConfigurationTypeDef
  7. See GetEstimatedCarbonEmissionsResponseTypeDef
# get_estimated_carbon_emissions method usage example with argument unpacking

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

parent.get_estimated_carbon_emissions(**kwargs)
  1. See GetEstimatedCarbonEmissionsRequestTypeDef

get_estimated_carbon_emissions_dimension_values#

Returns the possible dimension values available for a customer's account.

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

# get_estimated_carbon_emissions_dimension_values method definition

def get_estimated_carbon_emissions_dimension_values(
    self,
    *,
    TimePeriod: TimePeriodUnionTypeDef,  # (1)
    Dimensions: Sequence[DimensionType],  # (2)
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetEstimatedCarbonEmissionsDimensionValuesResponseTypeDef:  # (3)
    ...
  1. See TimePeriodUnionTypeDef
  2. See Sequence[DimensionType]
  3. See GetEstimatedCarbonEmissionsDimensionValuesResponseTypeDef
# get_estimated_carbon_emissions_dimension_values method usage example with argument unpacking

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

parent.get_estimated_carbon_emissions_dimension_values(**kwargs)
  1. See GetEstimatedCarbonEmissionsDimensionValuesRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("sustainability").get_paginator method with overloads.