@aws-sdk/client-sustainability 3.1087.0 → 3.1089.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/README.md +15 -1
  2. package/dist-cjs/index.js +89 -1
  3. package/dist-es/Sustainability.js +8 -0
  4. package/dist-es/commands/GetEstimatedWaterAllocationCommand.js +4 -0
  5. package/dist-es/commands/GetEstimatedWaterAllocationDimensionValuesCommand.js +4 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/enums.js +6 -0
  8. package/dist-es/pagination/GetEstimatedWaterAllocationDimensionValuesPaginator.js +4 -0
  9. package/dist-es/pagination/GetEstimatedWaterAllocationPaginator.js +4 -0
  10. package/dist-es/pagination/index.js +2 -0
  11. package/dist-es/schemas/schemas_0.js +55 -0
  12. package/dist-types/Sustainability.d.ts +29 -1
  13. package/dist-types/SustainabilityClient.d.ts +5 -3
  14. package/dist-types/commands/GetEstimatedWaterAllocationCommand.d.ts +162 -0
  15. package/dist-types/commands/GetEstimatedWaterAllocationDimensionValuesCommand.d.ts +149 -0
  16. package/dist-types/commands/index.d.ts +2 -0
  17. package/dist-types/index.d.ts +1 -1
  18. package/dist-types/models/enums.d.ts +34 -6
  19. package/dist-types/models/models_0.d.ts +146 -9
  20. package/dist-types/pagination/GetEstimatedWaterAllocationDimensionValuesPaginator.d.ts +7 -0
  21. package/dist-types/pagination/GetEstimatedWaterAllocationPaginator.d.ts +7 -0
  22. package/dist-types/pagination/index.d.ts +2 -0
  23. package/dist-types/schemas/schemas_0.d.ts +8 -0
  24. package/dist-types/ts3.4/Sustainability.d.ts +57 -17
  25. package/dist-types/ts3.4/SustainabilityClient.d.ts +20 -18
  26. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +5 -12
  27. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +12 -18
  28. package/dist-types/ts3.4/commandBuilder.d.ts +7 -13
  29. package/dist-types/ts3.4/commands/GetEstimatedCarbonEmissionsCommand.d.ts +4 -6
  30. package/dist-types/ts3.4/commands/GetEstimatedCarbonEmissionsDimensionValuesCommand.d.ts +4 -6
  31. package/dist-types/ts3.4/commands/GetEstimatedWaterAllocationCommand.d.ts +42 -0
  32. package/dist-types/ts3.4/commands/GetEstimatedWaterAllocationDimensionValuesCommand.d.ts +42 -0
  33. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  34. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
  35. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +1 -1
  36. package/dist-types/ts3.4/extensionConfiguration.d.ts +2 -1
  37. package/dist-types/ts3.4/models/enums.d.ts +9 -2
  38. package/dist-types/ts3.4/models/errors.d.ts +4 -12
  39. package/dist-types/ts3.4/models/models_0.d.ts +35 -0
  40. package/dist-types/ts3.4/pagination/GetEstimatedWaterAllocationDimensionValuesPaginator.d.ts +11 -0
  41. package/dist-types/ts3.4/pagination/GetEstimatedWaterAllocationPaginator.d.ts +11 -0
  42. package/dist-types/ts3.4/pagination/Interfaces.d.ts +1 -2
  43. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  44. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +9 -22
  45. package/dist-types/ts3.4/runtimeConfig.d.ts +9 -19
  46. package/dist-types/ts3.4/runtimeConfig.native.d.ts +9 -22
  47. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
  48. package/dist-types/ts3.4/runtimeExtensions.d.ts +1 -1
  49. package/dist-types/ts3.4/schemas/schemas_0.d.ts +9 -5
  50. package/package.json +39 -39
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  AWS SDK for JavaScript Sustainability Client for Node.js, Browser and React Native.
8
8
 
9
- <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>
9
+ <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>
10
10
 
11
11
  ## Installing
12
12
 
@@ -193,3 +193,17 @@ GetEstimatedCarbonEmissionsDimensionValues
193
193
 
194
194
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sustainability/command/GetEstimatedCarbonEmissionsDimensionValuesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sustainability/Interface/GetEstimatedCarbonEmissionsDimensionValuesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sustainability/Interface/GetEstimatedCarbonEmissionsDimensionValuesCommandOutput/)
195
195
  </details>
196
+ <details>
197
+ <summary>
198
+ GetEstimatedWaterAllocation
199
+ </summary>
200
+
201
+ [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sustainability/command/GetEstimatedWaterAllocationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sustainability/Interface/GetEstimatedWaterAllocationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sustainability/Interface/GetEstimatedWaterAllocationCommandOutput/)
202
+ </details>
203
+ <details>
204
+ <summary>
205
+ GetEstimatedWaterAllocationDimensionValues
206
+ </summary>
207
+
208
+ [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sustainability/command/GetEstimatedWaterAllocationDimensionValuesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sustainability/Interface/GetEstimatedWaterAllocationDimensionValuesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sustainability/Interface/GetEstimatedWaterAllocationDimensionValuesCommandOutput/)
209
+ </details>
package/dist-cjs/index.js CHANGED
@@ -197,7 +197,7 @@ const commonParams = {
197
197
  Region: { type: "builtInParams", name: "region" },
198
198
  };
