@aws-sdk/client-cost-explorer 3.696.0 → 3.699.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 (28) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/index.js +323 -37
  3. package/dist-es/CostExplorer.js +6 -0
  4. package/dist-es/commands/GetCommitmentPurchaseAnalysisCommand.js +22 -0
  5. package/dist-es/commands/ListCommitmentPurchaseAnalysesCommand.js +22 -0
  6. package/dist-es/commands/StartCommitmentPurchaseAnalysisCommand.js +22 -0
  7. package/dist-es/commands/index.js +3 -0
  8. package/dist-es/models/models_0.js +54 -25
  9. package/dist-es/protocols/Aws_json1_1.js +206 -5
  10. package/dist-types/CostExplorer.d.ts +22 -0
  11. package/dist-types/CostExplorerClient.d.ts +5 -2
  12. package/dist-types/commands/GetAnomaliesCommand.d.ts +4 -1
  13. package/dist-types/commands/GetCommitmentPurchaseAnalysisCommand.d.ts +145 -0
  14. package/dist-types/commands/ListCommitmentPurchaseAnalysesCommand.d.ts +120 -0
  15. package/dist-types/commands/StartCommitmentPurchaseAnalysisCommand.d.ts +112 -0
  16. package/dist-types/commands/StartSavingsPlansPurchaseRecommendationGenerationCommand.d.ts +1 -1
  17. package/dist-types/commands/index.d.ts +3 -0
  18. package/dist-types/models/models_0.d.ts +597 -122
  19. package/dist-types/protocols/Aws_json1_1.d.ts +27 -0
  20. package/dist-types/ts3.4/CostExplorer.d.ts +52 -0
  21. package/dist-types/ts3.4/CostExplorerClient.d.ts +18 -0
  22. package/dist-types/ts3.4/commands/GetCommitmentPurchaseAnalysisCommand.d.ts +51 -0
  23. package/dist-types/ts3.4/commands/ListCommitmentPurchaseAnalysesCommand.d.ts +51 -0
  24. package/dist-types/ts3.4/commands/StartCommitmentPurchaseAnalysisCommand.d.ts +51 -0
  25. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  26. package/dist-types/ts3.4/models/models_0.d.ts +170 -41
  27. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
  28. package/package.json +4 -4
@@ -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
  */
