@aws-sdk/client-cost-explorer 3.817.0 → 3.818.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.
- package/README.md +16 -0
- package/dist-cjs/index.js +148 -0
- package/dist-es/CostExplorer.js +4 -0
- package/dist-es/commands/GetCostAndUsageComparisonsCommand.js +22 -0
- package/dist-es/commands/GetCostComparisonDriversCommand.js +22 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/pagination/GetCostAndUsageComparisonsPaginator.js +4 -0
- package/dist-es/pagination/GetCostComparisonDriversPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_json1_1.js +104 -0
- package/dist-types/CostExplorer.d.ts +14 -0
- package/dist-types/CostExplorerClient.d.ts +4 -2
- package/dist-types/commands/GetCostAndUsageComparisonsCommand.d.ts +257 -0
- package/dist-types/commands/GetCostComparisonDriversCommand.d.ts +263 -0
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +830 -93
- package/dist-types/pagination/GetCostAndUsageComparisonsPaginator.d.ts +7 -0
- package/dist-types/pagination/GetCostComparisonDriversPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +18 -0
- package/dist-types/ts3.4/CostExplorer.d.ts +34 -0
- package/dist-types/ts3.4/CostExplorerClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/GetCostAndUsageComparisonsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetCostComparisonDriversCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +49 -0
- package/dist-types/ts3.4/pagination/GetCostAndUsageComparisonsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/GetCostComparisonDriversPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +24 -0
- package/package.json +1 -1
|
@@ -0,0 +1,257 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CostExplorerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CostExplorerClient";
|
|
4
|
+
import { GetCostAndUsageComparisonsRequest, GetCostAndUsageComparisonsResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetCostAndUsageComparisonsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetCostAndUsageComparisonsCommandInput extends GetCostAndUsageComparisonsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetCostAndUsageComparisonsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetCostAndUsageComparisonsCommandOutput extends GetCostAndUsageComparisonsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetCostAndUsageComparisonsCommand_base: {
|
|
25
|
+
new (input: GetCostAndUsageComparisonsCommandInput): import("@smithy/smithy-client").CommandImpl<GetCostAndUsageComparisonsCommandInput, GetCostAndUsageComparisonsCommandOutput, CostExplorerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetCostAndUsageComparisonsCommandInput): import("@smithy/smithy-client").CommandImpl<GetCostAndUsageComparisonsCommandInput, GetCostAndUsageComparisonsCommandOutput, CostExplorerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves cost and usage comparisons for your account between two periods within the last
|
|
31
|
+
* 13 months. If you have enabled multi-year data at monthly granularity, you can go back up to
|
|
32
|
+
* 38 months.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { CostExplorerClient, GetCostAndUsageComparisonsCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import
|
|
37
|
+
* // const { CostExplorerClient, GetCostAndUsageComparisonsCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import
|
|
38
|
+
* const client = new CostExplorerClient(config);
|
|
39
|
+
* const input = { // GetCostAndUsageComparisonsRequest
|
|
40
|
+
* BillingViewArn: "STRING_VALUE",
|
|
41
|
+
* BaselineTimePeriod: { // DateInterval
|
|
42
|
+
* Start: "STRING_VALUE", // required
|
|
43
|
+
* End: "STRING_VALUE", // required
|
|
44
|
+
* },
|
|
45
|
+
* ComparisonTimePeriod: {
|
|
46
|
+
* Start: "STRING_VALUE", // required
|
|
47
|
+
* End: "STRING_VALUE", // required
|
|
48
|
+
* },
|
|
49
|
+
* MetricForComparison: "STRING_VALUE", // required
|
|
50
|
+
* Filter: { // Expression
|
|
51
|
+
* Or: [ // Expressions
|
|
52
|
+
* {
|
|
53
|
+
* Or: [
|
|
54
|
+
* "<Expression>",
|
|
55
|
+
* ],
|
|
56
|
+
* And: [
|
|
57
|
+
* "<Expression>",
|
|
58
|
+
* ],
|
|
59
|
+
* Not: "<Expression>",
|
|
60
|
+
* Dimensions: { // DimensionValues
|
|
61
|
+
* Key: "AZ" || "INSTANCE_TYPE" || "LINKED_ACCOUNT" || "LINKED_ACCOUNT_NAME" || "OPERATION" || "PURCHASE_TYPE" || "REGION" || "SERVICE" || "SERVICE_CODE" || "USAGE_TYPE" || "USAGE_TYPE_GROUP" || "RECORD_TYPE" || "OPERATING_SYSTEM" || "TENANCY" || "SCOPE" || "PLATFORM" || "SUBSCRIPTION_ID" || "LEGAL_ENTITY_NAME" || "DEPLOYMENT_OPTION" || "DATABASE_ENGINE" || "CACHE_ENGINE" || "INSTANCE_TYPE_FAMILY" || "BILLING_ENTITY" || "RESERVATION_ID" || "RESOURCE_ID" || "RIGHTSIZING_TYPE" || "SAVINGS_PLANS_TYPE" || "SAVINGS_PLAN_ARN" || "PAYMENT_OPTION" || "AGREEMENT_END_DATE_TIME_AFTER" || "AGREEMENT_END_DATE_TIME_BEFORE" || "INVOICING_ENTITY" || "ANOMALY_TOTAL_IMPACT_ABSOLUTE" || "ANOMALY_TOTAL_IMPACT_PERCENTAGE",
|
|
62
|
+
* Values: [ // Values
|
|
63
|
+
* "STRING_VALUE",
|
|
64
|
+
* ],
|
|
65
|
+
* MatchOptions: [ // MatchOptions
|
|
66
|
+
* "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
67
|
+
* ],
|
|
68
|
+
* },
|
|
69
|
+
* Tags: { // TagValues
|
|
70
|
+
* Key: "STRING_VALUE",
|
|
71
|
+
* Values: [
|
|
72
|
+
* "STRING_VALUE",
|
|
73
|
+
* ],
|
|
74
|
+
* MatchOptions: [
|
|
75
|
+
* "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
76
|
+
* ],
|
|
77
|
+
* },
|
|
78
|
+
* CostCategories: { // CostCategoryValues
|
|
79
|
+
* Key: "STRING_VALUE",
|
|
80
|
+
* Values: [
|
|
81
|
+
* "STRING_VALUE",
|
|
82
|
+
* ],
|
|
83
|
+
* MatchOptions: [
|
|
84
|
+
* "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
85
|
+
* ],
|
|
86
|
+
* },
|
|
87
|
+
* },
|
|
88
|
+
* ],
|
|
89
|
+
* And: [
|
|
90
|
+
* "<Expression>",
|
|
91
|
+
* ],
|
|
92
|
+
* Not: "<Expression>",
|
|
93
|
+
* Dimensions: {
|
|
94
|
+
* Key: "AZ" || "INSTANCE_TYPE" || "LINKED_ACCOUNT" || "LINKED_ACCOUNT_NAME" || "OPERATION" || "PURCHASE_TYPE" || "REGION" || "SERVICE" || "SERVICE_CODE" || "USAGE_TYPE" || "USAGE_TYPE_GROUP" || "RECORD_TYPE" || "OPERATING_SYSTEM" || "TENANCY" || "SCOPE" || "PLATFORM" || "SUBSCRIPTION_ID" || "LEGAL_ENTITY_NAME" || "DEPLOYMENT_OPTION" || "DATABASE_ENGINE" || "CACHE_ENGINE" || "INSTANCE_TYPE_FAMILY" || "BILLING_ENTITY" || "RESERVATION_ID" || "RESOURCE_ID" || "RIGHTSIZING_TYPE" || "SAVINGS_PLANS_TYPE" || "SAVINGS_PLAN_ARN" || "PAYMENT_OPTION" || "AGREEMENT_END_DATE_TIME_AFTER" || "AGREEMENT_END_DATE_TIME_BEFORE" || "INVOICING_ENTITY" || "ANOMALY_TOTAL_IMPACT_ABSOLUTE" || "ANOMALY_TOTAL_IMPACT_PERCENTAGE",
|
|
95
|
+
* Values: [
|
|
96
|
+
* "STRING_VALUE",
|
|
97
|
+
* ],
|
|
98
|
+
* MatchOptions: [
|
|
99
|
+
* "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
100
|
+
* ],
|
|
101
|
+
* },
|
|
102
|
+
* Tags: {
|
|
103
|
+
* Key: "STRING_VALUE",
|
|
104
|
+
* Values: [
|
|
105
|
+
* "STRING_VALUE",
|
|
106
|
+
* ],
|
|
107
|
+
* MatchOptions: [
|
|
108
|
+
* "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
109
|
+
* ],
|
|
110
|
+
* },
|
|
111
|
+
* CostCategories: {
|
|
112
|
+
* Key: "STRING_VALUE",
|
|
113
|
+
* Values: "<Values>",
|
|
114
|
+
* MatchOptions: "<MatchOptions>",
|
|
115
|
+
* },
|
|
116
|
+
* },
|
|
117
|
+
* GroupBy: [ // GroupDefinitions
|
|
118
|
+
* { // GroupDefinition
|
|
119
|
+
* Type: "DIMENSION" || "TAG" || "COST_CATEGORY",
|
|
120
|
+
* Key: "STRING_VALUE",
|
|
121
|
+
* },
|
|
122
|
+
* ],
|
|
123
|
+
* MaxResults: Number("int"),
|
|
124
|
+
* NextPageToken: "STRING_VALUE",
|
|
125
|
+
* };
|
|
126
|
+
* const command = new GetCostAndUsageComparisonsCommand(input);
|
|
127
|
+
* const response = await client.send(command);
|
|
128
|
+
* // { // GetCostAndUsageComparisonsResponse
|
|
129
|
+
* // CostAndUsageComparisons: [ // CostAndUsageComparisons
|
|
130
|
+
* // { // CostAndUsageComparison
|
|
131
|
+
* // CostAndUsageSelector: { // Expression
|
|
132
|
+
* // Or: [ // Expressions
|
|
133
|
+
* // {
|
|
134
|
+
* // Or: [
|
|
135
|
+
* // "<Expression>",
|
|
136
|
+
* // ],
|
|
137
|
+
* // And: [
|
|
138
|
+
* // "<Expression>",
|
|
139
|
+
* // ],
|
|
140
|
+
* // Not: "<Expression>",
|
|
141
|
+
* // Dimensions: { // DimensionValues
|
|
142
|
+
* // Key: "AZ" || "INSTANCE_TYPE" || "LINKED_ACCOUNT" || "LINKED_ACCOUNT_NAME" || "OPERATION" || "PURCHASE_TYPE" || "REGION" || "SERVICE" || "SERVICE_CODE" || "USAGE_TYPE" || "USAGE_TYPE_GROUP" || "RECORD_TYPE" || "OPERATING_SYSTEM" || "TENANCY" || "SCOPE" || "PLATFORM" || "SUBSCRIPTION_ID" || "LEGAL_ENTITY_NAME" || "DEPLOYMENT_OPTION" || "DATABASE_ENGINE" || "CACHE_ENGINE" || "INSTANCE_TYPE_FAMILY" || "BILLING_ENTITY" || "RESERVATION_ID" || "RESOURCE_ID" || "RIGHTSIZING_TYPE" || "SAVINGS_PLANS_TYPE" || "SAVINGS_PLAN_ARN" || "PAYMENT_OPTION" || "AGREEMENT_END_DATE_TIME_AFTER" || "AGREEMENT_END_DATE_TIME_BEFORE" || "INVOICING_ENTITY" || "ANOMALY_TOTAL_IMPACT_ABSOLUTE" || "ANOMALY_TOTAL_IMPACT_PERCENTAGE",
|
|
143
|
+
* // Values: [ // Values
|
|
144
|
+
* // "STRING_VALUE",
|
|
145
|
+
* // ],
|
|
146
|
+
* // MatchOptions: [ // MatchOptions
|
|
147
|
+
* // "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
148
|
+
* // ],
|
|
149
|
+
* // },
|
|
150
|
+
* // Tags: { // TagValues
|
|
151
|
+
* // Key: "STRING_VALUE",
|
|
152
|
+
* // Values: [
|
|
153
|
+
* // "STRING_VALUE",
|
|
154
|
+
* // ],
|
|
155
|
+
* // MatchOptions: [
|
|
156
|
+
* // "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
157
|
+
* // ],
|
|
158
|
+
* // },
|
|
159
|
+
* // CostCategories: { // CostCategoryValues
|
|
160
|
+
* // Key: "STRING_VALUE",
|
|
161
|
+
* // Values: [
|
|
162
|
+
* // "STRING_VALUE",
|
|
163
|
+
* // ],
|
|
164
|
+
* // MatchOptions: [
|
|
165
|
+
* // "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
166
|
+
* // ],
|
|
167
|
+
* // },
|
|
168
|
+
* // },
|
|
169
|
+
* // ],
|
|
170
|
+
* // And: [
|
|
171
|
+
* // "<Expression>",
|
|
172
|
+
* // ],
|
|
173
|
+
* // Not: "<Expression>",
|
|
174
|
+
* // Dimensions: {
|
|
175
|
+
* // Key: "AZ" || "INSTANCE_TYPE" || "LINKED_ACCOUNT" || "LINKED_ACCOUNT_NAME" || "OPERATION" || "PURCHASE_TYPE" || "REGION" || "SERVICE" || "SERVICE_CODE" || "USAGE_TYPE" || "USAGE_TYPE_GROUP" || "RECORD_TYPE" || "OPERATING_SYSTEM" || "TENANCY" || "SCOPE" || "PLATFORM" || "SUBSCRIPTION_ID" || "LEGAL_ENTITY_NAME" || "DEPLOYMENT_OPTION" || "DATABASE_ENGINE" || "CACHE_ENGINE" || "INSTANCE_TYPE_FAMILY" || "BILLING_ENTITY" || "RESERVATION_ID" || "RESOURCE_ID" || "RIGHTSIZING_TYPE" || "SAVINGS_PLANS_TYPE" || "SAVINGS_PLAN_ARN" || "PAYMENT_OPTION" || "AGREEMENT_END_DATE_TIME_AFTER" || "AGREEMENT_END_DATE_TIME_BEFORE" || "INVOICING_ENTITY" || "ANOMALY_TOTAL_IMPACT_ABSOLUTE" || "ANOMALY_TOTAL_IMPACT_PERCENTAGE",
|
|
176
|
+
* // Values: [
|
|
177
|
+
* // "STRING_VALUE",
|
|
178
|
+
* // ],
|
|
179
|
+
* // MatchOptions: [
|
|
180
|
+
* // "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
181
|
+
* // ],
|
|
182
|
+
* // },
|
|
183
|
+
* // Tags: {
|
|
184
|
+
* // Key: "STRING_VALUE",
|
|
185
|
+
* // Values: [
|
|
186
|
+
* // "STRING_VALUE",
|
|
187
|
+
* // ],
|
|
188
|
+
* // MatchOptions: [
|
|
189
|
+
* // "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
190
|
+
* // ],
|
|
191
|
+
* // },
|
|
192
|
+
* // CostCategories: {
|
|
193
|
+
* // Key: "STRING_VALUE",
|
|
194
|
+
* // Values: "<Values>",
|
|
195
|
+
* // MatchOptions: "<MatchOptions>",
|
|
196
|
+
* // },
|
|
197
|
+
* // },
|
|
198
|
+
* // Metrics: { // ComparisonMetrics
|
|
199
|
+
* // "<keys>": { // ComparisonMetricValue
|
|
200
|
+
* // BaselineTimePeriodAmount: "STRING_VALUE",
|
|
201
|
+
* // ComparisonTimePeriodAmount: "STRING_VALUE",
|
|
202
|
+
* // Difference: "STRING_VALUE",
|
|
203
|
+
* // Unit: "STRING_VALUE",
|
|
204
|
+
* // },
|
|
205
|
+
* // },
|
|
206
|
+
* // },
|
|
207
|
+
* // ],
|
|
208
|
+
* // TotalCostAndUsage: {
|
|
209
|
+
* // "<keys>": {
|
|
210
|
+
* // BaselineTimePeriodAmount: "STRING_VALUE",
|
|
211
|
+
* // ComparisonTimePeriodAmount: "STRING_VALUE",
|
|
212
|
+
* // Difference: "STRING_VALUE",
|
|
213
|
+
* // Unit: "STRING_VALUE",
|
|
214
|
+
* // },
|
|
215
|
+
* // },
|
|
216
|
+
* // NextPageToken: "STRING_VALUE",
|
|
217
|
+
* // };
|
|
218
|
+
*
|
|
219
|
+
* ```
|
|
220
|
+
*
|
|
221
|
+
* @param GetCostAndUsageComparisonsCommandInput - {@link GetCostAndUsageComparisonsCommandInput}
|
|
222
|
+
* @returns {@link GetCostAndUsageComparisonsCommandOutput}
|
|
223
|
+
* @see {@link GetCostAndUsageComparisonsCommandInput} for command's `input` shape.
|
|
224
|
+
* @see {@link GetCostAndUsageComparisonsCommandOutput} for command's `response` shape.
|
|
225
|
+
* @see {@link CostExplorerClientResolvedConfig | config} for CostExplorerClient's `config` shape.
|
|
226
|
+
*
|
|
227
|
+
* @throws {@link DataUnavailableException} (client fault)
|
|
228
|
+
* <p>The requested data is unavailable.</p>
|
|
229
|
+
*
|
|
230
|
+
* @throws {@link InvalidNextTokenException} (client fault)
|
|
231
|
+
* <p>The pagination token is invalid. Try again without a pagination token.</p>
|
|
232
|
+
*
|
|
233
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
234
|
+
* <p>You made too many calls in a short period of time. Try again later.</p>
|
|
235
|
+
*
|
|
236
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
237
|
+
* <p> The specified ARN in the request doesn't exist. </p>
|
|
238
|
+
*
|
|
239
|
+
* @throws {@link CostExplorerServiceException}
|
|
240
|
+
* <p>Base exception class for all service exceptions from CostExplorer service.</p>
|
|
241
|
+
*
|
|
242
|
+
*
|
|
243
|
+
* @public
|
|
244
|
+
*/
|
|
245
|
+
export declare class GetCostAndUsageComparisonsCommand extends GetCostAndUsageComparisonsCommand_base {
|
|
246
|
+
/** @internal type navigation helper, not in runtime. */
|
|
247
|
+
protected static __types: {
|
|
248
|
+
api: {
|
|
249
|
+
input: GetCostAndUsageComparisonsRequest;
|
|
250
|
+
output: GetCostAndUsageComparisonsResponse;
|
|
251
|
+
};
|
|
252
|
+
sdk: {
|
|
253
|
+
input: GetCostAndUsageComparisonsCommandInput;
|
|
254
|
+
output: GetCostAndUsageComparisonsCommandOutput;
|
|
255
|
+
};
|
|
256
|
+
};
|
|
257
|
+
}
|
|
@@ -0,0 +1,263 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { CostExplorerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../CostExplorerClient";
|
|
4
|
+
import { GetCostComparisonDriversRequest, GetCostComparisonDriversResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetCostComparisonDriversCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetCostComparisonDriversCommandInput extends GetCostComparisonDriversRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetCostComparisonDriversCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetCostComparisonDriversCommandOutput extends GetCostComparisonDriversResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetCostComparisonDriversCommand_base: {
|
|
25
|
+
new (input: GetCostComparisonDriversCommandInput): import("@smithy/smithy-client").CommandImpl<GetCostComparisonDriversCommandInput, GetCostComparisonDriversCommandOutput, CostExplorerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: GetCostComparisonDriversCommandInput): import("@smithy/smithy-client").CommandImpl<GetCostComparisonDriversCommandInput, GetCostComparisonDriversCommandOutput, CostExplorerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves key factors driving cost changes between two time periods within the last 13
|
|
31
|
+
* months, such as usage changes, discount changes, and commitment-based savings. If you have
|
|
32
|
+
* enabled multi-year data at monthly granularity, you can go back up to 38 months.</p>
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { CostExplorerClient, GetCostComparisonDriversCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import
|
|
37
|
+
* // const { CostExplorerClient, GetCostComparisonDriversCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import
|
|
38
|
+
* const client = new CostExplorerClient(config);
|
|
39
|
+
* const input = { // GetCostComparisonDriversRequest
|
|
40
|
+
* BillingViewArn: "STRING_VALUE",
|
|
41
|
+
* BaselineTimePeriod: { // DateInterval
|
|
42
|
+
* Start: "STRING_VALUE", // required
|
|
43
|
+
* End: "STRING_VALUE", // required
|
|
44
|
+
* },
|
|
45
|
+
* ComparisonTimePeriod: {
|
|
46
|
+
* Start: "STRING_VALUE", // required
|
|
47
|
+
* End: "STRING_VALUE", // required
|
|
48
|
+
* },
|
|
49
|
+
* MetricForComparison: "STRING_VALUE", // required
|
|
50
|
+
* Filter: { // Expression
|
|
51
|
+
* Or: [ // Expressions
|
|
52
|
+
* {
|
|
53
|
+
* Or: [
|
|
54
|
+
* "<Expression>",
|
|
55
|
+
* ],
|
|
56
|
+
* And: [
|
|
57
|
+
* "<Expression>",
|
|
58
|
+
* ],
|
|
59
|
+
* Not: "<Expression>",
|
|
60
|
+
* Dimensions: { // DimensionValues
|
|
61
|
+
* Key: "AZ" || "INSTANCE_TYPE" || "LINKED_ACCOUNT" || "LINKED_ACCOUNT_NAME" || "OPERATION" || "PURCHASE_TYPE" || "REGION" || "SERVICE" || "SERVICE_CODE" || "USAGE_TYPE" || "USAGE_TYPE_GROUP" || "RECORD_TYPE" || "OPERATING_SYSTEM" || "TENANCY" || "SCOPE" || "PLATFORM" || "SUBSCRIPTION_ID" || "LEGAL_ENTITY_NAME" || "DEPLOYMENT_OPTION" || "DATABASE_ENGINE" || "CACHE_ENGINE" || "INSTANCE_TYPE_FAMILY" || "BILLING_ENTITY" || "RESERVATION_ID" || "RESOURCE_ID" || "RIGHTSIZING_TYPE" || "SAVINGS_PLANS_TYPE" || "SAVINGS_PLAN_ARN" || "PAYMENT_OPTION" || "AGREEMENT_END_DATE_TIME_AFTER" || "AGREEMENT_END_DATE_TIME_BEFORE" || "INVOICING_ENTITY" || "ANOMALY_TOTAL_IMPACT_ABSOLUTE" || "ANOMALY_TOTAL_IMPACT_PERCENTAGE",
|
|
62
|
+
* Values: [ // Values
|
|
63
|
+
* "STRING_VALUE",
|
|
64
|
+
* ],
|
|
65
|
+
* MatchOptions: [ // MatchOptions
|
|
66
|
+
* "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
67
|
+
* ],
|
|
68
|
+
* },
|
|
69
|
+
* Tags: { // TagValues
|
|
70
|
+
* Key: "STRING_VALUE",
|
|
71
|
+
* Values: [
|
|
72
|
+
* "STRING_VALUE",
|
|
73
|
+
* ],
|
|
74
|
+
* MatchOptions: [
|
|
75
|
+
* "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
76
|
+
* ],
|
|
77
|
+
* },
|
|
78
|
+
* CostCategories: { // CostCategoryValues
|
|
79
|
+
* Key: "STRING_VALUE",
|
|
80
|
+
* Values: [
|
|
81
|
+
* "STRING_VALUE",
|
|
82
|
+
* ],
|
|
83
|
+
* MatchOptions: [
|
|
84
|
+
* "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
85
|
+
* ],
|
|
86
|
+
* },
|
|
87
|
+
* },
|
|
88
|
+
* ],
|
|
89
|
+
* And: [
|
|
90
|
+
* "<Expression>",
|
|
91
|
+
* ],
|
|
92
|
+
* Not: "<Expression>",
|
|
93
|
+
* Dimensions: {
|
|
94
|
+
* Key: "AZ" || "INSTANCE_TYPE" || "LINKED_ACCOUNT" || "LINKED_ACCOUNT_NAME" || "OPERATION" || "PURCHASE_TYPE" || "REGION" || "SERVICE" || "SERVICE_CODE" || "USAGE_TYPE" || "USAGE_TYPE_GROUP" || "RECORD_TYPE" || "OPERATING_SYSTEM" || "TENANCY" || "SCOPE" || "PLATFORM" || "SUBSCRIPTION_ID" || "LEGAL_ENTITY_NAME" || "DEPLOYMENT_OPTION" || "DATABASE_ENGINE" || "CACHE_ENGINE" || "INSTANCE_TYPE_FAMILY" || "BILLING_ENTITY" || "RESERVATION_ID" || "RESOURCE_ID" || "RIGHTSIZING_TYPE" || "SAVINGS_PLANS_TYPE" || "SAVINGS_PLAN_ARN" || "PAYMENT_OPTION" || "AGREEMENT_END_DATE_TIME_AFTER" || "AGREEMENT_END_DATE_TIME_BEFORE" || "INVOICING_ENTITY" || "ANOMALY_TOTAL_IMPACT_ABSOLUTE" || "ANOMALY_TOTAL_IMPACT_PERCENTAGE",
|
|
95
|
+
* Values: [
|
|
96
|
+
* "STRING_VALUE",
|
|
97
|
+
* ],
|
|
98
|
+
* MatchOptions: [
|
|
99
|
+
* "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
100
|
+
* ],
|
|
101
|
+
* },
|
|
102
|
+
* Tags: {
|
|
103
|
+
* Key: "STRING_VALUE",
|
|
104
|
+
* Values: [
|
|
105
|
+
* "STRING_VALUE",
|
|
106
|
+
* ],
|
|
107
|
+
* MatchOptions: [
|
|
108
|
+
* "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
109
|
+
* ],
|
|
110
|
+
* },
|
|
111
|
+
* CostCategories: {
|
|
112
|
+
* Key: "STRING_VALUE",
|
|
113
|
+
* Values: "<Values>",
|
|
114
|
+
* MatchOptions: "<MatchOptions>",
|
|
115
|
+
* },
|
|
116
|
+
* },
|
|
117
|
+
* GroupBy: [ // GroupDefinitions
|
|
118
|
+
* { // GroupDefinition
|
|
119
|
+
* Type: "DIMENSION" || "TAG" || "COST_CATEGORY",
|
|
120
|
+
* Key: "STRING_VALUE",
|
|
121
|
+
* },
|
|
122
|
+
* ],
|
|
123
|
+
* MaxResults: Number("int"),
|
|
124
|
+
* NextPageToken: "STRING_VALUE",
|
|
125
|
+
* };
|
|
126
|
+
* const command = new GetCostComparisonDriversCommand(input);
|
|
127
|
+
* const response = await client.send(command);
|
|
128
|
+
* // { // GetCostComparisonDriversResponse
|
|
129
|
+
* // CostComparisonDrivers: [ // CostComparisonDrivers
|
|
130
|
+
* // { // CostComparisonDriver
|
|
131
|
+
* // CostSelector: { // Expression
|
|
132
|
+
* // Or: [ // Expressions
|
|
133
|
+
* // {
|
|
134
|
+
* // Or: [
|
|
135
|
+
* // "<Expression>",
|
|
136
|
+
* // ],
|
|
137
|
+
* // And: [
|
|
138
|
+
* // "<Expression>",
|
|
139
|
+
* // ],
|
|
140
|
+
* // Not: "<Expression>",
|
|
141
|
+
* // Dimensions: { // DimensionValues
|
|
142
|
+
* // Key: "AZ" || "INSTANCE_TYPE" || "LINKED_ACCOUNT" || "LINKED_ACCOUNT_NAME" || "OPERATION" || "PURCHASE_TYPE" || "REGION" || "SERVICE" || "SERVICE_CODE" || "USAGE_TYPE" || "USAGE_TYPE_GROUP" || "RECORD_TYPE" || "OPERATING_SYSTEM" || "TENANCY" || "SCOPE" || "PLATFORM" || "SUBSCRIPTION_ID" || "LEGAL_ENTITY_NAME" || "DEPLOYMENT_OPTION" || "DATABASE_ENGINE" || "CACHE_ENGINE" || "INSTANCE_TYPE_FAMILY" || "BILLING_ENTITY" || "RESERVATION_ID" || "RESOURCE_ID" || "RIGHTSIZING_TYPE" || "SAVINGS_PLANS_TYPE" || "SAVINGS_PLAN_ARN" || "PAYMENT_OPTION" || "AGREEMENT_END_DATE_TIME_AFTER" || "AGREEMENT_END_DATE_TIME_BEFORE" || "INVOICING_ENTITY" || "ANOMALY_TOTAL_IMPACT_ABSOLUTE" || "ANOMALY_TOTAL_IMPACT_PERCENTAGE",
|
|
143
|
+
* // Values: [ // Values
|
|
144
|
+
* // "STRING_VALUE",
|
|
145
|
+
* // ],
|
|
146
|
+
* // MatchOptions: [ // MatchOptions
|
|
147
|
+
* // "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
148
|
+
* // ],
|
|
149
|
+
* // },
|
|
150
|
+
* // Tags: { // TagValues
|
|
151
|
+
* // Key: "STRING_VALUE",
|
|
152
|
+
* // Values: [
|
|
153
|
+
* // "STRING_VALUE",
|
|
154
|
+
* // ],
|
|
155
|
+
* // MatchOptions: [
|
|
156
|
+
* // "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
157
|
+
* // ],
|
|
158
|
+
* // },
|
|
159
|
+
* // CostCategories: { // CostCategoryValues
|
|
160
|
+
* // Key: "STRING_VALUE",
|
|
161
|
+
* // Values: [
|
|
162
|
+
* // "STRING_VALUE",
|
|
163
|
+
* // ],
|
|
164
|
+
* // MatchOptions: [
|
|
165
|
+
* // "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
166
|
+
* // ],
|
|
167
|
+
* // },
|
|
168
|
+
* // },
|
|
169
|
+
* // ],
|
|
170
|
+
* // And: [
|
|
171
|
+
* // "<Expression>",
|
|
172
|
+
* // ],
|
|
173
|
+
* // Not: "<Expression>",
|
|
174
|
+
* // Dimensions: {
|
|
175
|
+
* // Key: "AZ" || "INSTANCE_TYPE" || "LINKED_ACCOUNT" || "LINKED_ACCOUNT_NAME" || "OPERATION" || "PURCHASE_TYPE" || "REGION" || "SERVICE" || "SERVICE_CODE" || "USAGE_TYPE" || "USAGE_TYPE_GROUP" || "RECORD_TYPE" || "OPERATING_SYSTEM" || "TENANCY" || "SCOPE" || "PLATFORM" || "SUBSCRIPTION_ID" || "LEGAL_ENTITY_NAME" || "DEPLOYMENT_OPTION" || "DATABASE_ENGINE" || "CACHE_ENGINE" || "INSTANCE_TYPE_FAMILY" || "BILLING_ENTITY" || "RESERVATION_ID" || "RESOURCE_ID" || "RIGHTSIZING_TYPE" || "SAVINGS_PLANS_TYPE" || "SAVINGS_PLAN_ARN" || "PAYMENT_OPTION" || "AGREEMENT_END_DATE_TIME_AFTER" || "AGREEMENT_END_DATE_TIME_BEFORE" || "INVOICING_ENTITY" || "ANOMALY_TOTAL_IMPACT_ABSOLUTE" || "ANOMALY_TOTAL_IMPACT_PERCENTAGE",
|
|
176
|
+
* // Values: [
|
|
177
|
+
* // "STRING_VALUE",
|
|
178
|
+
* // ],
|
|
179
|
+
* // MatchOptions: [
|
|
180
|
+
* // "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
181
|
+
* // ],
|
|
182
|
+
* // },
|
|
183
|
+
* // Tags: {
|
|
184
|
+
* // Key: "STRING_VALUE",
|
|
185
|
+
* // Values: [
|
|
186
|
+
* // "STRING_VALUE",
|
|
187
|
+
* // ],
|
|
188
|
+
* // MatchOptions: [
|
|
189
|
+
* // "EQUALS" || "ABSENT" || "STARTS_WITH" || "ENDS_WITH" || "CONTAINS" || "CASE_SENSITIVE" || "CASE_INSENSITIVE" || "GREATER_THAN_OR_EQUAL",
|
|
190
|
+
* // ],
|
|
191
|
+
* // },
|
|
192
|
+
* // CostCategories: {
|
|
193
|
+
* // Key: "STRING_VALUE",
|
|
194
|
+
* // Values: "<Values>",
|
|
195
|
+
* // MatchOptions: "<MatchOptions>",
|
|
196
|
+
* // },
|
|
197
|
+
* // },
|
|
198
|
+
* // Metrics: { // ComparisonMetrics
|
|
199
|
+
* // "<keys>": { // ComparisonMetricValue
|
|
200
|
+
* // BaselineTimePeriodAmount: "STRING_VALUE",
|
|
201
|
+
* // ComparisonTimePeriodAmount: "STRING_VALUE",
|
|
202
|
+
* // Difference: "STRING_VALUE",
|
|
203
|
+
* // Unit: "STRING_VALUE",
|
|
204
|
+
* // },
|
|
205
|
+
* // },
|
|
206
|
+
* // CostDrivers: [ // CostDrivers
|
|
207
|
+
* // { // CostDriver
|
|
208
|
+
* // Type: "STRING_VALUE",
|
|
209
|
+
* // Name: "STRING_VALUE",
|
|
210
|
+
* // Metrics: {
|
|
211
|
+
* // "<keys>": {
|
|
212
|
+
* // BaselineTimePeriodAmount: "STRING_VALUE",
|
|
213
|
+
* // ComparisonTimePeriodAmount: "STRING_VALUE",
|
|
214
|
+
* // Difference: "STRING_VALUE",
|
|
215
|
+
* // Unit: "STRING_VALUE",
|
|
216
|
+
* // },
|
|
217
|
+
* // },
|
|
218
|
+
* // },
|
|
219
|
+
* // ],
|
|
220
|
+
* // },
|
|
221
|
+
* // ],
|
|
222
|
+
* // NextPageToken: "STRING_VALUE",
|
|
223
|
+
* // };
|
|
224
|
+
*
|
|
225
|
+
* ```
|
|
226
|
+
*
|
|
227
|
+
* @param GetCostComparisonDriversCommandInput - {@link GetCostComparisonDriversCommandInput}
|
|
228
|
+
* @returns {@link GetCostComparisonDriversCommandOutput}
|
|
229
|
+
* @see {@link GetCostComparisonDriversCommandInput} for command's `input` shape.
|
|
230
|
+
* @see {@link GetCostComparisonDriversCommandOutput} for command's `response` shape.
|
|
231
|
+
* @see {@link CostExplorerClientResolvedConfig | config} for CostExplorerClient's `config` shape.
|
|
232
|
+
*
|
|
233
|
+
* @throws {@link DataUnavailableException} (client fault)
|
|
234
|
+
* <p>The requested data is unavailable.</p>
|
|
235
|
+
*
|
|
236
|
+
* @throws {@link InvalidNextTokenException} (client fault)
|
|
237
|
+
* <p>The pagination token is invalid. Try again without a pagination token.</p>
|
|
238
|
+
*
|
|
239
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
240
|
+
* <p>You made too many calls in a short period of time. Try again later.</p>
|
|
241
|
+
*
|
|
242
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
243
|
+
* <p> The specified ARN in the request doesn't exist. </p>
|
|
244
|
+
*
|
|
245
|
+
* @throws {@link CostExplorerServiceException}
|
|
246
|
+
* <p>Base exception class for all service exceptions from CostExplorer service.</p>
|
|
247
|
+
*
|
|
248
|
+
*
|
|
249
|
+
* @public
|
|
250
|
+
*/
|
|
251
|
+
export declare class GetCostComparisonDriversCommand extends GetCostComparisonDriversCommand_base {
|
|
252
|
+
/** @internal type navigation helper, not in runtime. */
|
|
253
|
+
protected static __types: {
|
|
254
|
+
api: {
|
|
255
|
+
input: GetCostComparisonDriversRequest;
|
|
256
|
+
output: GetCostComparisonDriversResponse;
|
|
257
|
+
};
|
|
258
|
+
sdk: {
|
|
259
|
+
input: GetCostComparisonDriversCommandInput;
|
|
260
|
+
output: GetCostComparisonDriversCommandOutput;
|
|
261
|
+
};
|
|
262
|
+
};
|
|
263
|
+
}
|
|
@@ -11,8 +11,10 @@ export * from "./GetAnomalySubscriptionsCommand";
|
|
|
11
11
|
export * from "./GetApproximateUsageRecordsCommand";
|
|
12
12
|
export * from "./GetCommitmentPurchaseAnalysisCommand";
|
|
13
13
|
export * from "./GetCostAndUsageCommand";
|
|
14
|
+
export * from "./GetCostAndUsageComparisonsCommand";
|
|
14
15
|
export * from "./GetCostAndUsageWithResourcesCommand";
|
|
15
16
|
export * from "./GetCostCategoriesCommand";
|
|
17
|
+
export * from "./GetCostComparisonDriversCommand";
|
|
16
18
|
export * from "./GetCostForecastCommand";
|
|
17
19
|
export * from "./GetDimensionValuesCommand";
|
|
18
20
|
export * from "./GetReservationCoverageCommand";
|