199
199
 
200
- var version = "3.1086.0";
200
+ var version = "3.1088.0";
201
201
  var packageInfo = {
202
202
  version: version};
203
203
 
@@ -268,6 +268,8 @@ class ValidationException extends SustainabilityServiceException {
268
268
  }
269
269
 
270
270
  const _ADE = "AccessDeniedException";
271
+ const _AT = "AllocationTypes";
272
+ const _AV = "AllocationValues";
271
273
  const _D = "Dimension";
272
274
  const _DE = "DimensionEntry";
273
275
  const _DEL = "DimensionEntryList";
@@ -280,6 +282,8 @@ const _ECEL = "EstimatedCarbonEmissionsList";
280
282
  const _EM = "EmissionsMap";
281
283
  const _ET = "EmissionsTypes";
282
284
  const _EV = "EmissionsValues";
285
+ const _EWA = "EstimatedWaterAllocation";
286
+ const _EWAL = "EstimatedWaterAllocationList";
283
287
  const _En = "End";
284
288
  const _FB = "FilterBy";
285
289
  const _FE = "FilterExpression";
@@ -293,6 +297,12 @@ const _GECEDVR = "GetEstimatedCarbonEmissionsDimensionValuesRequest";
293
297
  const _GECEDVRe = "GetEstimatedCarbonEmissionsDimensionValuesResponse";
294
298
  const _GECER = "GetEstimatedCarbonEmissionsRequest";
295
299
  const _GECERe = "GetEstimatedCarbonEmissionsResponse";
300
+ const _GEWA = "GetEstimatedWaterAllocation";
301
+ const _GEWADV = "GetEstimatedWaterAllocationDimensionValues";
302
+ const _GEWADVR = "GetEstimatedWaterAllocationDimensionValuesRequest";
303
+ const _GEWADVRe = "GetEstimatedWaterAllocationDimensionValuesResponse";
304
+ const _GEWAR = "GetEstimatedWaterAllocationRequest";
305
+ const _GEWARe = "GetEstimatedWaterAllocationResponse";
296
306
  const _ISE = "InternalServerException";
297
307
  const _M = "Message";
298
308
  const _MR = "MaxResults";
@@ -305,6 +315,8 @@ const _TP = "TimePeriod";
305
315
  const _U = "Unit";
306
316
  const _V = "Value";
307
317
  const _VE = "ValidationException";
318
+ const _WA = "WaterAllocation";
319
+ const _WAM = "WaterAllocationMap";
308
320
  const _c = "client";
309
321
  const _e = "error";
310
322
  const _h = "http";
@@ -361,6 +373,11 @@ var EstimatedCarbonEmissions$ = [3, n0, _ECE,
361
373
  [_TP, _DV, _MV, _EV],
362
374
  [() => TimePeriod$, 128 | 0, 0, () => EmissionsMap], 4
363
375
  ];
