sustainability/aws.sdk.kotlin.services.sustainability.model/GetEstimatedCarbonEmissionsRequest/Builder

Builder

Properties

var emissionsTypes: List<EmissionsType>?

The emission types to include in the results. If absent, returns TOTAL_LBM_CARBON_EMISSIONS and TOTAL_MBM_CARBON_EMISSIONS emissions types.

var filterBy: FilterExpression?

The criteria for filtering estimated carbon emissions.

var granularity: TimeGranularity?

The time granularity for the results. If absent, uses MONTHLY time granularity.

granularityConfiguration

var granularityConfiguration: GranularityConfiguration?

Configuration for fiscal year calculations when using YEARLY_FISCAL or QUARTERLY_FISCAL granularity.

var groupBy: List<Dimension>?

The dimensions available for grouping estimated carbon emissions.

var maxResults: Int?

The maximum number of results to return in a single call. Default is 40.

var nextToken: String?

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

var timePeriod: TimePeriod?

The date range for fetching estimated carbon emissions.

Functions

fun filterBy(block: FilterExpression.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.sustainability.model.FilterExpression inside the given block

granularityConfiguration

fun granularityConfiguration(block: GranularityConfiguration.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.sustainability.model.GranularityConfiguration inside the given block

fun timePeriod(block: TimePeriod.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.sustainability.model.TimePeriod inside the given block