Skip to content

Type definitions#

Index > Sustainability > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef Union usage example

from types_boto3_sustainability.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

TimePeriodUnionTypeDef#

# TimePeriodUnionTypeDef Union usage example

from types_boto3_sustainability.type_defs import TimePeriodUnionTypeDef


def get_value() -> TimePeriodUnionTypeDef:
    return ...


# TimePeriodUnionTypeDef definition

TimePeriodUnionTypeDef = Union[
    TimePeriodTypeDef,  # (1)
    TimePeriodOutputTypeDef,  # (2)
]
  1. See TimePeriodTypeDef
  2. See TimePeriodOutputTypeDef

DimensionEntryTypeDef#

# DimensionEntryTypeDef TypedDict usage example

from types_boto3_sustainability.type_defs import DimensionEntryTypeDef


def get_value() -> DimensionEntryTypeDef:
    return {
        "Dimension": ...,
    }


# DimensionEntryTypeDef definition

class DimensionEntryTypeDef(TypedDict):
    Dimension: DimensionType,  # (1)
    Value: str,
  1. See DimensionType

EmissionsTypeDef#

# EmissionsTypeDef TypedDict usage example

from types_boto3_sustainability.type_defs import EmissionsTypeDef


def get_value() -> EmissionsTypeDef:
    return {
        "Value": ...,
    }


# EmissionsTypeDef definition

class EmissionsTypeDef(TypedDict):
    Value: float,
    Unit: EmissionsUnitType,  # (1)
  1. See EmissionsUnitType

TimePeriodOutputTypeDef#

# TimePeriodOutputTypeDef TypedDict usage example

from types_boto3_sustainability.type_defs import TimePeriodOutputTypeDef


def get_value() -> TimePeriodOutputTypeDef:
    return {
        "Start": ...,
    }


# TimePeriodOutputTypeDef definition

class TimePeriodOutputTypeDef(TypedDict):
    Start: datetime.datetime,
    End: datetime.datetime,

FilterExpressionTypeDef#

# FilterExpressionTypeDef TypedDict usage example

from types_boto3_sustainability.type_defs import FilterExpressionTypeDef


def get_value() -> FilterExpressionTypeDef:
    return {
        "Dimensions": ...,
    }


# FilterExpressionTypeDef definition

class FilterExpressionTypeDef(TypedDict):
    Dimensions: NotRequired[Mapping[DimensionType, Sequence[str]]],  # (1)
  1. See Mapping[DimensionType, Sequence[str]]

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from types_boto3_sustainability.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_sustainability.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

GranularityConfigurationTypeDef#

# GranularityConfigurationTypeDef TypedDict usage example

from types_boto3_sustainability.type_defs import GranularityConfigurationTypeDef


def get_value() -> GranularityConfigurationTypeDef:
    return {
        "FiscalYearStartMonth": ...,
    }


# GranularityConfigurationTypeDef definition

class GranularityConfigurationTypeDef(TypedDict):
    FiscalYearStartMonth: NotRequired[int],

EstimatedCarbonEmissionsTypeDef#

# EstimatedCarbonEmissionsTypeDef TypedDict usage example

from types_boto3_sustainability.type_defs import EstimatedCarbonEmissionsTypeDef


def get_value() -> EstimatedCarbonEmissionsTypeDef:
    return {
        "TimePeriod": ...,
    }


# EstimatedCarbonEmissionsTypeDef definition

class EstimatedCarbonEmissionsTypeDef(TypedDict):
    TimePeriod: TimePeriodOutputTypeDef,  # (1)
    DimensionsValues: dict[DimensionType, str],  # (2)
    ModelVersion: str,
    EmissionsValues: dict[EmissionsTypeType, EmissionsTypeDef],  # (3)
  1. See TimePeriodOutputTypeDef
  2. See dict[DimensionType, str]
  3. See dict[EmissionsTypeType, EmissionsTypeDef]

GetEstimatedCarbonEmissionsDimensionValuesResponseTypeDef#

# GetEstimatedCarbonEmissionsDimensionValuesResponseTypeDef TypedDict usage example

from types_boto3_sustainability.type_defs import GetEstimatedCarbonEmissionsDimensionValuesResponseTypeDef


def get_value() -> GetEstimatedCarbonEmissionsDimensionValuesResponseTypeDef:
    return {
        "Results": ...,
    }


# GetEstimatedCarbonEmissionsDimensionValuesResponseTypeDef definition