376
+ var EstimatedWaterAllocation$ = [3, n0, _EWA,
377
+ 0,
378
+ [_TP, _DV, _MV, _AV],
379
+ [() => TimePeriod$, 128 | 0, 0, () => WaterAllocationMap], 4
380
+ ];
364
381
  var FilterExpression$ = [3, n0, _FE,
365
382
  0,
366
383
  [_Di],
@@ -386,6 +403,26 @@ var GetEstimatedCarbonEmissionsResponse$ = [3, n0, _GECERe,
386
403
  [_R, _NT],
387
404
  [() => EstimatedCarbonEmissionsList, 0], 1
388
405
  ];
406
+ var GetEstimatedWaterAllocationDimensionValuesRequest$ = [3, n0, _GEWADVR,
407
+ 0,
408
+ [_TP, _Di, _MR, _NT],
409
+ [() => TimePeriod$, 64 | 0, 1, 0], 2
410
+ ];
411
+ var GetEstimatedWaterAllocationDimensionValuesResponse$ = [3, n0, _GEWADVRe,
412
+ 0,
413
+ [_R, _NT],
414
+ [() => DimensionEntryList, 0], 1
415
+ ];
416
+ var GetEstimatedWaterAllocationRequest$ = [3, n0, _GEWAR,
417
+ 0,
418
+ [_TP, _GB, _FB, _AT, _G, _MR, _NT],
419
+ [() => TimePeriod$, 64 | 0, () => FilterExpression$, 64 | 0, 0, 1, 0], 1
420
+ ];
421
+ var GetEstimatedWaterAllocationResponse$ = [3, n0, _GEWARe,
422
+ 0,
423
+ [_R, _NT],
424
+ [() => EstimatedWaterAllocationList, 0], 1
425
+ ];
389
426
  var GranularityConfiguration$ = [3, n0, _GC,
390
427
  0,
391
428
  [_FYSM],
@@ -396,21 +433,38 @@ var TimePeriod$ = [3, n0, _TP,
396
433
  [_S, _En],
397
434
  [5, 5], 2
398
435
  ];
436
+ var WaterAllocation$ = [3, n0, _WA,
437
+ 0,
438
+ [_V, _U],
439
+ [1, 0], 2
440
+ ];
399
441
  var DimensionEntryList = [1, n0, _DEL,
400
442
  0, () => DimensionEntry$
401
443
  ];
402
444
  var EstimatedCarbonEmissionsList = [1, n0, _ECEL,
403
445
  0, () => EstimatedCarbonEmissions$
404
446
  ];
447
+ var EstimatedWaterAllocationList = [1, n0, _EWAL,
448
+ 0, () => EstimatedWaterAllocation$
449
+ ];
405
450
  var EmissionsMap = [2, n0, _EM,
406
451
  0, 0, () => Emissions$
407
452
  ];
453
+ var WaterAllocationMap = [2, n0, _WAM,
454
+ 0, 0, () => WaterAllocation$
455
+ ];
408
456
  var GetEstimatedCarbonEmissions$ = [9, n0, _GECE,
409
457
  { [_h]: ["POST", "/v1/estimated-carbon-emissions", 200] }, () => GetEstimatedCarbonEmissionsRequest$, () => GetEstimatedCarbonEmissionsResponse$
410
458
  ];
411
459
  var GetEstimatedCarbonEmissionsDimensionValues$ = [9, n0, _GECEDV,
412
460
  { [_h]: ["POST", "/v1/estimated-carbon-emissions-dimension-values", 200] }, () => GetEstimatedCarbonEmissionsDimensionValuesRequest$, () => GetEstimatedCarbonEmissionsDimensionValuesResponse$
413
461
  ];
462
+ var GetEstimatedWaterAllocation$ = [9, n0, _GEWA,
463
+ { [_h]: ["POST", "/v1/estimated-water-allocation", 200] }, () => GetEstimatedWaterAllocationRequest$, () => GetEstimatedWaterAllocationResponse$
464
+ ];
465
+ var GetEstimatedWaterAllocationDimensionValues$ = [9, n0, _GEWADV,
466
+ { [_h]: ["POST", "/v1/estimated-water-allocation-dimension-values", 200] }, () => GetEstimatedWaterAllocationDimensionValuesRequest$, () => GetEstimatedWaterAllocationDimensionValuesResponse$
467
+ ];
414
468
 
415
469
  const getRuntimeConfig$1 = (config) => {
416
470
  return {
@@ -576,17 +630,31 @@ class GetEstimatedCarbonEmissionsCommand extends command(_ep0, _mw0, "GetEstimat
576
630
  class GetEstimatedCarbonEmissionsDimensionValuesCommand extends command(_ep0, _mw0, "GetEstimatedCarbonEmissionsDimensionValues", GetEstimatedCarbonEmissionsDimensionValues$) {
577
631
  }
578
632
 
633
+ class GetEstimatedWaterAllocationCommand extends command(_ep0, _mw0, "GetEstimatedWaterAllocation", GetEstimatedWaterAllocation$) {
634
+ }
635
+
636
+ class GetEstimatedWaterAllocationDimensionValuesCommand extends command(_ep0, _mw0, "GetEstimatedWaterAllocationDimensionValues", GetEstimatedWaterAllocationDimensionValues$) {
637
+ }
638
+
579
639
  const paginateGetEstimatedCarbonEmissionsDimensionValues = createPaginator(SustainabilityClient, GetEstimatedCarbonEmissionsDimensionValuesCommand, "NextToken", "NextToken", "MaxResults");
580
640
 
581
641
  const paginateGetEstimatedCarbonEmissions = createPaginator(SustainabilityClient, GetEstimatedCarbonEmissionsCommand, "NextToken", "NextToken", "MaxResults");
582
642
 
643
+ const paginateGetEstimatedWaterAllocationDimensionValues = createPaginator(SustainabilityClient, GetEstimatedWaterAllocationDimensionValuesCommand, "NextToken", "NextToken", "MaxResults");
644
+
645
+ const paginateGetEstimatedWaterAllocation = createPaginator(SustainabilityClient, GetEstimatedWaterAllocationCommand, "NextToken", "NextToken", "MaxResults");
646
+
583
647
  const commands = {
584
648
  GetEstimatedCarbonEmissionsCommand,
585
649
  GetEstimatedCarbonEmissionsDimensionValuesCommand,
650
+ GetEstimatedWaterAllocationCommand,
651
+ GetEstimatedWaterAllocationDimensionValuesCommand,
586
652
  };
587
653
  const paginators = {
588
654
  paginateGetEstimatedCarbonEmissions,
589
655
  paginateGetEstimatedCarbonEmissionsDimensionValues,
656
+ paginateGetEstimatedWaterAllocation,
657
+ paginateGetEstimatedWaterAllocationDimensionValues,
590
658
  };
591
659
  class Sustainability extends SustainabilityClient {
592
660
  }
@@ -616,6 +684,12 @@ const TimeGranularity = {
616
684
  const EmissionsUnit = {
617
685
  MT_CO2E: "MTCO2e",
618
686
  };
687
+ const WaterAllocationType = {
688
+ TOTAL_WATER_WITHDRAWALS: "TOTAL_WATER_WITHDRAWALS",
689
+ };
690
+ const WaterAllocationUnit = {
691
+ CUBIC_METERS: "m3",
692
+ };
619
693
 
620
694
  exports.AccessDeniedException = AccessDeniedException;
621
695
  exports.AccessDeniedException$ = AccessDeniedException$;
@@ -625,6 +699,7 @@ exports.Emissions$ = Emissions$;
625
699
  exports.EmissionsType = EmissionsType;
626
700
  exports.EmissionsUnit = EmissionsUnit;
627
701
  exports.EstimatedCarbonEmissions$ = EstimatedCarbonEmissions$;
702
+ exports.EstimatedWaterAllocation$ = EstimatedWaterAllocation$;
628
703
  exports.FilterExpression$ = FilterExpression$;
629
704
  exports.GetEstimatedCarbonEmissions$ = GetEstimatedCarbonEmissions$;
630
705
  exports.GetEstimatedCarbonEmissionsCommand = GetEstimatedCarbonEmissionsCommand;
@@ -634,6 +709,14 @@ exports.GetEstimatedCarbonEmissionsDimensionValuesRequest$ = GetEstimatedCarbonE
634
709
  exports.GetEstimatedCarbonEmissionsDimensionValuesResponse$ = GetEstimatedCarbonEmissionsDimensionValuesResponse$;
635
710
  exports.GetEstimatedCarbonEmissionsRequest$ = GetEstimatedCarbonEmissionsRequest$;
636
711
  exports.GetEstimatedCarbonEmissionsResponse$ = GetEstimatedCarbonEmissionsResponse$;
712
+ exports.GetEstimatedWaterAllocation$ = GetEstimatedWaterAllocation$;
713
+ exports.GetEstimatedWaterAllocationCommand = GetEstimatedWaterAllocationCommand;
714
+ exports.GetEstimatedWaterAllocationDimensionValues$ = GetEstimatedWaterAllocationDimensionValues$;
715
+ exports.GetEstimatedWaterAllocationDimensionValuesCommand = GetEstimatedWaterAllocationDimensionValuesCommand;
716
+ exports.GetEstimatedWaterAllocationDimensionValuesRequest$ = GetEstimatedWaterAllocationDimensionValuesRequest$;
717
+ exports.GetEstimatedWaterAllocationDimensionValuesResponse$ = GetEstimatedWaterAllocationDimensionValuesResponse$;
718
+ exports.GetEstimatedWaterAllocationRequest$ = GetEstimatedWaterAllocationRequest$;
719
+ exports.GetEstimatedWaterAllocationResponse$ = GetEstimatedWaterAllocationResponse$;
637
720
  exports.GranularityConfiguration$ = GranularityConfiguration$;
638
721
  exports.InternalServerException = InternalServerException;
639
722
  exports.InternalServerException$ = InternalServerException$;
@@ -647,6 +730,11 @@ exports.TimeGranularity = TimeGranularity;
647
730
  exports.TimePeriod$ = TimePeriod$;
648
731
  exports.ValidationException = ValidationException;
649
732
  exports.ValidationException$ = ValidationException$;
733
+ exports.WaterAllocation$ = WaterAllocation$;
734
+ exports.WaterAllocationType = WaterAllocationType;
735
+ exports.WaterAllocationUnit = WaterAllocationUnit;
650
736
  exports.errorTypeRegistries = errorTypeRegistries;
651
737
  exports.paginateGetEstimatedCarbonEmissions = paginateGetEstimatedCarbonEmissions;
652
738
  exports.paginateGetEstimatedCarbonEmissionsDimensionValues = paginateGetEstimatedCarbonEmissionsDimensionValues;
739
+ exports.paginateGetEstimatedWaterAllocation = paginateGetEstimatedWaterAllocation;
740
+ exports.paginateGetEstimatedWaterAllocationDimensionValues = paginateGetEstimatedWaterAllocationDimensionValues;
@@ -1,16 +1,24 @@
1
1
  import { createAggregatedClient } from "@smithy/core/client";
2
2
  import { GetEstimatedCarbonEmissionsCommand, } from "./commands/GetEstimatedCarbonEmissionsCommand";
3
3
  import { GetEstimatedCarbonEmissionsDimensionValuesCommand, } from "./commands/GetEstimatedCarbonEmissionsDimensionValuesCommand";
4
+ import { GetEstimatedWaterAllocationCommand, } from "./commands/GetEstimatedWaterAllocationCommand";
5
+ import { GetEstimatedWaterAllocationDimensionValuesCommand, } from "./commands/GetEstimatedWaterAllocationDimensionValuesCommand";
4
6
  import { paginateGetEstimatedCarbonEmissionsDimensionValues, } from "./pagination/GetEstimatedCarbonEmissionsDimensionValuesPaginator";
5
7
  import { paginateGetEstimatedCarbonEmissions } from "./pagination/GetEstimatedCarbonEmissionsPaginator";
8
+ import { paginateGetEstimatedWaterAllocationDimensionValues, } from "./pagination/GetEstimatedWaterAllocationDimensionValuesPaginator";
9
+ import { paginateGetEstimatedWaterAllocation } from "./pagination/GetEstimatedWaterAllocationPaginator";
6
10
  import { SustainabilityClient } from "./SustainabilityClient";
7
11
  const commands = {
8
12
  GetEstimatedCarbonEmissionsCommand,
9
13
  GetEstimatedCarbonEmissionsDimensionValuesCommand,
14
+ GetEstimatedWaterAllocationCommand,
15
+ GetEstimatedWaterAllocationDimensionValuesCommand,
10
16
  };
11
17
  const paginators = {
12
18
  paginateGetEstimatedCarbonEmissions,
13
19
  paginateGetEstimatedCarbonEmissionsDimensionValues,
20
+ paginateGetEstimatedWaterAllocation,
21
+ paginateGetEstimatedWaterAllocationDimensionValues,
14
22
  };
15
23
  export class Sustainability extends SustainabilityClient {
16
24
  }
@@ -0,0 +1,4 @@
1
+ import { _ep0, _mw0, command } from "../commandBuilder";
2
+ import { GetEstimatedWaterAllocation$ } from "../schemas/schemas_0";
3
+ export class GetEstimatedWaterAllocationCommand extends command(_ep0, _mw0, "GetEstimatedWaterAllocation", GetEstimatedWaterAllocation$) {
4
+ }
@@ -0,0 +1,4 @@
1
+ import { _ep0, _mw0, command } from "../commandBuilder";
2
+ import { GetEstimatedWaterAllocationDimensionValues$ } from "../schemas/schemas_0";
3
+ export class GetEstimatedWaterAllocationDimensionValuesCommand extends command(_ep0, _mw0, "GetEstimatedWaterAllocationDimensionValues", GetEstimatedWaterAllocationDimensionValues$) {
4
+ }
@@ -1,2 +1,4 @@
1
1
  export * from "./GetEstimatedCarbonEmissionsCommand";
2
2
  export * from "./GetEstimatedCarbonEmissionsDimensionValuesCommand";
3
+ export * from "./GetEstimatedWaterAllocationCommand";
4
+ export * from "./GetEstimatedWaterAllocationDimensionValuesCommand";
@@ -22,3 +22,9 @@ export const TimeGranularity = {
22
22
  export const EmissionsUnit = {
23
23
  MT_CO2E: "MTCO2e",
24
24
  };
25
+ export const WaterAllocationType = {
26
+ TOTAL_WATER_WITHDRAWALS: "TOTAL_WATER_WITHDRAWALS",
27
+ };
28
+ export const WaterAllocationUnit = {
29
+ CUBIC_METERS: "m3",
30
+ };
@@ -0,0 +1,4 @@
1
+ import { createPaginator } from "@smithy/core";
2
+ import { GetEstimatedWaterAllocationDimensionValuesCommand, } from "../commands/GetEstimatedWaterAllocationDimensionValuesCommand";
3
+ import { SustainabilityClient } from "../SustainabilityClient";
4
+ export const paginateGetEstimatedWaterAllocationDimensionValues = createPaginator(SustainabilityClient, GetEstimatedWaterAllocationDimensionValuesCommand, "NextToken", "NextToken", "MaxResults");
@@ -0,0 +1,4 @@
1
+ import { createPaginator } from "@smithy/core";
2
+ import { GetEstimatedWaterAllocationCommand, } from "../commands/GetEstimatedWaterAllocationCommand";
3
+ import { SustainabilityClient } from "../SustainabilityClient";
4
+ export const paginateGetEstimatedWaterAllocation = createPaginator(SustainabilityClient, GetEstimatedWaterAllocationCommand, "NextToken", "NextToken", "MaxResults");
@@ -1,3 +1,5 @@
1
1
  export * from "./Interfaces";
2
2
  export * from "./GetEstimatedCarbonEmissionsPaginator";
3
3
  export * from "./GetEstimatedCarbonEmissionsDimensionValuesPaginator";
4
+ export * from "./GetEstimatedWaterAllocationPaginator";
5
+ export * from "./GetEstimatedWaterAllocationDimensionValuesPaginator";
@@ -1,4 +1,6 @@
1
1
  const _ADE = "AccessDeniedException";
2
+ const _AT = "AllocationTypes";
3
+ const _AV = "AllocationValues";
2
4
  const _D = "Dimension";
3
5
  const _DE = "DimensionEntry";
4
6
  const _DEL = "DimensionEntryList";
@@ -11,6 +13,8 @@ const _ECEL = "EstimatedCarbonEmissionsList";
11
13
  const _EM = "EmissionsMap";
12
14
  const _ET = "EmissionsTypes";
13
15
  const _EV = "EmissionsValues";
16
+ const _EWA = "EstimatedWaterAllocation";
17
+ const _EWAL = "EstimatedWaterAllocationList";
14
18
  const _En = "End";
15
19
  const _FB = "FilterBy";
16
20
  const _FE = "FilterExpression";
@@ -24,6 +28,12 @@ const _GECEDVR = "GetEstimatedCarbonEmissionsDimensionValuesRequest";
24
28
  const _GECEDVRe = "GetEstimatedCarbonEmissionsDimensionValuesResponse";
25
29
  const _GECER = "GetEstimatedCarbonEmissionsRequest";
26
30
  const _GECERe = "GetEstimatedCarbonEmissionsResponse";
31
+ const _GEWA = "GetEstimatedWaterAllocation";
32
+ const _GEWADV = "GetEstimatedWaterAllocationDimensionValues";
33
+ const _GEWADVR = "GetEstimatedWaterAllocationDimensionValuesRequest";
34
+ const _GEWADVRe = "GetEstimatedWaterAllocationDimensionValuesResponse";
35
+ const _GEWAR = "GetEstimatedWaterAllocationRequest";
36
+ const _GEWARe = "GetEstimatedWaterAllocationResponse";
27
37
  const _ISE = "InternalServerException";
28
38
  const _M = "Message";
29
39
  const _MR = "MaxResults";
@@ -36,6 +46,8 @@ const _TP = "TimePeriod";
36
46
  const _U = "Unit";
37
47
  const _V = "Value";
38
48
  const _VE = "ValidationException";
49
+ const _WA = "WaterAllocation";
50
+ const _WAM = "WaterAllocationMap";
39
51
  const _c = "client";
40
52
  const _e = "error";
41
53
  const _h = "http";
@@ -95,6 +107,11 @@ export var EstimatedCarbonEmissions$ = [3, n0, _ECE,
95
107
  [_TP, _DV, _MV, _EV],
96
108
  [() => TimePeriod$, 128 | 0, 0, () => EmissionsMap], 4
97
109
  ];
110
+ export var EstimatedWaterAllocation$ = [3, n0, _EWA,
111
+ 0,
112
+ [_TP, _DV, _MV, _AV],
113
+ [() => TimePeriod$, 128 | 0, 0, () => WaterAllocationMap], 4
114
+ ];
98
115
  export var FilterExpression$ = [3, n0, _FE,
99
116
  0,
100
117
  [_Di],
@@ -120,6 +137,26 @@ export var GetEstimatedCarbonEmissionsResponse$ = [3, n0, _GECERe,
120
137
  [_R, _NT],
121
138
  [() => EstimatedCarbonEmissionsList, 0], 1
122
139
  ];
140
+ export var GetEstimatedWaterAllocationDimensionValuesRequest$ = [3, n0, _GEWADVR,
141
+ 0,
142
+ [_TP, _Di, _MR, _NT],
143
+ [() => TimePeriod$, 64 | 0, 1, 0], 2
144
+ ];
145
+ export var GetEstimatedWaterAllocationDimensionValuesResponse$ = [3, n0, _GEWADVRe,
146
+ 0,
147
+ [_R, _NT],
148
+ [() => DimensionEntryList, 0], 1
149
+ ];
150
+ export var GetEstimatedWaterAllocationRequest$ = [3, n0, _GEWAR,
151
+ 0,
152
+ [_TP, _GB, _FB, _AT, _G, _MR, _NT],
153
+ [() => TimePeriod$, 64 | 0, () => FilterExpression$, 64 | 0, 0, 1, 0], 1
154
+ ];
155
+ export var GetEstimatedWaterAllocationResponse$ = [3, n0, _GEWARe,
156
+ 0,
157
+ [_R, _NT],
158
+ [() => EstimatedWaterAllocationList, 0], 1
159
+ ];
123
160
  export var GranularityConfiguration$ = [3, n0, _GC,
124
161
  0,
125
162
  [_FYSM],
@@ -130,6 +167,11 @@ export var TimePeriod$ = [3, n0, _TP,
130
167
  [_S, _En],
131
168
  [5, 5], 2
132
169
  ];
170
+ export var WaterAllocation$ = [3, n0, _WA,
171
+ 0,
172
+ [_V, _U],
173
+ [1, 0], 2
174
+ ];
133
175
  var DimensionEntryList = [1, n0, _DEL,
134
176
  0, () => DimensionEntry$
135
177
  ];
@@ -139,6 +181,10 @@ var EmissionsTypeList = 64 | 0;
139
181
  var EstimatedCarbonEmissionsList = [1, n0, _ECEL,
140
182
  0, () => EstimatedCarbonEmissions$
141
183
  ];
184
+ var EstimatedWaterAllocationList = [1, n0, _EWAL,
185
+ 0, () => EstimatedWaterAllocation$
186
+ ];
187
+ var WaterAllocationTypeList = 64 | 0;
142
188
  var DimensionListMap = [2, n0, _DLM,
143
189
  0, 0, 64 | 0
144
190
  ];
@@ -146,9 +192,18 @@ var DimensionsMap = 128 | 0;
146
192
  var EmissionsMap = [2, n0, _EM,
147
193
  0, 0, () => Emissions$
148
194
  ];
195
+ var WaterAllocationMap = [2, n0, _WAM,
196
+ 0, 0, () => WaterAllocation$
197
+ ];
149
198
  export var GetEstimatedCarbonEmissions$ = [9, n0, _GECE,
150
199
  { [_h]: ["POST", "/v1/estimated-carbon-emissions", 200] }, () => GetEstimatedCarbonEmissionsRequest$, () => GetEstimatedCarbonEmissionsResponse$
151
200
  ];
152
201
  export var GetEstimatedCarbonEmissionsDimensionValues$ = [9, n0, _GECEDV,
153
202
  { [_h]: ["POST", "/v1/estimated-carbon-emissions-dimension-values", 200] }, () => GetEstimatedCarbonEmissionsDimensionValuesRequest$, () => GetEstimatedCarbonEmissionsDimensionValuesResponse$
154
203
  ];
204
+ export var GetEstimatedWaterAllocation$ = [9, n0, _GEWA,
205
+ { [_h]: ["POST", "/v1/estimated-water-allocation", 200] }, () => GetEstimatedWaterAllocationRequest$, () => GetEstimatedWaterAllocationResponse$
206
+ ];
207
+ export var GetEstimatedWaterAllocationDimensionValues$ = [9, n0, _GEWADV,
208
+ { [_h]: ["POST", "/v1/estimated-water-allocation-dimension-values", 200] }, () => GetEstimatedWaterAllocationDimensionValuesRequest$, () => GetEstimatedWaterAllocationDimensionValuesResponse$
209
+ ];
@@ -1,6 +1,8 @@
1
1
  import type { HttpHandlerOptions as __HttpHandlerOptions, PaginationConfiguration, Paginator } from "@smithy/types";
2
2
  import { type GetEstimatedCarbonEmissionsCommandInput, type GetEstimatedCarbonEmissionsCommandOutput } from "./commands/GetEstimatedCarbonEmissionsCommand";
3
3
  import { type GetEstimatedCarbonEmissionsDimensionValuesCommandInput, type GetEstimatedCarbonEmissionsDimensionValuesCommandOutput } from "./commands/GetEstimatedCarbonEmissionsDimensionValuesCommand";
4
+ import { type GetEstimatedWaterAllocationCommandInput, type GetEstimatedWaterAllocationCommandOutput } from "./commands/GetEstimatedWaterAllocationCommand";
5
+ import { type GetEstimatedWaterAllocationDimensionValuesCommandInput, type GetEstimatedWaterAllocationDimensionValuesCommandOutput } from "./commands/GetEstimatedWaterAllocationDimensionValuesCommand";
4
6
  import { SustainabilityClient } from "./SustainabilityClient";
5
7
  export interface Sustainability {
6
8
  /**
@@ -15,6 +17,18 @@ export interface Sustainability {
15
17
  getEstimatedCarbonEmissionsDimensionValues(args: GetEstimatedCarbonEmissionsDimensionValuesCommandInput, options?: __HttpHandlerOptions): Promise<GetEstimatedCarbonEmissionsDimensionValuesCommandOutput>;
16
18
  getEstimatedCarbonEmissionsDimensionValues(args: GetEstimatedCarbonEmissionsDimensionValuesCommandInput, cb: (err: any, data?: GetEstimatedCarbonEmissionsDimensionValuesCommandOutput) => void): void;
17
19
  getEstimatedCarbonEmissionsDimensionValues(args: GetEstimatedCarbonEmissionsDimensionValuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEstimatedCarbonEmissionsDimensionValuesCommandOutput) => void): void;
20
+ /**
21
+ * @see {@link GetEstimatedWaterAllocationCommand}
22
+ */
23
+ getEstimatedWaterAllocation(args: GetEstimatedWaterAllocationCommandInput, options?: __HttpHandlerOptions): Promise<GetEstimatedWaterAllocationCommandOutput>;
24
+ getEstimatedWaterAllocation(args: GetEstimatedWaterAllocationCommandInput, cb: (err: any, data?: GetEstimatedWaterAllocationCommandOutput) => void): void;
25
+ getEstimatedWaterAllocation(args: GetEstimatedWaterAllocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEstimatedWaterAllocationCommandOutput) => void): void;
26
+ /**
27
+ * @see {@link GetEstimatedWaterAllocationDimensionValuesCommand}
28
+ */
29
+ getEstimatedWaterAllocationDimensionValues(args: GetEstimatedWaterAllocationDimensionValuesCommandInput, options?: __HttpHandlerOptions): Promise<GetEstimatedWaterAllocationDimensionValuesCommandOutput>;
30
+ getEstimatedWaterAllocationDimensionValues(args: GetEstimatedWaterAllocationDimensionValuesCommandInput, cb: (err: any, data?: GetEstimatedWaterAllocationDimensionValuesCommandOutput) => void): void;
31
+ getEstimatedWaterAllocationDimensionValues(args: GetEstimatedWaterAllocationDimensionValuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetEstimatedWaterAllocationDimensionValuesCommandOutput) => void): void;
18
32
  /**
19
33
  * @see {@link GetEstimatedCarbonEmissionsCommand}
20
34
  * @param args - command input.
@@ -29,9 +43,23 @@ export interface Sustainability {
29
43
  * @returns AsyncIterable of {@link GetEstimatedCarbonEmissionsDimensionValuesCommandOutput}.
30
44
  */
31
45
  paginateGetEstimatedCarbonEmissionsDimensionValues(args: GetEstimatedCarbonEmissionsDimensionValuesCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<GetEstimatedCarbonEmissionsDimensionValuesCommandOutput>;
46
+ /**
47
+ * @see {@link GetEstimatedWaterAllocationCommand}
48
+ * @param args - command input.
49
+ * @param paginationConfig - optional pagination config.
50
+ * @returns AsyncIterable of {@link GetEstimatedWaterAllocationCommandOutput}.
51
+ */
52
+ paginateGetEstimatedWaterAllocation(args: GetEstimatedWaterAllocationCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<GetEstimatedWaterAllocationCommandOutput>;
53
+ /**
54
+ * @see {@link GetEstimatedWaterAllocationDimensionValuesCommand}
55
+ * @param args - command input.
56
+ * @param paginationConfig - optional pagination config.
57
+ * @returns AsyncIterable of {@link GetEstimatedWaterAllocationDimensionValuesCommandOutput}.
58
+ */
59
+ paginateGetEstimatedWaterAllocationDimensionValues(args: GetEstimatedWaterAllocationDimensionValuesCommandInput, paginationConfig?: Omit<PaginationConfiguration, "client">): Paginator<GetEstimatedWaterAllocationDimensionValuesCommandOutput>;
32
60
  }
33
61
  /**
34
- * <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>
62
+ * <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>
35
63
  * @public
36
64
  */
37
65
  export declare class Sustainability extends SustainabilityClient implements Sustainability {
@@ -8,17 +8,19 @@ import type { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengt
8
8
  import { type HttpAuthSchemeInputConfig, type HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
9
9
  import type { GetEstimatedCarbonEmissionsCommandInput, GetEstimatedCarbonEmissionsCommandOutput } from "./commands/GetEstimatedCarbonEmissionsCommand";
10
10
  import type { GetEstimatedCarbonEmissionsDimensionValuesCommandInput, GetEstimatedCarbonEmissionsDimensionValuesCommandOutput } from "./commands/GetEstimatedCarbonEmissionsDimensionValuesCommand";
11
+ import type { GetEstimatedWaterAllocationCommandInput, GetEstimatedWaterAllocationCommandOutput } from "./commands/GetEstimatedWaterAllocationCommand";
12
+ import type { GetEstimatedWaterAllocationDimensionValuesCommandInput, GetEstimatedWaterAllocationDimensionValuesCommandOutput } from "./commands/GetEstimatedWaterAllocationDimensionValuesCommand";
11
13
  import { type ClientInputEndpointParameters, type ClientResolvedEndpointParameters, type EndpointParameters } from "./endpoint/EndpointParameters";
12
14
  import { type RuntimeExtension, type RuntimeExtensionsConfig } from "./runtimeExtensions";
13
15
  export { __Client };
14
16
  /**
15
17
  * @public
16
18
  */
17
- export type ServiceInputTypes = GetEstimatedCarbonEmissionsCommandInput | GetEstimatedCarbonEmissionsDimensionValuesCommandInput;
19
+ export type ServiceInputTypes = GetEstimatedCarbonEmissionsCommandInput | GetEstimatedCarbonEmissionsDimensionValuesCommandInput | GetEstimatedWaterAllocationCommandInput | GetEstimatedWaterAllocationDimensionValuesCommandInput;
18
20
  /**
19
21
  * @public
20
22
  */
21
- export type ServiceOutputTypes = GetEstimatedCarbonEmissionsCommandOutput | GetEstimatedCarbonEmissionsDimensionValuesCommandOutput;
23
+ export type ServiceOutputTypes = GetEstimatedCarbonEmissionsCommandOutput | GetEstimatedCarbonEmissionsDimensionValuesCommandOutput | GetEstimatedWaterAllocationCommandOutput | GetEstimatedWaterAllocationDimensionValuesCommandOutput;
22
24
  /**
23
25
  * @public
24
26
  */
@@ -170,7 +172,7 @@ export type SustainabilityClientResolvedConfigType = __SmithyResolvedConfigurati
170
172
  export interface SustainabilityClientResolvedConfig extends SustainabilityClientResolvedConfigType {
171
173
  }
172
174
  /**
173
- * <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>
175
+ * <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>
174
176
  * @public
175
177
  */
176
178
  export declare class SustainabilityClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, SustainabilityClientResolvedConfig> {