sustainability/aws.sdk.kotlin.services.sustainability/SustainabilityClient

SustainabilityClient

The AWS Sustainability service provides programmatic access to estimated carbon emissions data for your Amazon Web Services usage. Use the AWS Sustainability service to retrieve, analyze, and track the carbon footprint of your cloud infrastructure over time.

With the AWS Sustainability service, you can:

Retrieve estimated carbon emissions for your Amazon Web Services usage across different time periods
Group emissions data by dimensions such as account, region, and service
Filter emissions data to focus on specific accounts, regions, or services
Access multiple emissions calculation methodologies including Location-based Method (LBM) and Market-based Method (MBM)
Aggregate emissions data at various time granularities including monthly, quarterly, and yearly periods

The API supports pagination for efficient data retrieval and provides dimension values to help you understand the available grouping and filtering options for your account.

All emissions values are calculated using methodologies aligned with the Greenhouse Gas (GHG) Protocol and are provided in metric tons of carbon dioxide-equivalent (MTCO2e).

Types

Builder

class Builder

Companion

object Companion

Config

class Config

Properties

config

abstract val config: SustainabilityClient.Config

SustainabilityClient's configuration

Functions

getEstimatedCarbonEmissions

abstract suspend fun getEstimatedCarbonEmissions(input: GetEstimatedCarbonEmissionsRequest): GetEstimatedCarbonEmissionsResponse

Returns estimated carbon emission values based on customer grouping and filtering parameters. We recommend using pagination to ensure that the operation returns quickly and successfully.

getEstimatedCarbonEmissionsDimensionValues

abstract suspend fun getEstimatedCarbonEmissionsDimensionValues(input: GetEstimatedCarbonEmissionsDimensionValuesRequest): GetEstimatedCarbonEmissionsDimensionValuesResponse

Returns the possible dimension values available for a customer's account. We recommend using pagination to ensure that the operation returns quickly and successfully.

Inherited functions

getEstimatedCarbonEmissions

inline suspend fun SustainabilityClient.getEstimatedCarbonEmissions(crossinline block: GetEstimatedCarbonEmissionsRequest.Builder.() -> Unit): GetEstimatedCarbonEmissionsResponse

Returns estimated carbon emission values based on customer grouping and filtering parameters. We recommend using pagination to ensure that the operation returns quickly and successfully.

getEstimatedCarbonEmissionsDimensionValues

inline suspend fun SustainabilityClient.getEstimatedCarbonEmissionsDimensionValues(crossinline block: GetEstimatedCarbonEmissionsDimensionValuesRequest.Builder.() -> Unit): GetEstimatedCarbonEmissionsDimensionValuesResponse

Returns the possible dimension values available for a customer's account. We recommend using pagination to ensure that the operation returns quickly and successfully.

getEstimatedCarbonEmissionsDimensionValuesPaginated

fun SustainabilityClient.getEstimatedCarbonEmissionsDimensionValuesPaginated(initialRequest: GetEstimatedCarbonEmissionsDimensionValuesRequest): Flow<GetEstimatedCarbonEmissionsDimensionValuesResponse>

fun SustainabilityClient.getEstimatedCarbonEmissionsDimensionValuesPaginated(block: GetEstimatedCarbonEmissionsDimensionValuesRequest.Builder.() -> Unit): Flow<GetEstimatedCarbonEmissionsDimensionValuesResponse>

Paginate over GetEstimatedCarbonEmissionsDimensionValuesResponse results.

getEstimatedCarbonEmissionsPaginated

fun SustainabilityClient.getEstimatedCarbonEmissionsPaginated(initialRequest: GetEstimatedCarbonEmissionsRequest): Flow<GetEstimatedCarbonEmissionsResponse>

fun SustainabilityClient.getEstimatedCarbonEmissionsPaginated(block: GetEstimatedCarbonEmissionsRequest.Builder.() -> Unit): Flow<GetEstimatedCarbonEmissionsResponse>

Paginate over GetEstimatedCarbonEmissionsResponse results.

withConfig

fun SustainabilityClient.withConfig(block: SustainabilityClient.Config.Builder.() -> Unit): SustainabilityClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.