@@ -65,8 +65,11 @@ declare const GetAnomaliesCommand_base: {
65
65
  * // Service: "STRING_VALUE",
66
66
  * // Region: "STRING_VALUE",
67
67
  * // LinkedAccount: "STRING_VALUE",
68
- * // UsageType: "STRING_VALUE",
69
68
  * // LinkedAccountName: "STRING_VALUE",
69
+ * // UsageType: "STRING_VALUE",
70
+ * // Impact: { // RootCauseImpact
71
+ * // Contribution: Number("double"), // required
72
+ * // },
70
73
  * // },
71
74
  * // ],
72
75
  * // AnomalyScore: { // AnomalyScore
@@ -0,0 +1,145 @@
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 found.</p>
121
+ *
122
+ * @throws {@link DataUnavailableException} (client fault)
123
+ * <p>The requested data is unavailable.</p>
124
+ *
125
+ * @throws {@link LimitExceededException} (client fault)
126
+ * <p>You made too many calls in a short period of time. Try again later.</p>
127
+ *
128
+ * @throws {@link CostExplorerServiceException}
129
+ * <p>Base exception class for all service exceptions from CostExplorer service.</p>
130
+ *
131
+ * @public
132
+ */
133
+ export declare class GetCommitmentPurchaseAnalysisCommand extends GetCommitmentPurchaseAnalysisCommand_base {
134
+ /** @internal type navigation helper, not in runtime. */
135
+ protected static __types: {
136
+ api: {
137
+ input: GetCommitmentPurchaseAnalysisRequest;
138
+ output: GetCommitmentPurchaseAnalysisResponse;
139
+ };
140
+ sdk: {
141
+ input: GetCommitmentPurchaseAnalysisCommandInput;
142
+ output: GetCommitmentPurchaseAnalysisCommandOutput;
143
+ };
144
+ };
145
+ }
@@ -0,0 +1,120 @@
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.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { CostExplorerClient, ListCommitmentPurchaseAnalysesCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import
35
+ * // const { CostExplorerClient, ListCommitmentPurchaseAnalysesCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import
36
+ * const client = new CostExplorerClient(config);
37
+ * const input = { // ListCommitmentPurchaseAnalysesRequest
38
+ * AnalysisStatus: "SUCCEEDED" || "PROCESSING" || "FAILED",
39
+ * NextPageToken: "STRING_VALUE",
40
+ * PageSize: Number("int"),
41
+ * AnalysisIds: [ // AnalysisIds
42
+ * "STRING_VALUE",
43
+ * ],
44
+ * };
45
+ * const command = new ListCommitmentPurchaseAnalysesCommand(input);
46
+ * const response = await client.send(command);
47
+ * // { // ListCommitmentPurchaseAnalysesResponse
48
+ * // AnalysisSummaryList: [ // AnalysisSummaryList
49
+ * // { // AnalysisSummary
50
+ * // EstimatedCompletionTime: "STRING_VALUE",
51
+ * // AnalysisCompletionTime: "STRING_VALUE",
52
+ * // AnalysisStartedTime: "STRING_VALUE",
53
+ * // AnalysisStatus: "SUCCEEDED" || "PROCESSING" || "FAILED",
54
+ * // ErrorCode: "NO_USAGE_FOUND" || "INTERNAL_FAILURE" || "INVALID_SAVINGS_PLANS_TO_ADD" || "INVALID_SAVINGS_PLANS_TO_EXCLUDE" || "INVALID_ACCOUNT_ID",
55
+ * // AnalysisId: "STRING_VALUE",
56
+ * // CommitmentPurchaseAnalysisConfiguration: { // CommitmentPurchaseAnalysisConfiguration
57
+ * // SavingsPlansPurchaseAnalysisConfiguration: { // SavingsPlansPurchaseAnalysisConfiguration
58
+ * // AccountScope: "PAYER" || "LINKED",
59
+ * // AccountId: "STRING_VALUE",
60
+ * // AnalysisType: "MAX_SAVINGS" || "CUSTOM_COMMITMENT", // required
61
+ * // SavingsPlansToAdd: [ // SavingsPlansToAdd // required
62
+ * // { // SavingsPlans
63
+ * // PaymentOption: "NO_UPFRONT" || "PARTIAL_UPFRONT" || "ALL_UPFRONT" || "LIGHT_UTILIZATION" || "MEDIUM_UTILIZATION" || "HEAVY_UTILIZATION",
64
+ * // SavingsPlansType: "COMPUTE_SP" || "EC2_INSTANCE_SP" || "SAGEMAKER_SP",
65
+ * // Region: "STRING_VALUE",
66
+ * // InstanceFamily: "STRING_VALUE",
67
+ * // TermInYears: "ONE_YEAR" || "THREE_YEARS",
68
+ * // SavingsPlansCommitment: Number("double"),
69
+ * // OfferingId: "STRING_VALUE",
70
+ * // },
71
+ * // ],
72
+ * // SavingsPlansToExclude: [ // SavingsPlansToExclude
73
+ * // "STRING_VALUE",
74
+ * // ],
75
+ * // LookBackTimePeriod: { // DateInterval
76
+ * // Start: "STRING_VALUE", // required
77
+ * // End: "STRING_VALUE", // required
78
+ * // },
79
+ * // },
80
+ * // },
81
+ * // },
82
+ * // ],
83
+ * // NextPageToken: "STRING_VALUE",
84
+ * // };
85
+ *
86
+ * ```
87
+ *
88
+ * @param ListCommitmentPurchaseAnalysesCommandInput - {@link ListCommitmentPurchaseAnalysesCommandInput}
89
+ * @returns {@link ListCommitmentPurchaseAnalysesCommandOutput}
90
+ * @see {@link ListCommitmentPurchaseAnalysesCommandInput} for command's `input` shape.
91
+ * @see {@link ListCommitmentPurchaseAnalysesCommandOutput} for command's `response` shape.
92
+ * @see {@link CostExplorerClientResolvedConfig | config} for CostExplorerClient's `config` shape.
93
+ *
94
+ * @throws {@link DataUnavailableException} (client fault)
95
+ * <p>The requested data is unavailable.</p>
96
+ *
97
+ * @throws {@link InvalidNextTokenException} (client fault)
98
+ * <p>The pagination token is invalid. Try again without a pagination token.</p>
99
+ *
100
+ * @throws {@link LimitExceededException} (client fault)
101
+ * <p>You made too many calls in a short period of time. Try again later.</p>
102
+ *
103
+ * @throws {@link CostExplorerServiceException}
104
+ * <p>Base exception class for all service exceptions from CostExplorer service.</p>
105
+ *
106
+ * @public
107
+ */
108
+ export declare class ListCommitmentPurchaseAnalysesCommand extends ListCommitmentPurchaseAnalysesCommand_base {
109
+ /** @internal type navigation helper, not in runtime. */
110
+ protected static __types: {
111
+ api: {
112
+ input: ListCommitmentPurchaseAnalysesRequest;
113
+ output: ListCommitmentPurchaseAnalysesResponse;
114
+ };
115
+ sdk: {
116
+ input: ListCommitmentPurchaseAnalysesCommandInput;
117
+ output: ListCommitmentPurchaseAnalysesCommandOutput;
118
+ };
119
+ };
120
+ }
@@ -0,0 +1,112 @@
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.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { CostExplorerClient, StartCommitmentPurchaseAnalysisCommand } from "@aws-sdk/client-cost-explorer"; // ES Modules import
37
+ * // const { CostExplorerClient, StartCommitmentPurchaseAnalysisCommand } = require("@aws-sdk/client-cost-explorer"); // CommonJS import
38
+ * const client = new CostExplorerClient(config);
39
+ * const input = { // StartCommitmentPurchaseAnalysisRequest
40
+ * CommitmentPurchaseAnalysisConfiguration: { // CommitmentPurchaseAnalysisConfiguration
41
+ * SavingsPlansPurchaseAnalysisConfiguration: { // SavingsPlansPurchaseAnalysisConfiguration
42
+ * AccountScope: "PAYER" || "LINKED",
43
+ * AccountId: "STRING_VALUE",
44
+ * AnalysisType: "MAX_SAVINGS" || "CUSTOM_COMMITMENT", // required
45
+ * SavingsPlansToAdd: [ // SavingsPlansToAdd // required
46
+ * { // SavingsPlans
47
+ * PaymentOption: "NO_UPFRONT" || "PARTIAL_UPFRONT" || "ALL_UPFRONT" || "LIGHT_UTILIZATION" || "MEDIUM_UTILIZATION" || "HEAVY_UTILIZATION",
48
+ * SavingsPlansType: "COMPUTE_SP" || "EC2_INSTANCE_SP" || "SAGEMAKER_SP",
49
+ * Region: "STRING_VALUE",
50
+ * InstanceFamily: "STRING_VALUE",
51
+ * TermInYears: "ONE_YEAR" || "THREE_YEARS",
52
+ * SavingsPlansCommitment: Number("double"),
53
+ * OfferingId: "STRING_VALUE",
54
+ * },
55
+ * ],
56
+ * SavingsPlansToExclude: [ // SavingsPlansToExclude
57
+ * "STRING_VALUE",
58
+ * ],
59
+ * LookBackTimePeriod: { // DateInterval
60
+ * Start: "STRING_VALUE", // required
61
+ * End: "STRING_VALUE", // required
62
+ * },
63
+ * },
64
+ * },
65
+ * };
66
+ * const command = new StartCommitmentPurchaseAnalysisCommand(input);
67
+ * const response = await client.send(command);
68
+ * // { // StartCommitmentPurchaseAnalysisResponse
69
+ * // AnalysisId: "STRING_VALUE", // required
70
+ * // AnalysisStartedTime: "STRING_VALUE", // required
71
+ * // EstimatedCompletionTime: "STRING_VALUE", // required
72
+ * // };
73
+ *
74
+ * ```
75
+ *
76
+ * @param StartCommitmentPurchaseAnalysisCommandInput - {@link StartCommitmentPurchaseAnalysisCommandInput}
77
+ * @returns {@link StartCommitmentPurchaseAnalysisCommandOutput}
78
+ * @see {@link StartCommitmentPurchaseAnalysisCommandInput} for command's `input` shape.
79
+ * @see {@link StartCommitmentPurchaseAnalysisCommandOutput} for command's `response` shape.
80
+ * @see {@link CostExplorerClientResolvedConfig | config} for CostExplorerClient's `config` shape.
81
+ *
82
+ * @throws {@link DataUnavailableException} (client fault)
83
+ * <p>The requested data is unavailable.</p>
84
+ *
85
+ * @throws {@link GenerationExistsException} (client fault)
86
+ * <p>A request to generate a recommendation or analysis is already in progress.</p>
87
+ *
88
+ * @throws {@link LimitExceededException} (client fault)
89
+ * <p>You made too many calls in a short period of time. Try again later.</p>
90
+ *
91
+ * @throws {@link ServiceQuotaExceededException} (client fault)
92
+ * <p> You've reached the limit on the number of resources you can create, or exceeded the
93
+ * size of an individual resource. </p>
94
+ *
95
+ * @throws {@link CostExplorerServiceException}
96
+ * <p>Base exception class for all service exceptions from CostExplorer service.</p>
97
+ *
98
+ * @public
99
+ */
100
+ export declare class StartCommitmentPurchaseAnalysisCommand extends StartCommitmentPurchaseAnalysisCommand_base {
101
+ /** @internal type navigation helper, not in runtime. */
102
+ protected static __types: {
103
+ api: {
104
+ input: StartCommitmentPurchaseAnalysisRequest;
105
+ output: StartCommitmentPurchaseAnalysisResponse;
106
+ };
107
+ sdk: {
108
+ input: StartCommitmentPurchaseAnalysisCommandInput;
109
+ output: StartCommitmentPurchaseAnalysisCommandOutput;
110
+ };
111
+ };
112
+ }
@@ -63,7 +63,7 @@ declare const StartSavingsPlansPurchaseRecommendationGenerationCommand_base: {
63
63
  * <p>The requested data is unavailable.</p>
64
64
  *
65
65
  * @throws {@link GenerationExistsException} (client fault)
66
- * <p>A request to generate a recommendation is already in progress.</p>
66
+ * <p>A request to generate a recommendation or analysis is already in progress.</p>
67
67
  *
68
68
  * @throws {@link LimitExceededException} (client fault)
69
69
  * <p>You made too many calls in a short period of time. Try again later.</p>
@@ -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";