@aws-sdk/client-sustainability 3.1021.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 (92) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +195 -0
  3. package/dist-cjs/auth/httpAuthSchemeProvider.js +126 -0
  4. package/dist-cjs/endpoint/endpointResolver.js +18 -0
  5. package/dist-cjs/endpoint/ruleset.js +7 -0
  6. package/dist-cjs/index.js +212 -0
  7. package/dist-cjs/models/SustainabilityServiceException.js +12 -0
  8. package/dist-cjs/models/errors.js +66 -0
  9. package/dist-cjs/runtimeConfig.browser.js +38 -0
  10. package/dist-cjs/runtimeConfig.js +55 -0
  11. package/dist-cjs/runtimeConfig.native.js +15 -0
  12. package/dist-cjs/runtimeConfig.shared.js +50 -0
  13. package/dist-cjs/schemas/schemas_0.js +157 -0
  14. package/dist-es/Sustainability.js +17 -0
  15. package/dist-es/SustainabilityClient.js +51 -0
  16. package/dist-es/auth/httpAuthExtensionConfiguration.js +38 -0
  17. package/dist-es/auth/httpAuthSchemeProvider.js +122 -0
  18. package/dist-es/commands/GetEstimatedCarbonEmissionsCommand.js +16 -0
  19. package/dist-es/commands/GetEstimatedCarbonEmissionsDimensionValuesCommand.js +16 -0
  20. package/dist-es/commands/index.js +2 -0
  21. package/dist-es/endpoint/EndpointParameters.js +11 -0
  22. package/dist-es/endpoint/endpointResolver.js +14 -0
  23. package/dist-es/endpoint/ruleset.js +4 -0
  24. package/dist-es/extensionConfiguration.js +1 -0
  25. package/dist-es/index.js +9 -0
  26. package/dist-es/models/SustainabilityServiceException.js +8 -0
  27. package/dist-es/models/enums.js +24 -0
  28. package/dist-es/models/errors.js +59 -0
  29. package/dist-es/models/models_0.js +1 -0
  30. package/dist-es/pagination/GetEstimatedCarbonEmissionsDimensionValuesPaginator.js +4 -0
  31. package/dist-es/pagination/GetEstimatedCarbonEmissionsPaginator.js +4 -0
  32. package/dist-es/pagination/Interfaces.js +1 -0
  33. package/dist-es/pagination/index.js +3 -0
  34. package/dist-es/runtimeConfig.browser.js +33 -0
  35. package/dist-es/runtimeConfig.js +50 -0
  36. package/dist-es/runtimeConfig.native.js +11 -0
  37. package/dist-es/runtimeConfig.shared.js +46 -0
  38. package/dist-es/runtimeExtensions.js +9 -0
  39. package/dist-es/schemas/schemas_0.js +154 -0
  40. package/dist-types/Sustainability.d.ts +38 -0
  41. package/dist-types/SustainabilityClient.d.ts +189 -0
  42. package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +29 -0
  43. package/dist-types/auth/httpAuthSchemeProvider.d.ts +83 -0
  44. package/dist-types/commands/GetEstimatedCarbonEmissionsCommand.d.ts +198 -0
  45. package/dist-types/commands/GetEstimatedCarbonEmissionsDimensionValuesCommand.d.ts +152 -0
  46. package/dist-types/commands/index.d.ts +2 -0
  47. package/dist-types/endpoint/EndpointParameters.d.ts +44 -0
  48. package/dist-types/endpoint/endpointResolver.d.ts +8 -0
  49. package/dist-types/endpoint/ruleset.d.ts +2 -0
  50. package/dist-types/extensionConfiguration.d.ts +9 -0
  51. package/dist-types/index.d.ts +17 -0
  52. package/dist-types/models/SustainabilityServiceException.d.ts +14 -0
  53. package/dist-types/models/enums.d.ts +104 -0
  54. package/dist-types/models/errors.d.ts +56 -0
  55. package/dist-types/models/models_0.d.ts +197 -0
  56. package/dist-types/pagination/GetEstimatedCarbonEmissionsDimensionValuesPaginator.d.ts +7 -0
  57. package/dist-types/pagination/GetEstimatedCarbonEmissionsPaginator.d.ts +7 -0
  58. package/dist-types/pagination/Interfaces.d.ts +8 -0
  59. package/dist-types/pagination/index.d.ts +3 -0
  60. package/dist-types/runtimeConfig.browser.d.ts +56 -0
  61. package/dist-types/runtimeConfig.d.ts +56 -0
  62. package/dist-types/runtimeConfig.native.d.ts +55 -0
  63. package/dist-types/runtimeConfig.shared.d.ts +29 -0
  64. package/dist-types/runtimeExtensions.d.ts +17 -0
  65. package/dist-types/schemas/schemas_0.d.ts +25 -0
  66. package/dist-types/ts3.4/Sustainability.d.ts +65 -0
  67. package/dist-types/ts3.4/SustainabilityClient.d.ts +131 -0
  68. package/dist-types/ts3.4/auth/httpAuthExtensionConfiguration.d.ts +32 -0
  69. package/dist-types/ts3.4/auth/httpAuthSchemeProvider.d.ts +59 -0
  70. package/dist-types/ts3.4/commands/GetEstimatedCarbonEmissionsCommand.d.ts +51 -0
  71. package/dist-types/ts3.4/commands/GetEstimatedCarbonEmissionsDimensionValuesCommand.d.ts +51 -0
  72. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  73. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +45 -0
  74. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  75. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  76. package/dist-types/ts3.4/extensionConfiguration.d.ts +9 -0
  77. package/dist-types/ts3.4/index.d.ts +12 -0
  78. package/dist-types/ts3.4/models/SustainabilityServiceException.d.ts +9 -0
  79. package/dist-types/ts3.4/models/enums.d.ts +29 -0
  80. package/dist-types/ts3.4/models/errors.d.ts +36 -0
  81. package/dist-types/ts3.4/models/models_0.d.ts +54 -0
  82. package/dist-types/ts3.4/pagination/GetEstimatedCarbonEmissionsDimensionValuesPaginator.d.ts +11 -0
  83. package/dist-types/ts3.4/pagination/GetEstimatedCarbonEmissionsPaginator.d.ts +11 -0
  84. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  85. package/dist-types/ts3.4/pagination/index.d.ts +3 -0
  86. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +106 -0
  87. package/dist-types/ts3.4/runtimeConfig.d.ts +100 -0
  88. package/dist-types/ts3.4/runtimeConfig.native.d.ts +110 -0
  89. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +37 -0
  90. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  91. package/dist-types/ts3.4/schemas/schemas_0.d.ts +24 -0
  92. package/package.json +101 -0
