@aws-sdk/client-cost-explorer 3.693.0 → 3.698.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 +24 -0
- package/dist-cjs/index.js +301 -36
- package/dist-es/CostExplorer.js +6 -0
- package/dist-es/commands/GetCommitmentPurchaseAnalysisCommand.js +22 -0
- package/dist-es/commands/ListCommitmentPurchaseAnalysesCommand.js +22 -0
- package/dist-es/commands/StartCommitmentPurchaseAnalysisCommand.js +22 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/models_0.js +54 -25
- package/dist-es/protocols/Aws_json1_1.js +182 -4
- package/dist-types/CostExplorer.d.ts +22 -0
- package/dist-types/CostExplorerClient.d.ts +5 -2
- package/dist-types/commands/GetCommitmentPurchaseAnalysisCommand.d.ts +146 -0
- package/dist-types/commands/ListCommitmentPurchaseAnalysesCommand.d.ts +121 -0
- package/dist-types/commands/StartCommitmentPurchaseAnalysisCommand.d.ts +113 -0
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +609 -112
- package/dist-types/protocols/Aws_json1_1.d.ts +27 -0
- package/dist-types/ts3.4/CostExplorer.d.ts +52 -0
- package/dist-types/ts3.4/CostExplorerClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/GetCommitmentPurchaseAnalysisCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListCommitmentPurchaseAnalysesCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartCommitmentPurchaseAnalysisCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/models_0.d.ts +165 -40
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
- package/package.json +35 -35
|
@@ -18,6 +18,7 @@ import { GetAnomaliesCommandInput, GetAnomaliesCommandOutput } from "./commands/
|
|
|
18
18
|
import { GetAnomalyMonitorsCommandInput, GetAnomalyMonitorsCommandOutput } from "./commands/GetAnomalyMonitorsCommand";
|
|
19
19
|
import { GetAnomalySubscriptionsCommandInput, GetAnomalySubscriptionsCommandOutput } from "./commands/GetAnomalySubscriptionsCommand";
|
|
20
20
|
import { GetApproximateUsageRecordsCommandInput, GetApproximateUsageRecordsCommandOutput } from "./commands/GetApproximateUsageRecordsCommand";
|
|
21
|
+
import { GetCommitmentPurchaseAnalysisCommandInput, GetCommitmentPurchaseAnalysisCommandOutput } from "./commands/GetCommitmentPurchaseAnalysisCommand";
|
|
21
22
|
import { GetCostAndUsageCommandInput, GetCostAndUsageCommandOutput } from "./commands/GetCostAndUsageCommand";
|
|
22
23
|
import { GetCostAndUsageWithResourcesCommandInput, GetCostAndUsageWithResourcesCommandOutput } from "./commands/GetCostAndUsageWithResourcesCommand";
|
|
23
24
|
import { GetCostCategoriesCommandInput, GetCostCategoriesCommandOutput } from "./commands/GetCostCategoriesCommand";
|
|
@@ -34,12 +35,14 @@ import { GetSavingsPlansUtilizationCommandInput, GetSavingsPlansUtilizationComma
|
|
|
34
35
|
import { GetSavingsPlansUtilizationDetailsCommandInput, GetSavingsPlansUtilizationDetailsCommandOutput } from "./commands/GetSavingsPlansUtilizationDetailsCommand";
|
|
35
36
|
import { GetTagsCommandInput, GetTagsCommandOutput } from "./commands/GetTagsCommand";
|
|
36
37
|
import { GetUsageForecastCommandInput, GetUsageForecastCommandOutput } from "./commands/GetUsageForecastCommand";
|
|
38
|
+
import { ListCommitmentPurchaseAnalysesCommandInput, ListCommitmentPurchaseAnalysesCommandOutput } from "./commands/ListCommitmentPurchaseAnalysesCommand";
|
|
37
39
|
import { ListCostAllocationTagBackfillHistoryCommandInput, ListCostAllocationTagBackfillHistoryCommandOutput } from "./commands/ListCostAllocationTagBackfillHistoryCommand";
|
|
38
40
|
import { ListCostAllocationTagsCommandInput, ListCostAllocationTagsCommandOutput } from "./commands/ListCostAllocationTagsCommand";
|
|
39
41
|
import { ListCostCategoryDefinitionsCommandInput, ListCostCategoryDefinitionsCommandOutput } from "./commands/ListCostCategoryDefinitionsCommand";
|
|
40
42
|
import { ListSavingsPlansPurchaseRecommendationGenerationCommandInput, ListSavingsPlansPurchaseRecommendationGenerationCommandOutput } from "./commands/ListSavingsPlansPurchaseRecommendationGenerationCommand";
|
|
41
43
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
42
44
|
import { ProvideAnomalyFeedbackCommandInput, ProvideAnomalyFeedbackCommandOutput } from "./commands/ProvideAnomalyFeedbackCommand";
|
|
45
|
+
import { StartCommitmentPurchaseAnalysisCommandInput, StartCommitmentPurchaseAnalysisCommandOutput } from "./commands/StartCommitmentPurchaseAnalysisCommand";
|
|
43
46
|
import { StartCostAllocationTagBackfillCommandInput, StartCostAllocationTagBackfillCommandOutput } from "./commands/StartCostAllocationTagBackfillCommand";
|
|
44
47
|
import { StartSavingsPlansPurchaseRecommendationGenerationCommandInput, StartSavingsPlansPurchaseRecommendationGenerationCommandOutput } from "./commands/StartSavingsPlansPurchaseRecommendationGenerationCommand";
|
|
45
48
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
@@ -54,11 +57,11 @@ export { __Client };
|
|
|
54
57
|
/**
|
|
55
58
|
* @public
|
|
56
59
|
*/
|
|
57
|
-
export type ServiceInputTypes = CreateAnomalyMonitorCommandInput | CreateAnomalySubscriptionCommandInput | CreateCostCategoryDefinitionCommandInput | DeleteAnomalyMonitorCommandInput | DeleteAnomalySubscriptionCommandInput | DeleteCostCategoryDefinitionCommandInput | DescribeCostCategoryDefinitionCommandInput | GetAnomaliesCommandInput | GetAnomalyMonitorsCommandInput | GetAnomalySubscriptionsCommandInput | GetApproximateUsageRecordsCommandInput | GetCostAndUsageCommandInput | GetCostAndUsageWithResourcesCommandInput | GetCostCategoriesCommandInput | GetCostForecastCommandInput | GetDimensionValuesCommandInput | GetReservationCoverageCommandInput | GetReservationPurchaseRecommendationCommandInput | GetReservationUtilizationCommandInput | GetRightsizingRecommendationCommandInput | GetSavingsPlanPurchaseRecommendationDetailsCommandInput | GetSavingsPlansCoverageCommandInput | GetSavingsPlansPurchaseRecommendationCommandInput | GetSavingsPlansUtilizationCommandInput | GetSavingsPlansUtilizationDetailsCommandInput | GetTagsCommandInput | GetUsageForecastCommandInput | ListCostAllocationTagBackfillHistoryCommandInput | ListCostAllocationTagsCommandInput | ListCostCategoryDefinitionsCommandInput | ListSavingsPlansPurchaseRecommendationGenerationCommandInput | ListTagsForResourceCommandInput | ProvideAnomalyFeedbackCommandInput | StartCostAllocationTagBackfillCommandInput | StartSavingsPlansPurchaseRecommendationGenerationCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAnomalyMonitorCommandInput | UpdateAnomalySubscriptionCommandInput | UpdateCostAllocationTagsStatusCommandInput | UpdateCostCategoryDefinitionCommandInput;
|
|
60
|
+
export type ServiceInputTypes = CreateAnomalyMonitorCommandInput | CreateAnomalySubscriptionCommandInput | CreateCostCategoryDefinitionCommandInput | DeleteAnomalyMonitorCommandInput | DeleteAnomalySubscriptionCommandInput | DeleteCostCategoryDefinitionCommandInput | DescribeCostCategoryDefinitionCommandInput | GetAnomaliesCommandInput | GetAnomalyMonitorsCommandInput | GetAnomalySubscriptionsCommandInput | GetApproximateUsageRecordsCommandInput | GetCommitmentPurchaseAnalysisCommandInput | GetCostAndUsageCommandInput | GetCostAndUsageWithResourcesCommandInput | GetCostCategoriesCommandInput | GetCostForecastCommandInput | GetDimensionValuesCommandInput | GetReservationCoverageCommandInput | GetReservationPurchaseRecommendationCommandInput | GetReservationUtilizationCommandInput | GetRightsizingRecommendationCommandInput | GetSavingsPlanPurchaseRecommendationDetailsCommandInput | GetSavingsPlansCoverageCommandInput | GetSavingsPlansPurchaseRecommendationCommandInput | GetSavingsPlansUtilizationCommandInput | GetSavingsPlansUtilizationDetailsCommandInput | GetTagsCommandInput | GetUsageForecastCommandInput | ListCommitmentPurchaseAnalysesCommandInput | ListCostAllocationTagBackfillHistoryCommandInput | ListCostAllocationTagsCommandInput | ListCostCategoryDefinitionsCommandInput | ListSavingsPlansPurchaseRecommendationGenerationCommandInput | ListTagsForResourceCommandInput | ProvideAnomalyFeedbackCommandInput | StartCommitmentPurchaseAnalysisCommandInput | StartCostAllocationTagBackfillCommandInput | StartSavingsPlansPurchaseRecommendationGenerationCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAnomalyMonitorCommandInput | UpdateAnomalySubscriptionCommandInput | UpdateCostAllocationTagsStatusCommandInput | UpdateCostCategoryDefinitionCommandInput;
|
|
58
61
|
/**
|
|
59
62
|
* @public
|
|
60
63
|
*/
|
|
61
|
-
export type ServiceOutputTypes = CreateAnomalyMonitorCommandOutput | CreateAnomalySubscriptionCommandOutput | CreateCostCategoryDefinitionCommandOutput | DeleteAnomalyMonitorCommandOutput | DeleteAnomalySubscriptionCommandOutput | DeleteCostCategoryDefinitionCommandOutput | DescribeCostCategoryDefinitionCommandOutput | GetAnomaliesCommandOutput | GetAnomalyMonitorsCommandOutput | GetAnomalySubscriptionsCommandOutput | GetApproximateUsageRecordsCommandOutput | GetCostAndUsageCommandOutput | GetCostAndUsageWithResourcesCommandOutput | GetCostCategoriesCommandOutput | GetCostForecastCommandOutput | GetDimensionValuesCommandOutput | GetReservationCoverageCommandOutput | GetReservationPurchaseRecommendationCommandOutput | GetReservationUtilizationCommandOutput | GetRightsizingRecommendationCommandOutput | GetSavingsPlanPurchaseRecommendationDetailsCommandOutput | GetSavingsPlansCoverageCommandOutput | GetSavingsPlansPurchaseRecommendationCommandOutput | GetSavingsPlansUtilizationCommandOutput | GetSavingsPlansUtilizationDetailsCommandOutput | GetTagsCommandOutput | GetUsageForecastCommandOutput | ListCostAllocationTagBackfillHistoryCommandOutput | ListCostAllocationTagsCommandOutput | ListCostCategoryDefinitionsCommandOutput | ListSavingsPlansPurchaseRecommendationGenerationCommandOutput | ListTagsForResourceCommandOutput | ProvideAnomalyFeedbackCommandOutput | StartCostAllocationTagBackfillCommandOutput | StartSavingsPlansPurchaseRecommendationGenerationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAnomalyMonitorCommandOutput | UpdateAnomalySubscriptionCommandOutput | UpdateCostAllocationTagsStatusCommandOutput | UpdateCostCategoryDefinitionCommandOutput;
|
|
64
|
+
export type ServiceOutputTypes = CreateAnomalyMonitorCommandOutput | CreateAnomalySubscriptionCommandOutput | CreateCostCategoryDefinitionCommandOutput | DeleteAnomalyMonitorCommandOutput | DeleteAnomalySubscriptionCommandOutput | DeleteCostCategoryDefinitionCommandOutput | DescribeCostCategoryDefinitionCommandOutput | GetAnomaliesCommandOutput | GetAnomalyMonitorsCommandOutput | GetAnomalySubscriptionsCommandOutput | GetApproximateUsageRecordsCommandOutput | GetCommitmentPurchaseAnalysisCommandOutput | GetCostAndUsageCommandOutput | GetCostAndUsageWithResourcesCommandOutput | GetCostCategoriesCommandOutput | GetCostForecastCommandOutput | GetDimensionValuesCommandOutput | GetReservationCoverageCommandOutput | GetReservationPurchaseRecommendationCommandOutput | GetReservationUtilizationCommandOutput | GetRightsizingRecommendationCommandOutput | GetSavingsPlanPurchaseRecommendationDetailsCommandOutput | GetSavingsPlansCoverageCommandOutput | GetSavingsPlansPurchaseRecommendationCommandOutput | GetSavingsPlansUtilizationCommandOutput | GetSavingsPlansUtilizationDetailsCommandOutput | GetTagsCommandOutput | GetUsageForecastCommandOutput | ListCommitmentPurchaseAnalysesCommandOutput | ListCostAllocationTagBackfillHistoryCommandOutput | ListCostAllocationTagsCommandOutput | ListCostCategoryDefinitionsCommandOutput | ListSavingsPlansPurchaseRecommendationGenerationCommandOutput | ListTagsForResourceCommandOutput | ProvideAnomalyFeedbackCommandOutput | StartCommitmentPurchaseAnalysisCommandOutput | StartCostAllocationTagBackfillCommandOutput | StartSavingsPlansPurchaseRecommendationGenerationCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAnomalyMonitorCommandOutput | UpdateAnomalySubscriptionCommandOutput | UpdateCostAllocationTagsStatusCommandOutput | UpdateCostCategoryDefinitionCommandOutput;
|
|
62
65
|
/**
|
|
63
66
|
* @public
|
|
64
67
|
*/
|
|
@@ -0,0 +1,146 @@
|
|
|
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 { GetCommitmentPurchaseAnalysisRequest, GetCommitmentPurchaseAnalysisResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetCommitmentPurchaseAnalysisCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetCommitmentPurchaseAnalysisCommandInput extends GetCommitmentPurchaseAnalysisRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetCommitmentPurchaseAnalysisCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetCommitmentPurchaseAnalysisCommandOutput extends GetCommitmentPurchaseAnalysisResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetCommitmentPurchaseAnalysisCommand_base: {
|
|
25
|
+
new (input: GetCommitmentPurchaseAnalysisCommandInput): import("@smithy/smithy-client").CommandImpl<GetCommitmentPurchaseAnalysisCommandInput, GetCommitmentPurchaseAnalysisCommandOutput, CostExplorerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetCommitmentPurchaseAnalysisCommandInput): import("@smithy/smithy-client").CommandImpl<GetCommitmentPurchaseAnalysisCommandInput, GetCommitmentPurchaseAnalysisCommandOutput, CostExplorerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Retrieves a commitment purchase analysis result based on the
|
|
31
|
+
* <code>AnalysisId</code>.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { CostExplorerClient, GetCommitmentPurchaseAnalysisCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import
|
|
36
|
+
* // const { CostExplorerClient, GetCommitmentPurchaseAnalysisCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import
|
|
37
|
+
* const client = new CostExplorerClient(config);
|
|
38
|
+
* const input = { // GetCommitmentPurchaseAnalysisRequest
|
|
39
|
+
* AnalysisId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetCommitmentPurchaseAnalysisCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GetCommitmentPurchaseAnalysisResponse
|
|
44
|
+
* // EstimatedCompletionTime: "STRING_VALUE", // required
|
|
45
|
+
* // AnalysisCompletionTime: "STRING_VALUE",
|
|
46
|
+
* // AnalysisStartedTime: "STRING_VALUE", // required
|
|
47
|
+
* // AnalysisId: "STRING_VALUE", // required
|
|
48
|
+
* // AnalysisStatus: "SUCCEEDED" || "PROCESSING" || "FAILED", // required
|
|
49
|
+
* // ErrorCode: "NO_USAGE_FOUND" || "INTERNAL_FAILURE" || "INVALID_SAVINGS_PLANS_TO_ADD" || "INVALID_SAVINGS_PLANS_TO_EXCLUDE" || "INVALID_ACCOUNT_ID",
|
|
50
|
+
* // AnalysisDetails: { // AnalysisDetails
|
|
51
|
+
* // SavingsPlansPurchaseAnalysisDetails: { // SavingsPlansPurchaseAnalysisDetails
|
|
52
|
+
* // CurrencyCode: "STRING_VALUE",
|
|
53
|
+
* // LookbackPeriodInHours: "STRING_VALUE",
|
|
54
|
+
* // CurrentAverageCoverage: "STRING_VALUE",
|
|
55
|
+
* // CurrentAverageHourlyOnDemandSpend: "STRING_VALUE",
|
|
56
|
+
* // CurrentMaximumHourlyOnDemandSpend: "STRING_VALUE",
|
|
57
|
+
* // CurrentMinimumHourlyOnDemandSpend: "STRING_VALUE",
|
|
58
|
+
* // CurrentOnDemandSpend: "STRING_VALUE",
|
|
59
|
+
* // ExistingHourlyCommitment: "STRING_VALUE",
|
|
60
|
+
* // HourlyCommitmentToPurchase: "STRING_VALUE",
|
|
61
|
+
* // EstimatedAverageCoverage: "STRING_VALUE",
|
|
62
|
+
* // EstimatedAverageUtilization: "STRING_VALUE",
|
|
63
|
+
* // EstimatedMonthlySavingsAmount: "STRING_VALUE",
|
|
64
|
+
* // EstimatedOnDemandCost: "STRING_VALUE",
|
|
65
|
+
* // EstimatedOnDemandCostWithCurrentCommitment: "STRING_VALUE",
|
|
66
|
+
* // EstimatedROI: "STRING_VALUE",
|
|
67
|
+
* // EstimatedSavingsAmount: "STRING_VALUE",
|
|
68
|
+
* // EstimatedSavingsPercentage: "STRING_VALUE",
|
|
69
|
+
* // EstimatedCommitmentCost: "STRING_VALUE",
|
|
70
|
+
* // LatestUsageTimestamp: "STRING_VALUE",
|
|
71
|
+
* // UpfrontCost: "STRING_VALUE",
|
|
72
|
+
* // AdditionalMetadata: "STRING_VALUE",
|
|
73
|
+
* // MetricsOverLookbackPeriod: [ // MetricsOverLookbackPeriod
|
|
74
|
+
* // { // RecommendationDetailHourlyMetrics
|
|
75
|
+
* // StartTime: "STRING_VALUE",
|
|
76
|
+
* // EstimatedOnDemandCost: "STRING_VALUE",
|
|
77
|
+
* // CurrentCoverage: "STRING_VALUE",
|
|
78
|
+
* // EstimatedCoverage: "STRING_VALUE",
|
|
79
|
+
* // EstimatedNewCommitmentUtilization: "STRING_VALUE",
|
|
80
|
+
* // },
|
|
81
|
+
* // ],
|
|
82
|
+
* // },
|
|
83
|
+
* // },
|
|
84
|
+
* // CommitmentPurchaseAnalysisConfiguration: { // CommitmentPurchaseAnalysisConfiguration
|
|
85
|
+
* // SavingsPlansPurchaseAnalysisConfiguration: { // SavingsPlansPurchaseAnalysisConfiguration
|
|
86
|
+
* // AccountScope: "PAYER" || "LINKED",
|
|
87
|
+
* // AccountId: "STRING_VALUE",
|
|
88
|
+
* // AnalysisType: "MAX_SAVINGS" || "CUSTOM_COMMITMENT", // required
|
|
89
|
+
* // SavingsPlansToAdd: [ // SavingsPlansToAdd // required
|
|
90
|
+
* // { // SavingsPlans
|
|
91
|
+
* // PaymentOption: "NO_UPFRONT" || "PARTIAL_UPFRONT" || "ALL_UPFRONT" || "LIGHT_UTILIZATION" || "MEDIUM_UTILIZATION" || "HEAVY_UTILIZATION",
|
|
92
|
+
* // SavingsPlansType: "COMPUTE_SP" || "EC2_INSTANCE_SP" || "SAGEMAKER_SP",
|
|
93
|
+
* // Region: "STRING_VALUE",
|
|
94
|
+
* // InstanceFamily: "STRING_VALUE",
|
|
95
|
+
* // TermInYears: "ONE_YEAR" || "THREE_YEARS",
|
|
96
|
+
* // SavingsPlansCommitment: Number("double"),
|
|
97
|
+
* // OfferingId: "STRING_VALUE",
|
|
98
|
+
* // },
|
|
99
|
+
* // ],
|
|
100
|
+
* // SavingsPlansToExclude: [ // SavingsPlansToExclude
|
|
101
|
+
* // "STRING_VALUE",
|
|
102
|
+
* // ],
|
|
103
|
+
* // LookBackTimePeriod: { // DateInterval
|
|
104
|
+
* // Start: "STRING_VALUE", // required
|
|
105
|
+
* // End: "STRING_VALUE", // required
|
|
106
|
+
* // },
|
|
107
|
+
* // },
|
|
108
|
+
* // },
|
|
109
|
+
* // };
|
|
110
|
+
*
|
|
111
|
+
* ```
|
|
112
|
+
*
|
|
113
|
+
* @param GetCommitmentPurchaseAnalysisCommandInput - {@link GetCommitmentPurchaseAnalysisCommandInput}
|
|
114
|
+
* @returns {@link GetCommitmentPurchaseAnalysisCommandOutput}
|
|
115
|
+
* @see {@link GetCommitmentPurchaseAnalysisCommandInput} for command's `input` shape.
|
|
116
|
+
* @see {@link GetCommitmentPurchaseAnalysisCommandOutput} for command's `response` shape.
|
|
117
|
+
* @see {@link CostExplorerClientResolvedConfig | config} for CostExplorerClient's `config` shape.
|
|
118
|
+
*
|
|
119
|
+
* @throws {@link AnalysisNotFoundException} (client fault)
|
|
120
|
+
* <p>The requested analysis can't be
|
|
121
|
+
* found.</p>
|
|
122
|
+
*
|
|
123
|
+
* @throws {@link DataUnavailableException} (client fault)
|
|
124
|
+
* <p>The requested data is unavailable.</p>
|
|
125
|
+
*
|
|
126
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
127
|
+
* <p>You made too many calls in a short period of time. Try again later.</p>
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link CostExplorerServiceException}
|
|
130
|
+
* <p>Base exception class for all service exceptions from CostExplorer service.</p>
|
|
131
|
+
*
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
export declare class GetCommitmentPurchaseAnalysisCommand extends GetCommitmentPurchaseAnalysisCommand_base {
|
|
135
|
+
/** @internal type navigation helper, not in runtime. */
|
|
136
|
+
protected static __types: {
|
|
137
|
+
api: {
|
|
138
|
+
input: GetCommitmentPurchaseAnalysisRequest;
|
|
139
|
+
output: GetCommitmentPurchaseAnalysisResponse;
|
|
140
|
+
};
|
|
141
|
+
sdk: {
|
|
142
|
+
input: GetCommitmentPurchaseAnalysisCommandInput;
|
|
143
|
+
output: GetCommitmentPurchaseAnalysisCommandOutput;
|
|
144
|
+
};
|
|
145
|
+
};
|
|
146
|
+
}
|
|
@@ -0,0 +1,121 @@
|
|
|
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 { ListCommitmentPurchaseAnalysesRequest, ListCommitmentPurchaseAnalysesResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListCommitmentPurchaseAnalysesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListCommitmentPurchaseAnalysesCommandInput extends ListCommitmentPurchaseAnalysesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListCommitmentPurchaseAnalysesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListCommitmentPurchaseAnalysesCommandOutput extends ListCommitmentPurchaseAnalysesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListCommitmentPurchaseAnalysesCommand_base: {
|
|
25
|
+
new (input: ListCommitmentPurchaseAnalysesCommandInput): import("@smithy/smithy-client").CommandImpl<ListCommitmentPurchaseAnalysesCommandInput, ListCommitmentPurchaseAnalysesCommandOutput, CostExplorerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [ListCommitmentPurchaseAnalysesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListCommitmentPurchaseAnalysesCommandInput, ListCommitmentPurchaseAnalysesCommandOutput, CostExplorerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Lists the commitment purchase analyses for your account based on the last 30
|
|
31
|
+
* days.</p>
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { CostExplorerClient, ListCommitmentPurchaseAnalysesCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import
|
|
36
|
+
* // const { CostExplorerClient, ListCommitmentPurchaseAnalysesCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import
|
|
37
|
+
* const client = new CostExplorerClient(config);
|
|
38
|
+
* const input = { // ListCommitmentPurchaseAnalysesRequest
|
|
39
|
+
* AnalysisStatus: "SUCCEEDED" || "PROCESSING" || "FAILED",
|
|
40
|
+
* NextPageToken: "STRING_VALUE",
|
|
41
|
+
* PageSize: Number("int"),
|
|
42
|
+
* AnalysisIds: [ // AnalysisIds
|
|
43
|
+
* "STRING_VALUE",
|
|
44
|
+
* ],
|
|
45
|
+
* };
|
|
46
|
+
* const command = new ListCommitmentPurchaseAnalysesCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // ListCommitmentPurchaseAnalysesResponse
|
|
49
|
+
* // AnalysisSummaryList: [ // AnalysisSummaryList
|
|
50
|
+
* // { // AnalysisSummary
|
|
51
|
+
* // EstimatedCompletionTime: "STRING_VALUE",
|
|
52
|
+
* // AnalysisCompletionTime: "STRING_VALUE",
|
|
53
|
+
* // AnalysisStartedTime: "STRING_VALUE",
|
|
54
|
+
* // AnalysisStatus: "SUCCEEDED" || "PROCESSING" || "FAILED",
|
|
55
|
+
* // ErrorCode: "NO_USAGE_FOUND" || "INTERNAL_FAILURE" || "INVALID_SAVINGS_PLANS_TO_ADD" || "INVALID_SAVINGS_PLANS_TO_EXCLUDE" || "INVALID_ACCOUNT_ID",
|
|
56
|
+
* // AnalysisId: "STRING_VALUE",
|
|
57
|
+
* // CommitmentPurchaseAnalysisConfiguration: { // CommitmentPurchaseAnalysisConfiguration
|
|
58
|
+
* // SavingsPlansPurchaseAnalysisConfiguration: { // SavingsPlansPurchaseAnalysisConfiguration
|
|
59
|
+
* // AccountScope: "PAYER" || "LINKED",
|
|
60
|
+
* // AccountId: "STRING_VALUE",
|
|
61
|
+
* // AnalysisType: "MAX_SAVINGS" || "CUSTOM_COMMITMENT", // required
|
|
62
|
+
* // SavingsPlansToAdd: [ // SavingsPlansToAdd // required
|
|
63
|
+
* // { // SavingsPlans
|
|
64
|
+
* // PaymentOption: "NO_UPFRONT" || "PARTIAL_UPFRONT" || "ALL_UPFRONT" || "LIGHT_UTILIZATION" || "MEDIUM_UTILIZATION" || "HEAVY_UTILIZATION",
|
|
65
|
+
* // SavingsPlansType: "COMPUTE_SP" || "EC2_INSTANCE_SP" || "SAGEMAKER_SP",
|
|
66
|
+
* // Region: "STRING_VALUE",
|
|
67
|
+
* // InstanceFamily: "STRING_VALUE",
|
|
68
|
+
* // TermInYears: "ONE_YEAR" || "THREE_YEARS",
|
|
69
|
+
* // SavingsPlansCommitment: Number("double"),
|
|
70
|
+
* // OfferingId: "STRING_VALUE",
|
|
71
|
+
* // },
|
|
72
|
+
* // ],
|
|
73
|
+
* // SavingsPlansToExclude: [ // SavingsPlansToExclude
|
|
74
|
+
* // "STRING_VALUE",
|
|
75
|
+
* // ],
|
|
76
|
+
* // LookBackTimePeriod: { // DateInterval
|
|
77
|
+
* // Start: "STRING_VALUE", // required
|
|
78
|
+
* // End: "STRING_VALUE", // required
|
|
79
|
+
* // },
|
|
80
|
+
* // },
|
|
81
|
+
* // },
|
|
82
|
+
* // },
|
|
83
|
+
* // ],
|
|
84
|
+
* // NextPageToken: "STRING_VALUE",
|
|
85
|
+
* // };
|
|
86
|
+
*
|
|
87
|
+
* ```
|
|
88
|
+
*
|
|
89
|
+
* @param ListCommitmentPurchaseAnalysesCommandInput - {@link ListCommitmentPurchaseAnalysesCommandInput}
|
|
90
|
+
* @returns {@link ListCommitmentPurchaseAnalysesCommandOutput}
|
|
91
|
+
* @see {@link ListCommitmentPurchaseAnalysesCommandInput} for command's `input` shape.
|
|
92
|
+
* @see {@link ListCommitmentPurchaseAnalysesCommandOutput} for command's `response` shape.
|
|
93
|
+
* @see {@link CostExplorerClientResolvedConfig | config} for CostExplorerClient's `config` shape.
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link DataUnavailableException} (client fault)
|
|
96
|
+
* <p>The requested data is unavailable.</p>
|
|
97
|
+
*
|
|
98
|
+
* @throws {@link InvalidNextTokenException} (client fault)
|
|
99
|
+
* <p>The pagination token is invalid. Try again without a pagination token.</p>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
102
|
+
* <p>You made too many calls in a short period of time. Try again later.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link CostExplorerServiceException}
|
|
105
|
+
* <p>Base exception class for all service exceptions from CostExplorer service.</p>
|
|
106
|
+
*
|
|
107
|
+
* @public
|
|
108
|
+
*/
|
|
109
|
+
export declare class ListCommitmentPurchaseAnalysesCommand extends ListCommitmentPurchaseAnalysesCommand_base {
|
|
110
|
+
/** @internal type navigation helper, not in runtime. */
|
|
111
|
+
protected static __types: {
|
|
112
|
+
api: {
|
|
113
|
+
input: ListCommitmentPurchaseAnalysesRequest;
|
|
114
|
+
output: ListCommitmentPurchaseAnalysesResponse;
|
|
115
|
+
};
|
|
116
|
+
sdk: {
|
|
117
|
+
input: ListCommitmentPurchaseAnalysesCommandInput;
|
|
118
|
+
output: ListCommitmentPurchaseAnalysesCommandOutput;
|
|
119
|
+
};
|
|
120
|
+
};
|
|
121
|
+
}
|
|
@@ -0,0 +1,113 @@
|
|
|
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 { StartCommitmentPurchaseAnalysisRequest, StartCommitmentPurchaseAnalysisResponse } from "../models/models_0";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link StartCommitmentPurchaseAnalysisCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface StartCommitmentPurchaseAnalysisCommandInput extends StartCommitmentPurchaseAnalysisRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link StartCommitmentPurchaseAnalysisCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface StartCommitmentPurchaseAnalysisCommandOutput extends StartCommitmentPurchaseAnalysisResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const StartCommitmentPurchaseAnalysisCommand_base: {
|
|
25
|
+
new (input: StartCommitmentPurchaseAnalysisCommandInput): import("@smithy/smithy-client").CommandImpl<StartCommitmentPurchaseAnalysisCommandInput, StartCommitmentPurchaseAnalysisCommandOutput, CostExplorerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: StartCommitmentPurchaseAnalysisCommandInput): import("@smithy/smithy-client").CommandImpl<StartCommitmentPurchaseAnalysisCommandInput, StartCommitmentPurchaseAnalysisCommandOutput, CostExplorerClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Specifies the parameters of a planned commitment purchase and starts the generation of the
|
|
31
|
+
* analysis. This enables you to estimate the cost, coverage, and utilization impact of your
|
|
32
|
+
* planned commitment purchases. You can request up to 20 analysis runs per
|
|
33
|
+
* day.</p>
|
|
34
|
+
* @example
|
|
35
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
+
* ```javascript
|
|
37
|
+
* import { CostExplorerClient, StartCommitmentPurchaseAnalysisCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import
|
|
38
|
+
* // const { CostExplorerClient, StartCommitmentPurchaseAnalysisCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import
|
|
39
|
+
* const client = new CostExplorerClient(config);
|
|
40
|
+
* const input = { // StartCommitmentPurchaseAnalysisRequest
|
|
41
|
+
* CommitmentPurchaseAnalysisConfiguration: { // CommitmentPurchaseAnalysisConfiguration
|
|
42
|
+
* SavingsPlansPurchaseAnalysisConfiguration: { // SavingsPlansPurchaseAnalysisConfiguration
|
|
43
|
+
* AccountScope: "PAYER" || "LINKED",
|
|
44
|
+
* AccountId: "STRING_VALUE",
|
|
45
|
+
* AnalysisType: "MAX_SAVINGS" || "CUSTOM_COMMITMENT", // required
|
|
46
|
+
* SavingsPlansToAdd: [ // SavingsPlansToAdd // required
|
|
47
|
+
* { // SavingsPlans
|
|
48
|
+
* PaymentOption: "NO_UPFRONT" || "PARTIAL_UPFRONT" || "ALL_UPFRONT" || "LIGHT_UTILIZATION" || "MEDIUM_UTILIZATION" || "HEAVY_UTILIZATION",
|
|
49
|
+
* SavingsPlansType: "COMPUTE_SP" || "EC2_INSTANCE_SP" || "SAGEMAKER_SP",
|
|
50
|
+
* Region: "STRING_VALUE",
|
|
51
|
+
* InstanceFamily: "STRING_VALUE",
|
|
52
|
+
* TermInYears: "ONE_YEAR" || "THREE_YEARS",
|
|
53
|
+
* SavingsPlansCommitment: Number("double"),
|
|
54
|
+
* OfferingId: "STRING_VALUE",
|
|
55
|
+
* },
|
|
56
|
+
* ],
|
|
57
|
+
* SavingsPlansToExclude: [ // SavingsPlansToExclude
|
|
58
|
+
* "STRING_VALUE",
|
|
59
|
+
* ],
|
|
60
|
+
* LookBackTimePeriod: { // DateInterval
|
|
61
|
+
* Start: "STRING_VALUE", // required
|
|
62
|
+
* End: "STRING_VALUE", // required
|
|
63
|
+
* },
|
|
64
|
+
* },
|
|
65
|
+
* },
|
|
66
|
+
* };
|
|
67
|
+
* const command = new StartCommitmentPurchaseAnalysisCommand(input);
|
|
68
|
+
* const response = await client.send(command);
|
|
69
|
+
* // { // StartCommitmentPurchaseAnalysisResponse
|
|
70
|
+
* // AnalysisId: "STRING_VALUE", // required
|
|
71
|
+
* // AnalysisStartedTime: "STRING_VALUE", // required
|
|
72
|
+
* // EstimatedCompletionTime: "STRING_VALUE", // required
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
75
|
+
* ```
|
|
76
|
+
*
|
|
77
|
+
* @param StartCommitmentPurchaseAnalysisCommandInput - {@link StartCommitmentPurchaseAnalysisCommandInput}
|
|
78
|
+
* @returns {@link StartCommitmentPurchaseAnalysisCommandOutput}
|
|
79
|
+
* @see {@link StartCommitmentPurchaseAnalysisCommandInput} for command's `input` shape.
|
|
80
|
+
* @see {@link StartCommitmentPurchaseAnalysisCommandOutput} for command's `response` shape.
|
|
81
|
+
* @see {@link CostExplorerClientResolvedConfig | config} for CostExplorerClient's `config` shape.
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link DataUnavailableException} (client fault)
|
|
84
|
+
* <p>The requested data is unavailable.</p>
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link GenerationExistsException} (client fault)
|
|
87
|
+
* <p>A request to generate a recommendation is already in progress.</p>
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
90
|
+
* <p>You made too many calls in a short period of time. Try again later.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ServiceQuotaExceededException} (client fault)
|
|
93
|
+
* <p> You've reached the limit on the number of resources you can create, or exceeded the
|
|
94
|
+
* size of an individual resource. </p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link CostExplorerServiceException}
|
|
97
|
+
* <p>Base exception class for all service exceptions from CostExplorer service.</p>
|
|
98
|
+
*
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
export declare class StartCommitmentPurchaseAnalysisCommand extends StartCommitmentPurchaseAnalysisCommand_base {
|
|
102
|
+
/** @internal type navigation helper, not in runtime. */
|
|
103
|
+
protected static __types: {
|
|
104
|
+
api: {
|
|
105
|
+
input: StartCommitmentPurchaseAnalysisRequest;
|
|
106
|
+
output: StartCommitmentPurchaseAnalysisResponse;
|
|
107
|
+
};
|
|
108
|
+
sdk: {
|
|
109
|
+
input: StartCommitmentPurchaseAnalysisCommandInput;
|
|
110
|
+
output: StartCommitmentPurchaseAnalysisCommandOutput;
|
|
111
|
+
};
|
|
112
|
+
};
|
|
113
|
+
}
|
|
@@ -9,6 +9,7 @@ export * from "./GetAnomaliesCommand";
|
|
|
9
9
|
export * from "./GetAnomalyMonitorsCommand";
|
|
10
10
|
export * from "./GetAnomalySubscriptionsCommand";
|
|
11
11
|
export * from "./GetApproximateUsageRecordsCommand";
|
|
12
|
+
export * from "./GetCommitmentPurchaseAnalysisCommand";
|
|
12
13
|
export * from "./GetCostAndUsageCommand";
|
|
13
14
|
export * from "./GetCostAndUsageWithResourcesCommand";
|
|
14
15
|
export * from "./GetCostCategoriesCommand";
|
|
@@ -25,12 +26,14 @@ export * from "./GetSavingsPlansUtilizationCommand";
|
|
|
25
26
|
export * from "./GetSavingsPlansUtilizationDetailsCommand";
|
|
26
27
|
export * from "./GetTagsCommand";
|
|
27
28
|
export * from "./GetUsageForecastCommand";
|
|
29
|
+
export * from "./ListCommitmentPurchaseAnalysesCommand";
|
|
28
30
|
export * from "./ListCostAllocationTagBackfillHistoryCommand";
|
|
29
31
|
export * from "./ListCostAllocationTagsCommand";
|
|
30
32
|
export * from "./ListCostCategoryDefinitionsCommand";
|
|
31
33
|
export * from "./ListSavingsPlansPurchaseRecommendationGenerationCommand";
|
|
32
34
|
export * from "./ListTagsForResourceCommand";
|
|
33
35
|
export * from "./ProvideAnomalyFeedbackCommand";
|
|
36
|
+
export * from "./StartCommitmentPurchaseAnalysisCommand";
|
|
34
37
|
export * from "./StartCostAllocationTagBackfillCommand";
|
|
35
38
|
export * from "./StartSavingsPlansPurchaseRecommendationGenerationCommand";
|
|
36
39
|
export * from "./TagResourceCommand";
|