@aws-sdk/client-sustainability 3.1088.0 → 3.1089.0

package/dist-types/commands/GetEstimatedWaterAllocationCommand.d.ts

@@ -0,0 +1,162 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { GetEstimatedWaterAllocationRequest, GetEstimatedWaterAllocationResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link GetEstimatedWaterAllocationCommand}.
+ */
+export interface GetEstimatedWaterAllocationCommandInput extends GetEstimatedWaterAllocationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetEstimatedWaterAllocationCommand}.
+ */
+export interface GetEstimatedWaterAllocationCommandOutput extends GetEstimatedWaterAllocationResponse, __MetadataBearer {
+}
+declare const GetEstimatedWaterAllocationCommand_base: {
+    new (input: GetEstimatedWaterAllocationCommandInput): import("@smithy/core/client").CommandImpl<GetEstimatedWaterAllocationCommandInput, GetEstimatedWaterAllocationCommandOutput, import("..").SustainabilityClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: GetEstimatedWaterAllocationCommandInput): import("@smithy/core/client").CommandImpl<GetEstimatedWaterAllocationCommandInput, GetEstimatedWaterAllocationCommandOutput, import("..").SustainabilityClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns estimated water allocation values based on customer grouping and filtering parameters. We recommend using pagination to ensure that the operation returns quickly and successfully. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SustainabilityClient, GetEstimatedWaterAllocationCommand } from "@aws-sdk/client-sustainability"; // ES Modules import
+ * // const { SustainabilityClient, GetEstimatedWaterAllocationCommand } = require("@aws-sdk/client-sustainability"); // CommonJS import
+ * // import type { SustainabilityClientConfig } from "@aws-sdk/client-sustainability";
+ * const config = {}; // type is SustainabilityClientConfig
+ * const client = new SustainabilityClient(config);
+ * const input = { // GetEstimatedWaterAllocationRequest
+ *   TimePeriod: { // TimePeriod
+ *     Start: new Date("TIMESTAMP"), // required
+ *     End: new Date("TIMESTAMP"), // required
+ *   },
+ *   GroupBy: [ // DimensionList
+ *     "USAGE_ACCOUNT_ID" || "REGION" || "SERVICE",
+ *   ],
+ *   FilterBy: { // FilterExpression
+ *     Dimensions: { // DimensionListMap
+ *       "<keys>": [ // DimensionValueList
+ *         "STRING_VALUE",
+ *       ],
+ *     },
+ *   },
+ *   AllocationTypes: [ // WaterAllocationTypeList
+ *     "TOTAL_WATER_WITHDRAWALS",
+ *   ],
+ *   Granularity: "YEARLY_CALENDAR" || "YEARLY_FISCAL" || "QUARTERLY_CALENDAR" || "QUARTERLY_FISCAL" || "MONTHLY",
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new GetEstimatedWaterAllocationCommand(input);
+ * const response = await client.send(command);
+ * // { // GetEstimatedWaterAllocationResponse
+ * //   Results: [ // EstimatedWaterAllocationList // required
+ * //     { // EstimatedWaterAllocation
+ * //       TimePeriod: { // TimePeriod
+ * //         Start: new Date("TIMESTAMP"), // required
+ * //         End: new Date("TIMESTAMP"), // required
+ * //       },
+ * //       DimensionsValues: { // DimensionsMap // required
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //       ModelVersion: "STRING_VALUE", // required
+ * //       AllocationValues: { // WaterAllocationMap // required
+ * //         "<keys>": { // WaterAllocation
+ * //           Value: Number("double"), // required
+ * //           Unit: "m3", // required
+ * //         },
+ * //       },
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param GetEstimatedWaterAllocationCommandInput - {@link GetEstimatedWaterAllocationCommandInput}
+ * @returns {@link GetEstimatedWaterAllocationCommandOutput}
+ * @see {@link GetEstimatedWaterAllocationCommandInput} for command's `input` shape.
+ * @see {@link GetEstimatedWaterAllocationCommandOutput} for command's `response` shape.
+ * @see {@link SustainabilityClientResolvedConfig | config} for SustainabilityClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception, or failure.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link SustainabilityServiceException}
+ * <p>Base exception class for all service exceptions from Sustainability service.</p>
+ *
+ *
+ * @example GetEstimatedWaterAllocationSuccess
+ * ```javascript
+ * //
+ * const input = {
+ *   AllocationTypes: [
+ *     "TOTAL_WATER_WITHDRAWALS"
+ *   ],
+ *   Granularity: "YEARLY_CALENDAR",
+ *   GroupBy: [
+ *     "SERVICE"
+ *   ],
+ *   TimePeriod: {
+ *     End: "2026-01-01T00:00:00.00Z",
+ *     Start: "2025-01-01T00:00:00.00Z"
+ *   }
+ * };
+ * const command = new GetEstimatedWaterAllocationCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   Results: [
+ *     {
+ *       AllocationValues: {
+ *         TOTAL_WATER_WITHDRAWALS: {
+ *           Unit: "m3",
+ *           Value: 1
+ *         }
+ *       },
+ *       DimensionsValues: {
+ *         SERVICE: "AmazonEC2"
+ *       },
+ *       ModelVersion: "v1.0.0",
+ *       TimePeriod: {
+ *         End: "2026-01-01T00:00:00Z",
+ *         Start: "2025-01-01T00:00:00Z"
+ *       }
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class GetEstimatedWaterAllocationCommand extends GetEstimatedWaterAllocationCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetEstimatedWaterAllocationRequest;
+            output: GetEstimatedWaterAllocationResponse;
+        };
+        sdk: {
+            input: GetEstimatedWaterAllocationCommandInput;
+            output: GetEstimatedWaterAllocationCommandOutput;
+        };
+    };
+}

package/dist-types/commands/GetEstimatedWaterAllocationDimensionValuesCommand.d.ts

@@ -0,0 +1,149 @@
+import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
+import type { GetEstimatedWaterAllocationDimensionValuesRequest, GetEstimatedWaterAllocationDimensionValuesResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export type { __MetadataBearer };
+/**
+ * @public
+ *
+ * The input for {@link GetEstimatedWaterAllocationDimensionValuesCommand}.
+ */
+export interface GetEstimatedWaterAllocationDimensionValuesCommandInput extends GetEstimatedWaterAllocationDimensionValuesRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link GetEstimatedWaterAllocationDimensionValuesCommand}.
+ */
+export interface GetEstimatedWaterAllocationDimensionValuesCommandOutput extends GetEstimatedWaterAllocationDimensionValuesResponse, __MetadataBearer {
+}
+declare const GetEstimatedWaterAllocationDimensionValuesCommand_base: {
+    new (input: GetEstimatedWaterAllocationDimensionValuesCommandInput): import("@smithy/core/client").CommandImpl<GetEstimatedWaterAllocationDimensionValuesCommandInput, GetEstimatedWaterAllocationDimensionValuesCommandOutput, import("..").SustainabilityClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    new (input: GetEstimatedWaterAllocationDimensionValuesCommandInput): import("@smithy/core/client").CommandImpl<GetEstimatedWaterAllocationDimensionValuesCommandInput, GetEstimatedWaterAllocationDimensionValuesCommandOutput, import("..").SustainabilityClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
+    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
+};
+/**
+ * <p>Returns the possible dimension values available for a customer's account. We recommend using pagination to ensure that the operation returns quickly and successfully. </p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SustainabilityClient, GetEstimatedWaterAllocationDimensionValuesCommand } from "@aws-sdk/client-sustainability"; // ES Modules import
+ * // const { SustainabilityClient, GetEstimatedWaterAllocationDimensionValuesCommand } = require("@aws-sdk/client-sustainability"); // CommonJS import
+ * // import type { SustainabilityClientConfig } from "@aws-sdk/client-sustainability";
+ * const config = {}; // type is SustainabilityClientConfig
+ * const client = new SustainabilityClient(config);
+ * const input = { // GetEstimatedWaterAllocationDimensionValuesRequest
+ *   TimePeriod: { // TimePeriod
+ *     Start: new Date("TIMESTAMP"), // required
+ *     End: new Date("TIMESTAMP"), // required
+ *   },
+ *   Dimensions: [ // DimensionList // required
+ *     "USAGE_ACCOUNT_ID" || "REGION" || "SERVICE",
+ *   ],
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ * };
+ * const command = new GetEstimatedWaterAllocationDimensionValuesCommand(input);
+ * const response = await client.send(command);
+ * // { // GetEstimatedWaterAllocationDimensionValuesResponse
+ * //   Results: [ // DimensionEntryList // required
+ * //     { // DimensionEntry
+ * //       Dimension: "USAGE_ACCOUNT_ID" || "REGION" || "SERVICE", // required
+ * //       Value: "STRING_VALUE", // required
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param GetEstimatedWaterAllocationDimensionValuesCommandInput - {@link GetEstimatedWaterAllocationDimensionValuesCommandInput}
+ * @returns {@link GetEstimatedWaterAllocationDimensionValuesCommandOutput}
+ * @see {@link GetEstimatedWaterAllocationDimensionValuesCommandInput} for command's `input` shape.
+ * @see {@link GetEstimatedWaterAllocationDimensionValuesCommandOutput} for command's `response` shape.
+ * @see {@link SustainabilityClientResolvedConfig | config} for SustainabilityClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>The request processing has failed because of an unknown error, exception, or failure.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link SustainabilityServiceException}
+ * <p>Base exception class for all service exceptions from Sustainability service.</p>
+ *
+ *
+ * @example GetEstimatedWaterAllocationDimensionValuesSuccess
+ * ```javascript
+ * //
+ * const input = {
+ *   Dimensions: [
+ *     "REGION",
+ *     "SERVICE",
+ *     "USAGE_ACCOUNT_ID"
+ *   ],
+ *   TimePeriod: {
+ *     End: "2026-01-01T00:00:00.00Z",
+ *     Start: "2025-01-01T00:00:00.00Z"
+ *   }
+ * };
+ * const command = new GetEstimatedWaterAllocationDimensionValuesCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   Results: [
+ *     {
+ *       Dimension: "SERVICE",
+ *       Value: "AmazonEC2"
+ *     },
+ *     {
+ *       Dimension: "SERVICE",
+ *       Value: "AmazonS3"
+ *     },
+ *     {
+ *       Dimension: "SERVICE",
+ *       Value: "AmazonCloudFront"
+ *     },
+ *     {
+ *       Dimension: "REGION",
+ *       Value: "global"
+ *     },
+ *     {
+ *       Dimension: "REGION",
+ *       Value: "us-east-1"
+ *     },
+ *     {
+ *       Dimension: "REGION",
+ *       Value: "us-west-2"
+ *     },
+ *     {
+ *       Dimension: "USAGE_ACCOUNT_ID",
+ *       Value: "111222333444"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * ```
+ *
+ * @public
+ */
+export declare class GetEstimatedWaterAllocationDimensionValuesCommand extends GetEstimatedWaterAllocationDimensionValuesCommand_base {
+    /** @internal type navigation helper, not in runtime. */
+    protected static __types: {
+        api: {
+            input: GetEstimatedWaterAllocationDimensionValuesRequest;
+            output: GetEstimatedWaterAllocationDimensionValuesResponse;
+        };
+        sdk: {
+            input: GetEstimatedWaterAllocationDimensionValuesCommandInput;
+            output: GetEstimatedWaterAllocationDimensionValuesCommandOutput;
+        };
+    };
+}

package/dist-types/commands/index.d.ts

@@ -1,2 +1,4 @@
 export * from "./GetEstimatedCarbonEmissionsCommand";
 export * from "./GetEstimatedCarbonEmissionsDimensionValuesCommand";
+export * from "./GetEstimatedWaterAllocationCommand";
+export * from "./GetEstimatedWaterAllocationDimensionValuesCommand";

package/dist-types/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * <p>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. </p> <p>With the AWS Sustainability service, you can:</p> <ul> <li> <p>Retrieve estimated carbon emissions for your Amazon Web Services usage across different time periods </p> </li> <li> <p>Group emissions data by dimensions such as account, region, and service</p> </li> <li> <p>Filter emissions data to focus on specific accounts, regions, or services</p> </li> <li> <p>Access multiple emissions calculation methodologies including Location-based Method (LBM) and Market-based Method (MBM) </p> </li> <li> <p>Aggregate emissions data at various time granularities including monthly, quarterly, and yearly periods </p> </li> </ul> <p> 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. </p> <p> 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). </p>
+ * <p>The AWS Sustainability service provides programmatic access to estimated environmental impact data for your Amazon Web Services usage. Use the AWS Sustainability service to retrieve, analyze, and track the environmental impact of your cloud infrastructure over time. </p> <p>With the AWS Sustainability service, you can:</p> <ul> <li> <p>Retrieve estimated carbon emissions and water allocation for your Amazon Web Services usage across different time periods </p> </li> <li> <p>Group environmental impact data by dimensions such as account, region, and service</p> </li> <li> <p>Filter environmental impact data to focus on specific accounts, regions, or services</p> </li> <li> <p>Access multiple carbon emissions calculation methodologies including Location-based Method (LBM) and Market-based Method (MBM) </p> </li> <li> <p>Aggregate environmental impact data at various time granularities including monthly, quarterly, and yearly periods </p> </li> </ul> <p> 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. </p>
  *
  * @packageDocumentation
  */

package/dist-types/models/enums.d.ts

@@ -50,7 +50,7 @@ export declare const Dimension: {
      */
     readonly SERVICE: "SERVICE";
     /**
-     * <p>The account ID whose Amazon Web Services usage resulted in the estimated carbon emissions.</p>
+     * <p>The account ID whose Amazon Web Services usage is associated with the estimated environmental impact data.</p>
      */
     readonly USAGE_ACCOUNT_ID: "USAGE_ACCOUNT_ID";
 };
@@ -64,23 +64,23 @@ export type Dimension = (typeof Dimension)[keyof typeof Dimension];
  */
 export declare const TimeGranularity: {
     /**
-     * <p>Emissions aggregated by calendar month.</p>
+     * <p>Environmental impact data aggregated by calendar month.</p>
      */
     readonly MONTHLY: "MONTHLY";
     /**
-     * <p>Emissions aggregated over calendar quarter periods (Q1: Jan-Mar, Q2: Apr-Jun, Q3: Jul-Sep, Q4: Oct-Dec).</p>
+     * <p>Environmental impact data aggregated over calendar quarter periods (Q1: Jan-Mar, Q2: Apr-Jun, Q3: Jul-Sep, Q4: Oct-Dec).</p>
      */
     readonly QUARTERLY_CALENDAR: "QUARTERLY_CALENDAR";
     /**
-     * <p>Emissions aggregated over fiscal quarter periods based on the fiscal year start month specified in GranularityConfiguration.FiscalYearStartMonth.</p>
+     * <p>Environmental impact data aggregated over fiscal quarter periods based on the fiscal year start month specified in GranularityConfiguration.FiscalYearStartMonth.</p>
      */
     readonly QUARTERLY_FISCAL: "QUARTERLY_FISCAL";
     /**
-     * <p>Emissions aggregated over calendar year periods (January-December).</p>
+     * <p>Environmental impact data aggregated over calendar year periods (January-December).</p>
      */
     readonly YEARLY_CALENDAR: "YEARLY_CALENDAR";
     /**
-     * <p>Emissions aggregated over fiscal year periods starting from the month specified in GranularityConfiguration.FiscalYearStartMonth.</p>
+     * <p>Environmental impact data aggregated over fiscal year periods starting from the month specified in GranularityConfiguration.FiscalYearStartMonth.</p>
      */
     readonly YEARLY_FISCAL: "YEARLY_FISCAL";
 };
@@ -102,3 +102,31 @@ export declare const EmissionsUnit: {
  * @public
  */
 export type EmissionsUnit = (typeof EmissionsUnit)[keyof typeof EmissionsUnit];
+/**
+ * @public
+ * @enum
+ */
+export declare const WaterAllocationType: {
+    /**
+     * <p>Total water drawn from surface water, groundwater, seawater, or a third party associated with Amazon Web Services account usage.</p>
+     */
+    readonly TOTAL_WATER_WITHDRAWALS: "TOTAL_WATER_WITHDRAWALS";
+};
+/**
+ * @public
+ */
+export type WaterAllocationType = (typeof WaterAllocationType)[keyof typeof WaterAllocationType];
+/**
+ * @public
+ * @enum
+ */
+export declare const WaterAllocationUnit: {
+    /**
+     * <p>Cubic meters of water.</p>
+     */
+    readonly CUBIC_METERS: "m3";
+};
+/**
+ * @public
+ */
+export type WaterAllocationUnit = (typeof WaterAllocationUnit)[keyof typeof WaterAllocationUnit];

package/dist-types/models/models_0.d.ts

@@ -1,11 +1,11 @@
-import type { Dimension, EmissionsType, EmissionsUnit, TimeGranularity } from "./enums";
+import type { Dimension, EmissionsType, EmissionsUnit, TimeGranularity, WaterAllocationType, WaterAllocationUnit } from "./enums";
 /**
- * <p>Filters emission values by specific dimension values.</p>
+ * <p>Filters environmental impact values by specific dimension values.</p>
  * @public
  */
 export interface FilterExpression {
     /**
-     * <p>Filters emission values by specific dimension values.</p>
+     * <p>Filters environmental impact values by specific dimension values.</p>
      * @public
      */
     Dimensions?: Partial<Record<Dimension, string[]>> | undefined;
@@ -42,7 +42,7 @@ export interface TimePeriod {
  */
 export interface GetEstimatedCarbonEmissionsRequest {
     /**
-     * <p>The date range for fetching estimated carbon emissions.</p>
+     * <p> The date range for fetching estimated carbon emissions. The range must include the start date of a month for that month's data to be included in the response. </p>
      * @public
      */
     TimePeriod: TimePeriod | undefined;
@@ -52,7 +52,7 @@ export interface GetEstimatedCarbonEmissionsRequest {
      */
     GroupBy?: Dimension[] | undefined;
     /**
-     * <p>The criteria for filtering estimated carbon emissions.</p>
+     * <p> The criteria for filtering estimated carbon emissions. To determine which dimensions are available to be filtered by, you can first call <a>GetEstimatedCarbonEmissionsDimensionValues</a> </p>
      * @public
      */
     FilterBy?: FilterExpression | undefined;
@@ -62,7 +62,7 @@ export interface GetEstimatedCarbonEmissionsRequest {
      */
     EmissionsTypes?: EmissionsType[] | undefined;
     /**
-     * <p>The time granularity for the results. If absent, uses <code>MONTHLY</code> time granularity.</p>
+     * <p> The time granularity for the results. If absent, uses <code>MONTHLY</code> time granularity. The smallest supported granularity for carbon emissions is <code>MONTHLY</code>. </p> <p> If requesting partial time periods, data will be returned based on the smallest supported granularity. For example, requesting <code>2025-04-01T00:00:00Z</code> to <code>2026-04-01T00:00:00Z</code> with <code>YEARLY_CALENDAR</code> granularity will return the last 9 months for 2025 and the first 3 months of 2026. </p>
      * @public
      */
     Granularity?: TimeGranularity | undefined;
@@ -72,7 +72,7 @@ export interface GetEstimatedCarbonEmissionsRequest {
      */
     GranularityConfiguration?: GranularityConfiguration | undefined;
     /**
-     * <p>The maximum number of results to return in a single call. Default is 40.</p>
+     * <p>The maximum number of results to return in a single call. Default is 1000.</p>
      * @public
      */
     MaxResults?: number | undefined;
@@ -144,7 +144,7 @@ export interface GetEstimatedCarbonEmissionsResponse {
  */
 export interface GetEstimatedCarbonEmissionsDimensionValuesRequest {
     /**
-     * <p>The date range for fetching the dimension values.</p>
+     * <p> The date range for fetching the dimension values. The range must include the start date of a month for that month's dimensions to be included in the response. </p>
      * @public
      */
     TimePeriod: TimePeriod | undefined;
@@ -154,7 +154,7 @@ export interface GetEstimatedCarbonEmissionsDimensionValuesRequest {
      */
     Dimensions: Dimension[] | undefined;
     /**
-     * <p>The maximum number of results to return in a single call. Default is 40.</p>
+     * <p>The maximum number of results to return in a single call. Default is 1000.</p>
      * @public
      */
     MaxResults?: number | undefined;
@@ -195,3 +195,140 @@ export interface GetEstimatedCarbonEmissionsDimensionValuesResponse {
      */
     NextToken?: string | undefined;
 }
+/**
+ * @public
+ */
+export interface GetEstimatedWaterAllocationRequest {
+    /**
+     * <p> The date range for fetching estimated water allocation. The range must include the start date of a year for that year's data to be included in the response. </p>
+     * @public
+     */
+    TimePeriod: TimePeriod | undefined;
+    /**
+     * <p>The dimensions available for grouping estimated water allocation.</p>
+     * @public
+     */
+    GroupBy?: Dimension[] | undefined;
+    /**
+     * <p> The criteria for filtering estimated water allocation. To determine which dimensions are available to be filtered by, you can first call <a>GetEstimatedWaterAllocationDimensionValues</a> </p>
+     * @public
+     */
+    FilterBy?: FilterExpression | undefined;
+    /**
+     * <p>The allocation types to include in the results. If absent, returns <code>TOTAL_WATER_WITHDRAWALS</code> allocation types. </p>
+     * @public
+     */
+    AllocationTypes?: WaterAllocationType[] | undefined;
+    /**
+     * <p>The time granularity for the results. Only <code>YEARLY_CALENDAR</code> time granularity is currently supported for water allocation. Defaults to <code>YEARLY_CALENDAR</code> if absent.</p> <p> If requesting partial time periods, data will be returned based on the smallest supported granularity. For example, requesting <code>2025-04-01T00:00:00Z</code> to <code>2026-04-01T00:00:00Z</code> with <code>YEARLY_CALENDAR</code> will return all the data for 2026 only. </p>
+     * @public
+     */
+    Granularity?: TimeGranularity | undefined;
+    /**
+     * <p>The maximum number of results to return in a single call. Default is 1000.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+    /**
+     * <p>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. </p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
+/**
+ * <p>Represents a water allocation quantity with its value and unit of measurement.</p>
+ * @public
+ */
+export interface WaterAllocation {
+    /**
+     * <p>The numeric value of the allocation quantity.</p>
+     * @public
+     */
+    Value: number | undefined;
+    /**
+     * <p>The unit of measurement for the allocation value.</p>
+     * @public
+     */
+    Unit: WaterAllocationUnit | undefined;
+}
+/**
+ * <p>Contains estimated water allocation data for a specific time period and dimension grouping.</p>
+ * @public
+ */
+export interface EstimatedWaterAllocation {
+    /**
+     * <p>The reporting period for water allocation values.</p>
+     * @public
+     */
+    TimePeriod: TimePeriod | undefined;
+    /**
+     * <p>The dimensions used to group water allocation values.</p>
+     * @public
+     */
+    DimensionsValues: Partial<Record<Dimension, string>> | undefined;
+    /**
+     * <p>The semantic version-formatted string that indicates the methodology version used to calculate the water allocation values. </p> <note> <p> The AWS Sustainability service reflects the most recent model version for every month. You will not see two entries for the same month with different <code>ModelVersion</code> values. </p> </note>
+     * @public
+     */
+    ModelVersion: string | undefined;
+    /**
+     * <p>The allocation values for the requested water allocation types.</p>
+     * @public
+     */
+    AllocationValues: Partial<Record<WaterAllocationType, WaterAllocation>> | undefined;
+}
+/**
+ * @public
+ */
+export interface GetEstimatedWaterAllocationResponse {
+    /**
+     * <p>The result of the requested inputs.</p>
+     * @public
+     */
+    Results: EstimatedWaterAllocation[] | undefined;
+    /**
+     * <p>The pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results. </p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetEstimatedWaterAllocationDimensionValuesRequest {
+    /**
+     * <p> The date range for fetching the dimension values. The range must include the start date of a year for that year's data to be included in the response. </p>
+     * @public
+     */
+    TimePeriod: TimePeriod | undefined;
+    /**
+     * <p>The dimensions available for grouping estimated water allocation.</p>
+     * @public
+     */
+    Dimensions: Dimension[] | undefined;
+    /**
+     * <p>The maximum number of results to return in a single call. Default is 1000.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+    /**
+     * <p>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. </p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface GetEstimatedWaterAllocationDimensionValuesResponse {
+    /**
+     * <p>The list of possible dimensions over which the allocation data is aggregated.</p>
+     * @public
+     */
+    Results: DimensionEntry[] | undefined;
+    /**
+     * <p>The pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results. </p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}

package/dist-types/pagination/GetEstimatedWaterAllocationDimensionValuesPaginator.d.ts

@@ -0,0 +1,7 @@
+import type { Paginator } from "@smithy/types";
+import { GetEstimatedWaterAllocationDimensionValuesCommandInput, GetEstimatedWaterAllocationDimensionValuesCommandOutput } from "../commands/GetEstimatedWaterAllocationDimensionValuesCommand";
+import type { SustainabilityPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateGetEstimatedWaterAllocationDimensionValues: (config: SustainabilityPaginationConfiguration, input: GetEstimatedWaterAllocationDimensionValuesCommandInput, ...rest: any[]) => Paginator<GetEstimatedWaterAllocationDimensionValuesCommandOutput>;

package/dist-types/pagination/GetEstimatedWaterAllocationPaginator.d.ts

@@ -0,0 +1,7 @@
+import type { Paginator } from "@smithy/types";
+import { GetEstimatedWaterAllocationCommandInput, GetEstimatedWaterAllocationCommandOutput } from "../commands/GetEstimatedWaterAllocationCommand";
+import type { SustainabilityPaginationConfiguration } from "./Interfaces";
+/**
+ * @public
+ */
+export declare const paginateGetEstimatedWaterAllocation: (config: SustainabilityPaginationConfiguration, input: GetEstimatedWaterAllocationCommandInput, ...rest: any[]) => Paginator<GetEstimatedWaterAllocationCommandOutput>;

package/dist-types/pagination/index.d.ts

@@ -1,3 +1,5 @@
 export * from "./Interfaces";
 export * from "./GetEstimatedCarbonEmissionsPaginator";
 export * from "./GetEstimatedCarbonEmissionsDimensionValuesPaginator";
+export * from "./GetEstimatedWaterAllocationPaginator";
+export * from "./GetEstimatedWaterAllocationDimensionValuesPaginator";

package/dist-types/schemas/schemas_0.d.ts

@@ -14,12 +14,20 @@ export declare const errorTypeRegistries: TypeRegistry[];
 export declare var DimensionEntry$: StaticStructureSchema;
 export declare var Emissions$: StaticStructureSchema;
 export declare var EstimatedCarbonEmissions$: StaticStructureSchema;
+export declare var EstimatedWaterAllocation$: StaticStructureSchema;
 export declare var FilterExpression$: StaticStructureSchema;
 export declare var GetEstimatedCarbonEmissionsDimensionValuesRequest$: StaticStructureSchema;
 export declare var GetEstimatedCarbonEmissionsDimensionValuesResponse$: StaticStructureSchema;
 export declare var GetEstimatedCarbonEmissionsRequest$: StaticStructureSchema;
 export declare var GetEstimatedCarbonEmissionsResponse$: StaticStructureSchema;
+export declare var GetEstimatedWaterAllocationDimensionValuesRequest$: StaticStructureSchema;
+export declare var GetEstimatedWaterAllocationDimensionValuesResponse$: StaticStructureSchema;
+export declare var GetEstimatedWaterAllocationRequest$: StaticStructureSchema;
+export declare var GetEstimatedWaterAllocationResponse$: StaticStructureSchema;
 export declare var GranularityConfiguration$: StaticStructureSchema;
 export declare var TimePeriod$: StaticStructureSchema;
+export declare var WaterAllocation$: StaticStructureSchema;
 export declare var GetEstimatedCarbonEmissions$: StaticOperationSchema;
 export declare var GetEstimatedCarbonEmissionsDimensionValues$: StaticOperationSchema;
+export declare var GetEstimatedWaterAllocation$: StaticOperationSchema;
+export declare var GetEstimatedWaterAllocationDimensionValues$: StaticOperationSchema;