@@ -0,0 +1,198 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { GetEstimatedCarbonEmissionsRequest, GetEstimatedCarbonEmissionsResponse } from "../models/models_0";
4
+ import type { ServiceInputTypes, ServiceOutputTypes, SustainabilityClientResolvedConfig } from "../SustainabilityClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetEstimatedCarbonEmissionsCommand}.
14
+ */
15
+ export interface GetEstimatedCarbonEmissionsCommandInput extends GetEstimatedCarbonEmissionsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetEstimatedCarbonEmissionsCommand}.
21
+ */
22
+ export interface GetEstimatedCarbonEmissionsCommandOutput extends GetEstimatedCarbonEmissionsResponse, __MetadataBearer {
23
+ }
24
+ declare const GetEstimatedCarbonEmissionsCommand_base: {
25
+ new (input: GetEstimatedCarbonEmissionsCommandInput): import("@smithy/smithy-client").CommandImpl<GetEstimatedCarbonEmissionsCommandInput, GetEstimatedCarbonEmissionsCommandOutput, SustainabilityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: GetEstimatedCarbonEmissionsCommandInput): import("@smithy/smithy-client").CommandImpl<GetEstimatedCarbonEmissionsCommandInput, GetEstimatedCarbonEmissionsCommandOutput, SustainabilityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>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. </p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { SustainabilityClient, GetEstimatedCarbonEmissionsCommand } from "@aws-sdk/client-sustainability"; // ES Modules import
35
+ * // const { SustainabilityClient, GetEstimatedCarbonEmissionsCommand } = require("@aws-sdk/client-sustainability"); // CommonJS import
36
+ * // import type { SustainabilityClientConfig } from "@aws-sdk/client-sustainability";
37
+ * const config = {}; // type is SustainabilityClientConfig
38
+ * const client = new SustainabilityClient(config);
39
+ * const input = { // GetEstimatedCarbonEmissionsRequest
40
+ * TimePeriod: { // TimePeriod
41
+ * Start: new Date("TIMESTAMP"), // required
42
+ * End: new Date("TIMESTAMP"), // required
43
+ * },
44
+ * GroupBy: [ // DimensionList
45
+ * "USAGE_ACCOUNT_ID" || "REGION" || "SERVICE",
46
+ * ],
47
+ * FilterBy: { // FilterExpression
48
+ * Dimensions: { // DimensionListMap
49
+ * "<keys>": [ // DimensionValueList
50
+ * "STRING_VALUE",
51
+ * ],
52
+ * },
53
+ * },
54
+ * EmissionsTypes: [ // EmissionsTypeList
55
+ * "TOTAL_LBM_CARBON_EMISSIONS" || "TOTAL_MBM_CARBON_EMISSIONS" || "TOTAL_SCOPE_1_CARBON_EMISSIONS" || "TOTAL_SCOPE_2_LBM_CARBON_EMISSIONS" || "TOTAL_SCOPE_2_MBM_CARBON_EMISSIONS" || "TOTAL_SCOPE_3_LBM_CARBON_EMISSIONS" || "TOTAL_SCOPE_3_MBM_CARBON_EMISSIONS",
56
+ * ],
57
+ * Granularity: "YEARLY_CALENDAR" || "YEARLY_FISCAL" || "QUARTERLY_CALENDAR" || "QUARTERLY_FISCAL" || "MONTHLY",
58
+ * GranularityConfiguration: { // GranularityConfiguration
59
+ * FiscalYearStartMonth: Number("int"),
60
+ * },
61
+ * MaxResults: Number("int"),
62
+ * NextToken: "STRING_VALUE",
63
+ * };
64
+ * const command = new GetEstimatedCarbonEmissionsCommand(input);
65
+ * const response = await client.send(command);
66
+ * // { // GetEstimatedCarbonEmissionsResponse
67
+ * // Results: [ // EstimatedCarbonEmissionsList // required
68
+ * // { // EstimatedCarbonEmissions
69
+ * // TimePeriod: { // TimePeriod
70
+ * // Start: new Date("TIMESTAMP"), // required
71
+ * // End: new Date("TIMESTAMP"), // required
72
+ * // },
73
+ * // DimensionsValues: { // DimensionsMap // required
74
+ * // "<keys>": "STRING_VALUE",
75
+ * // },
76
+ * // ModelVersion: "STRING_VALUE", // required
77
+ * // EmissionsValues: { // EmissionsMap // required
78
+ * // "<keys>": { // Emissions
79
+ * // Value: Number("double"), // required
80
+ * // Unit: "MTCO2e", // required
81
+ * // },
82
+ * // },
83
+ * // },
84
+ * // ],
85
+ * // NextToken: "STRING_VALUE",
86
+ * // };
87
+ *
88
+ * ```
89
+ *
90
+ * @param GetEstimatedCarbonEmissionsCommandInput - {@link GetEstimatedCarbonEmissionsCommandInput}
91
+ * @returns {@link GetEstimatedCarbonEmissionsCommandOutput}
92
+ * @see {@link GetEstimatedCarbonEmissionsCommandInput} for command's `input` shape.
93
+ * @see {@link GetEstimatedCarbonEmissionsCommandOutput} for command's `response` shape.
94
+ * @see {@link SustainabilityClientResolvedConfig | config} for SustainabilityClient's `config` shape.
95
+ *
96
+ * @throws {@link AccessDeniedException} (client fault)
97
+ * <p>You do not have sufficient access to perform this action.</p>
98
+ *
99
+ * @throws {@link InternalServerException} (server fault)
100
+ * <p>The request processing has failed because of an unknown error, exception, or failure.</p>
101
+ *
102
+ * @throws {@link ThrottlingException} (client fault)
103
+ * <p>The request was denied due to request throttling.</p>
104
+ *
105
+ * @throws {@link ValidationException} (client fault)
106
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
107
+ *
108
+ * @throws {@link SustainabilityServiceException}
109
+ * <p>Base exception class for all service exceptions from Sustainability service.</p>
110
+ *
111
+ *
112
+ * @example GetEstimatedCarbonEmissionsSuccess
113
+ * ```javascript
114
+ * //
115
+ * const input = {
116
+ * EmissionsTypes: [
117
+ * "TOTAL_LBM_CARBON_EMISSIONS",
118
+ * "TOTAL_MBM_CARBON_EMISSIONS",
119
+ * "TOTAL_SCOPE_1_CARBON_EMISSIONS",
120
+ * "TOTAL_SCOPE_2_LBM_CARBON_EMISSIONS",
121
+ * "TOTAL_SCOPE_2_MBM_CARBON_EMISSIONS",
122
+ * "TOTAL_SCOPE_3_LBM_CARBON_EMISSIONS",
123
+ * "TOTAL_SCOPE_3_MBM_CARBON_EMISSIONS"
124
+ * ],
125
+ * Granularity: "MONTHLY",
126
+ * GroupBy: [
127
+ * "SERVICE"
128
+ * ],
129
+ * TimePeriod: {
130
+ * End: "2025-12-31T23:59:59.999Z",
131
+ * Start: "2025-01-01T00:00:00.000Z"
132
+ * }
133
+ * };
134
+ * const command = new GetEstimatedCarbonEmissionsCommand(input);
135
+ * const response = await client.send(command);
136
+ * /* response is
137
+ * {
138
+ * Results: [
139
+ * {
140
+ * DimensionsValues: {
141
+ * SERVICE: "AmazonEC2"
142
+ * },
143
+ * EmissionsValues: {
144
+ * TOTAL_LBM_CARBON_EMISSIONS: {
145
+ * Unit: "MTCO2e",
146
+ * Value: 1
147
+ * },
148
+ * TOTAL_MBM_CARBON_EMISSIONS: {
149
+ * Unit: "MTCO2e",
150
+ * Value: 1
151
+ * },
152
+ * TOTAL_SCOPE_1_CARBON_EMISSIONS: {
153
+ * Unit: "MTCO2e",
154
+ * Value: 1
155
+ * },
156
+ * TOTAL_SCOPE_2_LBM_CARBON_EMISSIONS: {
157
+ * Unit: "MTCO2e",
158
+ * Value: 1
159
+ * },
160
+ * TOTAL_SCOPE_2_MBM_CARBON_EMISSIONS: {
161
+ * Unit: "MTCO2e",
162
+ * Value: 1
163
+ * },
164
+ * TOTAL_SCOPE_3_LBM_CARBON_EMISSIONS: {
165
+ * Unit: "MTCO2e",
166
+ * Value: 1
167
+ * },
168
+ * TOTAL_SCOPE_3_MBM_CARBON_EMISSIONS: {
169
+ * Unit: "MTCO2e",
170
+ * Value: 1
171
+ * }
172
+ * },
173
+ * ModelVersion: "v3.0.0",
174
+ * TimePeriod: {
175
+ * End: "2025-02-01T00:00:00Z",
176
+ * Start: "2025-01-01T00:00:00Z"
177
+ * }
178
+ * }
179
+ * ]
180
+ * }
181
+ * *\/
182
+ * ```
183
+ *
184
+ * @public
185
+ */
186
+ export declare class GetEstimatedCarbonEmissionsCommand extends GetEstimatedCarbonEmissionsCommand_base {
187
+ /** @internal type navigation helper, not in runtime. */
188
+ protected static __types: {
189
+ api: {
190
+ input: GetEstimatedCarbonEmissionsRequest;
191
+ output: GetEstimatedCarbonEmissionsResponse;
192
+ };
193
+ sdk: {
194
+ input: GetEstimatedCarbonEmissionsCommandInput;
195
+ output: GetEstimatedCarbonEmissionsCommandOutput;
196
+ };
197
+ };
198
+ }
@@ -0,0 +1,152 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import type { GetEstimatedCarbonEmissionsDimensionValuesRequest, GetEstimatedCarbonEmissionsDimensionValuesResponse } from "../models/models_0";
4
+ import type { ServiceInputTypes, ServiceOutputTypes, SustainabilityClientResolvedConfig } from "../SustainabilityClient";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetEstimatedCarbonEmissionsDimensionValuesCommand}.
14
+ */
15
+ export interface GetEstimatedCarbonEmissionsDimensionValuesCommandInput extends GetEstimatedCarbonEmissionsDimensionValuesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetEstimatedCarbonEmissionsDimensionValuesCommand}.
21
+ */
22
+ export interface GetEstimatedCarbonEmissionsDimensionValuesCommandOutput extends GetEstimatedCarbonEmissionsDimensionValuesResponse, __MetadataBearer {
23
+ }
24
+ declare const GetEstimatedCarbonEmissionsDimensionValuesCommand_base: {
25
+ new (input: GetEstimatedCarbonEmissionsDimensionValuesCommandInput): import("@smithy/smithy-client").CommandImpl<GetEstimatedCarbonEmissionsDimensionValuesCommandInput, GetEstimatedCarbonEmissionsDimensionValuesCommandOutput, SustainabilityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: GetEstimatedCarbonEmissionsDimensionValuesCommandInput): import("@smithy/smithy-client").CommandImpl<GetEstimatedCarbonEmissionsDimensionValuesCommandInput, GetEstimatedCarbonEmissionsDimensionValuesCommandOutput, SustainabilityClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <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>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { SustainabilityClient, GetEstimatedCarbonEmissionsDimensionValuesCommand } from "@aws-sdk/client-sustainability"; // ES Modules import
35
+ * // const { SustainabilityClient, GetEstimatedCarbonEmissionsDimensionValuesCommand } = require("@aws-sdk/client-sustainability"); // CommonJS import
36
+ * // import type { SustainabilityClientConfig } from "@aws-sdk/client-sustainability";
37
+ * const config = {}; // type is SustainabilityClientConfig
38
+ * const client = new SustainabilityClient(config);
39
+ * const input = { // GetEstimatedCarbonEmissionsDimensionValuesRequest
40
+ * TimePeriod: { // TimePeriod
41
+ * Start: new Date("TIMESTAMP"), // required
42
+ * End: new Date("TIMESTAMP"), // required
43
+ * },
44
+ * Dimensions: [ // DimensionList // required
45
+ * "USAGE_ACCOUNT_ID" || "REGION" || "SERVICE",
46
+ * ],
47
+ * MaxResults: Number("int"),
48
+ * NextToken: "STRING_VALUE",
49
+ * };
50
+ * const command = new GetEstimatedCarbonEmissionsDimensionValuesCommand(input);
51
+ * const response = await client.send(command);
52
+ * // { // GetEstimatedCarbonEmissionsDimensionValuesResponse
53
+ * // Results: [ // DimensionEntryList
54
+ * // { // DimensionEntry
55
+ * // Dimension: "USAGE_ACCOUNT_ID" || "REGION" || "SERVICE", // required
56
+ * // Value: "STRING_VALUE", // required
57
+ * // },
58
+ * // ],
59
+ * // NextToken: "STRING_VALUE",
60
+ * // };
61
+ *
62
+ * ```
63
+ *
64
+ * @param GetEstimatedCarbonEmissionsDimensionValuesCommandInput - {@link GetEstimatedCarbonEmissionsDimensionValuesCommandInput}
65
+ * @returns {@link GetEstimatedCarbonEmissionsDimensionValuesCommandOutput}
66
+ * @see {@link GetEstimatedCarbonEmissionsDimensionValuesCommandInput} for command's `input` shape.
67
+ * @see {@link GetEstimatedCarbonEmissionsDimensionValuesCommandOutput} for command's `response` shape.
68
+ * @see {@link SustainabilityClientResolvedConfig | config} for SustainabilityClient's `config` shape.
69
+ *
70
+ * @throws {@link AccessDeniedException} (client fault)
71
+ * <p>You do not have sufficient access to perform this action.</p>
72
+ *
73
+ * @throws {@link InternalServerException} (server fault)
74
+ * <p>The request processing has failed because of an unknown error, exception, or failure.</p>
75
+ *
76
+ * @throws {@link ThrottlingException} (client fault)
77
+ * <p>The request was denied due to request throttling.</p>
78
+ *
79
+ * @throws {@link ValidationException} (client fault)
80
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
81
+ *
82
+ * @throws {@link SustainabilityServiceException}
83
+ * <p>Base exception class for all service exceptions from Sustainability service.</p>
84
+ *
85
+ *
86
+ * @example GetEstimatedCarbonEmissionsDimensionValuesSuccess
87
+ * ```javascript
88
+ * //
89
+ * const input = {
90
+ * Dimensions: [
91
+ * "REGION",
92
+ * "SERVICE",
93
+ * "USAGE_ACCOUNT_ID"
94
+ * ],
95
+ * TimePeriod: {
96
+ * End: "2025-12-31T23:59:59.999Z",
97
+ * Start: "2025-01-01T00:00:00.000Z"
98
+ * }
99
+ * };
100
+ * const command = new GetEstimatedCarbonEmissionsDimensionValuesCommand(input);
101
+ * const response = await client.send(command);
102
+ * /* response is
103
+ * {
104
+ * Results: [
105
+ * {
106
+ * Dimension: "SERVICE",
107
+ * Value: "AmazonEC2"
108
+ * },
109
+ * {
110
+ * Dimension: "SERVICE",
111
+ * Value: "AmazonS3"
112
+ * },
113
+ * {
114
+ * Dimension: "SERVICE",
115
+ * Value: "AmazonCloudFront"
116
+ * },
117
+ * {
118
+ * Dimension: "REGION",
119
+ * Value: "global"
120
+ * },
121
+ * {
122
+ * Dimension: "REGION",
123
+ * Value: "us-east-1"
124
+ * },
125
+ * {
126
+ * Dimension: "REGION",
127
+ * Value: "us-west-2"
128
+ * },
129
+ * {
130
+ * Dimension: "USAGE_ACCOUNT_ID",
131
+ * Value: "111222333444"
132
+ * }
133
+ * ]
134
+ * }
135
+ * *\/
136
+ * ```
137
+ *
138
+ * @public
139
+ */
140
+ export declare class GetEstimatedCarbonEmissionsDimensionValuesCommand extends GetEstimatedCarbonEmissionsDimensionValuesCommand_base {
141
+ /** @internal type navigation helper, not in runtime. */
142
+ protected static __types: {
143
+ api: {
144
+ input: GetEstimatedCarbonEmissionsDimensionValuesRequest;
145
+ output: GetEstimatedCarbonEmissionsDimensionValuesResponse;
146
+ };
147
+ sdk: {
148
+ input: GetEstimatedCarbonEmissionsDimensionValuesCommandInput;
149
+ output: GetEstimatedCarbonEmissionsDimensionValuesCommandOutput;
150
+ };
151
+ };
152
+ }
@@ -0,0 +1,2 @@
1
+ export * from "./GetEstimatedCarbonEmissionsCommand";
2
+ export * from "./GetEstimatedCarbonEmissionsDimensionValuesCommand";
@@ -0,0 +1,44 @@
1
+ import type { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provider } from "@smithy/types";
2
+ /**
3
+ * @public
4
+ */
5
+ export interface ClientInputEndpointParameters {
6
+ useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
7
+ endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
8
+ region?: string | undefined | Provider<string | undefined>;
9
+ }
10
+ /**
11
+ * @public
12
+ */
13
+ export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
14
+ defaultSigningName: string;
15
+ };
16
+ /**
17
+ * @internal
18
+ */
19
+ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
20
+ /**
21
+ * @internal
22
+ */
23
+ export declare const commonParams: {
24
+ readonly UseFIPS: {
25
+ readonly type: "builtInParams";
26
+ readonly name: "useFipsEndpoint";
27
+ };
28
+ readonly Endpoint: {
29
+ readonly type: "builtInParams";
30
+ readonly name: "endpoint";
31
+ };
32
+ readonly Region: {
33
+ readonly type: "builtInParams";
34
+ readonly name: "region";
35
+ };
36
+ };
37
+ /**
38
+ * @internal
39
+ */
40
+ export interface EndpointParameters extends __EndpointParameters {
41
+ UseFIPS?: boolean | undefined;
42
+ Endpoint?: string | undefined;
43
+ Region?: string | undefined;
44
+ }
@@ -0,0 +1,8 @@
1
+ import type { EndpointV2, Logger } from "@smithy/types";
2
+ import type { EndpointParameters } from "./EndpointParameters";
3
+ /**
4
+ * @internal
5
+ */
6
+ export declare const defaultEndpointResolver: (endpointParams: EndpointParameters, context?: {
7
+ logger?: Logger;
8
+ }) => EndpointV2;
@@ -0,0 +1,2 @@
1
+ import { RuleSetObject } from "@smithy/types";
2
+ export declare const ruleSet: RuleSetObject;
@@ -0,0 +1,9 @@
1
+ import type { AwsRegionExtensionConfiguration } from "@aws-sdk/types";
2
+ import type { HttpHandlerExtensionConfiguration } from "@smithy/protocol-http";
3
+ import type { DefaultExtensionConfiguration } from "@smithy/types";
4
+ import type { HttpAuthExtensionConfiguration } from "./auth/httpAuthExtensionConfiguration";
5
+ /**
6
+ * @internal
7
+ */
8
+ export interface SustainabilityExtensionConfiguration extends HttpHandlerExtensionConfiguration, DefaultExtensionConfiguration, AwsRegionExtensionConfiguration, HttpAuthExtensionConfiguration {
9
+ }
@@ -0,0 +1,17 @@
1
+ /**
2
+ * <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>
3
+ *
4
+ * @packageDocumentation
5
+ */
6
+ export * from "./SustainabilityClient";
7
+ export * from "./Sustainability";
8
+ export type { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
9
+ export type { RuntimeExtension } from "./runtimeExtensions";
10
+ export type { SustainabilityExtensionConfiguration } from "./extensionConfiguration";
11
+ export * from "./commands";
12
+ export * from "./schemas/schemas_0";
13
+ export * from "./pagination";
14
+ export * from "./models/enums";
15
+ export * from "./models/errors";
16
+ export * from "./models/models_0";
17
+ export { SustainabilityServiceException } from "./models/SustainabilityServiceException";
@@ -0,0 +1,14 @@
1
+ import { type ServiceExceptionOptions as __ServiceExceptionOptions, ServiceException as __ServiceException } from "@smithy/smithy-client";
2
+ export type { __ServiceExceptionOptions };
3
+ export { __ServiceException };
4
+ /**
5
+ * @public
6
+ *
7
+ * Base exception class for all service exceptions from Sustainability service.
8
+ */
9
+ export declare class SustainabilityServiceException extends __ServiceException {
10
+ /**
11
+ * @internal
12
+ */
13
+ constructor(options: __ServiceExceptionOptions);
14
+ }
@@ -0,0 +1,104 @@
1
+ /**
2
+ * @public
3
+ * @enum
4
+ */
5
+ export declare const EmissionsType: {
6
+ /**
7
+ * <p>Total direct, indirect, and value chain emissions, calculated using GHG Protocol's Location-based method (LBM).</p>
8
+ */
9
+ readonly TOTAL_LBM_CARBON_EMISSIONS: "TOTAL_LBM_CARBON_EMISSIONS";
10
+ /**
11
+ * <p>Total direct, indirect, and value chain emissions, calculated using GHG Protocol's Market-based method (MBM).</p>
12
+ */
13
+ readonly TOTAL_MBM_CARBON_EMISSIONS: "TOTAL_MBM_CARBON_EMISSIONS";
14
+ /**
15
+ * <p>Total direct emissions from Amazon Web Services owned or controlled sources.</p>
16
+ */
17
+ readonly TOTAL_SCOPE_1_CARBON_EMISSIONS: "TOTAL_SCOPE_1_CARBON_EMISSIONS";
18
+ /**
19
+ * <p>Total indirect emissions from the production of purchased energy, calculated using GHG Protocol's Location-based method (LBM).</p>
20
+ */
21
+ readonly TOTAL_SCOPE_2_LBM_CARBON_EMISSIONS: "TOTAL_SCOPE_2_LBM_CARBON_EMISSIONS";
22
+ /**
23
+ * <p>Total indirect emissions from the production of purchased energy, calculated using GHG Protocol's Market-based method (MBM).</p>
24
+ */
25
+ readonly TOTAL_SCOPE_2_MBM_CARBON_EMISSIONS: "TOTAL_SCOPE_2_MBM_CARBON_EMISSIONS";
26
+ /**
27
+ * <p>Total value chain emissions, calculated using GHG Protocol's Location-based method (LBM).</p>
28
+ */
29
+ readonly TOTAL_SCOPE_3_LBM_CARBON_EMISSIONS: "TOTAL_SCOPE_3_LBM_CARBON_EMISSIONS";
30
+ /**
31
+ * <p>Total value chain emissions, calculated using GHG Protocol's Market-based method (MBM).</p>
32
+ */
33
+ readonly TOTAL_SCOPE_3_MBM_CARBON_EMISSIONS: "TOTAL_SCOPE_3_MBM_CARBON_EMISSIONS";
34
+ };
35
+ /**
36
+ * @public
37
+ */
38
+ export type EmissionsType = (typeof EmissionsType)[keyof typeof EmissionsType];
39
+ /**
40
+ * @public
41
+ * @enum
42
+ */
43
+ export declare const Dimension: {
44
+ /**
45
+ * <p>The geographical area containing data center clusters where Amazon Web Services services are hosted.</p>
46
+ */
47
+ readonly REGION: "REGION";
48
+ /**
49
+ * <p>The cloud computing product and solution offered by Amazon Web Services.</p>
50
+ */
51
+ readonly SERVICE: "SERVICE";
52
+ /**
53
+ * <p>The account ID whose Amazon Web Services usage resulted in the estimated carbon emissions.</p>
54
+ */
55
+ readonly USAGE_ACCOUNT_ID: "USAGE_ACCOUNT_ID";
56
+ };
57
+ /**
58
+ * @public
59
+ */
60
+ export type Dimension = (typeof Dimension)[keyof typeof Dimension];
61
+ /**
62
+ * @public
63
+ * @enum
64
+ */
65
+ export declare const TimeGranularity: {
66
+ /**
67
+ * <p>Emissions aggregated by calendar month.</p>
68
+ */
69
+ readonly MONTHLY: "MONTHLY";
70
+ /**
71
+ * <p>Emissions aggregated over calendar quarter periods (Q1: Jan-Mar, Q2: Apr-Jun, Q3: Jul-Sep, Q4: Oct-Dec).</p>
72
+ */
73
+ readonly QUARTERLY_CALENDAR: "QUARTERLY_CALENDAR";
74
+ /**
75
+ * <p>Emissions aggregated over fiscal quarter periods based on the fiscal year start month specified in GranularityConfiguration.FiscalYearStartMonth.</p>
76
+ */
77
+ readonly QUARTERLY_FISCAL: "QUARTERLY_FISCAL";
78
+ /**
79
+ * <p>Emissions aggregated over calendar year periods (January-December).</p>
80
+ */
81
+ readonly YEARLY_CALENDAR: "YEARLY_CALENDAR";
82
+ /**
83
+ * <p>Emissions aggregated over fiscal year periods starting from the month specified in GranularityConfiguration.FiscalYearStartMonth.</p>
84
+ */
85
+ readonly YEARLY_FISCAL: "YEARLY_FISCAL";
86
+ };
87
+ /**
88
+ * @public
89
+ */
90
+ export type TimeGranularity = (typeof TimeGranularity)[keyof typeof TimeGranularity];
91
+ /**
92
+ * @public
93
+ * @enum
94
+ */
95
+ export declare const EmissionsUnit: {
96
+ /**
97
+ * <p>Metric tons of carbon dioxide-equivalent (MTCO2e).</p>
98
+ */
99
+ readonly MT_CO2E: "MTCO2e";
100
+ };
101
+ /**
102
+ * @public
103
+ */
104
+ export type EmissionsUnit = (typeof EmissionsUnit)[keyof typeof EmissionsUnit];
@@ -0,0 +1,56 @@
1
+ import type { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { SustainabilityServiceException as __BaseException } from "./SustainabilityServiceException";
3
+ /**
4
+ * <p>You do not have sufficient access to perform this action.</p>
5
+ * @public
6
+ */
7
+ export declare class AccessDeniedException extends __BaseException {
8
+ readonly name: "AccessDeniedException";
9
+ readonly $fault: "client";
10
+ Message: string | undefined;
11
+ /**
12
+ * @internal
13
+ */
14
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
15
+ }
16
+ /**
17
+ * <p>The request processing has failed because of an unknown error, exception, or failure.</p>
18
+ * @public
19
+ */
20
+ export declare class InternalServerException extends __BaseException {
21
+ readonly name: "InternalServerException";
22
+ readonly $fault: "server";
23
+ $retryable: {};
24
+ Message: string | undefined;
25
+ /**
26
+ * @internal
27
+ */
28
+ constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
29
+ }
30
+ /**
31
+ * <p>The request was denied due to request throttling.</p>
32
+ * @public
33
+ */
34
+ export declare class ThrottlingException extends __BaseException {
35
+ readonly name: "ThrottlingException";
36
+ readonly $fault: "client";
37
+ $retryable: {};
38
+ Message: string | undefined;
39
+ /**
40
+ * @internal
41
+ */
42
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
43
+ }
44
+ /**
45
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
46
+ * @public
47
+ */
48
+ export declare class ValidationException extends __BaseException {
49
+ readonly name: "ValidationException";
50
+ readonly $fault: "client";
51
+ Message: string | undefined;
52
+ /**
53
+ * @internal
54
+ */
55
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
56
+ }