class GetEstimatedCarbonEmissionsDimensionValuesResponseTypeDef(TypedDict):
    Results: list[DimensionEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See list[DimensionEntryTypeDef]
  2. See ResponseMetadataTypeDef

TimePeriodTypeDef#

# TimePeriodTypeDef TypedDict usage example

from types_boto3_sustainability.type_defs import TimePeriodTypeDef


def get_value() -> TimePeriodTypeDef:
    return {
        "Start": ...,
    }


# TimePeriodTypeDef definition

class TimePeriodTypeDef(TypedDict):
    Start: TimestampTypeDef,
    End: TimestampTypeDef,

GetEstimatedCarbonEmissionsResponseTypeDef#

# GetEstimatedCarbonEmissionsResponseTypeDef TypedDict usage example

from types_boto3_sustainability.type_defs import GetEstimatedCarbonEmissionsResponseTypeDef


def get_value() -> GetEstimatedCarbonEmissionsResponseTypeDef:
    return {
        "Results": ...,
    }


# GetEstimatedCarbonEmissionsResponseTypeDef definition

class GetEstimatedCarbonEmissionsResponseTypeDef(TypedDict):
    Results: list[EstimatedCarbonEmissionsTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See list[EstimatedCarbonEmissionsTypeDef]
  2. See ResponseMetadataTypeDef

GetEstimatedCarbonEmissionsDimensionValuesRequestPaginateTypeDef#

# GetEstimatedCarbonEmissionsDimensionValuesRequestPaginateTypeDef TypedDict usage example

from types_boto3_sustainability.type_defs import GetEstimatedCarbonEmissionsDimensionValuesRequestPaginateTypeDef


def get_value() -> GetEstimatedCarbonEmissionsDimensionValuesRequestPaginateTypeDef:
    return {
        "TimePeriod": ...,
    }


# GetEstimatedCarbonEmissionsDimensionValuesRequestPaginateTypeDef definition

class GetEstimatedCarbonEmissionsDimensionValuesRequestPaginateTypeDef(TypedDict):
    TimePeriod: TimePeriodUnionTypeDef,  # (1)
    Dimensions: Sequence[DimensionType],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See TimePeriodUnionTypeDef
  2. See Sequence[DimensionType]
  3. See PaginatorConfigTypeDef

GetEstimatedCarbonEmissionsDimensionValuesRequestTypeDef#

# GetEstimatedCarbonEmissionsDimensionValuesRequestTypeDef TypedDict usage example

from types_boto3_sustainability.type_defs import GetEstimatedCarbonEmissionsDimensionValuesRequestTypeDef


def get_value() -> GetEstimatedCarbonEmissionsDimensionValuesRequestTypeDef:
    return {
        "TimePeriod": ...,
    }


# GetEstimatedCarbonEmissionsDimensionValuesRequestTypeDef definition

class GetEstimatedCarbonEmissionsDimensionValuesRequestTypeDef(TypedDict):
    TimePeriod: TimePeriodUnionTypeDef,  # (1)
    Dimensions: Sequence[DimensionType],  # (2)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See TimePeriodUnionTypeDef
  2. See Sequence[DimensionType]

GetEstimatedCarbonEmissionsRequestPaginateTypeDef#

# GetEstimatedCarbonEmissionsRequestPaginateTypeDef TypedDict usage example

from types_boto3_sustainability.type_defs import GetEstimatedCarbonEmissionsRequestPaginateTypeDef


def get_value() -> GetEstimatedCarbonEmissionsRequestPaginateTypeDef:
    return {
        "TimePeriod": ...,
    }


# GetEstimatedCarbonEmissionsRequestPaginateTypeDef definition

class GetEstimatedCarbonEmissionsRequestPaginateTypeDef(TypedDict):
    TimePeriod: TimePeriodUnionTypeDef,  # (1)
    GroupBy: NotRequired[Sequence[DimensionType]],  # (2)
    FilterBy: NotRequired[FilterExpressionTypeDef],  # (3)
    EmissionsTypes: NotRequired[Sequence[EmissionsTypeType]],  # (4)
    Granularity: NotRequired[TimeGranularityType],  # (5)
    GranularityConfiguration: NotRequired[GranularityConfigurationTypeDef],  # (6)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (7)
  1. See TimePeriodUnionTypeDef
  2. See Sequence[DimensionType]
  3. See FilterExpressionTypeDef
  4. See Sequence[EmissionsTypeType]
  5. See TimeGranularityType
  6. See GranularityConfigurationTypeDef
  7. See PaginatorConfigTypeDef

GetEstimatedCarbonEmissionsRequestTypeDef#

# GetEstimatedCarbonEmissionsRequestTypeDef TypedDict usage example

from types_boto3_sustainability.type_defs import GetEstimatedCarbonEmissionsRequestTypeDef


def get_value() -> GetEstimatedCarbonEmissionsRequestTypeDef:
    return {
        "TimePeriod": ...,
    }


# GetEstimatedCarbonEmissionsRequestTypeDef definition

class GetEstimatedCarbonEmissionsRequestTypeDef(TypedDict):
    TimePeriod: TimePeriodUnionTypeDef,  # (1)
    GroupBy: NotRequired[Sequence[DimensionType]],  # (2)
    FilterBy: NotRequired[FilterExpressionTypeDef],  # (3)
    EmissionsTypes: NotRequired[Sequence[EmissionsTypeType]],  # (4)
    Granularity: NotRequired[TimeGranularityType],  # (5)
    GranularityConfiguration: NotRequired[GranularityConfigurationTypeDef],  # (6)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See TimePeriodUnionTypeDef
  2. See Sequence[DimensionType]
  3. See FilterExpressionTypeDef
  4. See Sequence[EmissionsTypeType]
  5. See TimeGranularityType
  6. See GranularityConfigurationTypeDef