@aws-sdk/client-cost-optimization-hub 3.623.0 → 3.625.0

package/dist-cjs/index.js

@@ -41,6 +41,7 @@ __export(src_exports, {
   ResourceType: () => ResourceType,
   SavingsEstimationMode: () => SavingsEstimationMode,
   Source: () => Source,
+  SummaryMetrics: () => SummaryMetrics,
   ThrottlingException: () => ThrottlingException,
   UpdateEnrollmentStatusCommand: () => UpdateEnrollmentStatusCommand,
   UpdatePreferencesCommand: () => UpdatePreferencesCommand,
@@ -398,6 +399,9 @@ var Order = {
   ASC: "Asc",
   DESC: "Desc"
 };
+var SummaryMetrics = {
+  SAVINGS_PERCENTAGE: "SavingsPercentage"
+};
 
 // src/protocols/Aws_json1_0.ts
 var se_GetPreferencesCommand = /* @__PURE__ */ __name(async (input, context) => {
@@ -761,6 +765,7 @@ var de_ListRecommendationSummariesResponse = /* @__PURE__ */ __name((output, con
     estimatedTotalDedupedSavings: import_smithy_client.limitedParseDouble,
     groupBy: import_smithy_client.expectString,
     items: (_) => de_RecommendationSummariesList(_, context),
+    metrics: import_smithy_client._json,
     nextToken: import_smithy_client.expectString
   });
 }, "de_ListRecommendationSummariesResponse");
@@ -1192,6 +1197,7 @@ var paginateListRecommendations = (0, import_core.createPaginator)(CostOptimizat
   ImplementationEffort,
   Source,
   ResourceNotFoundException,
-  Order
+  Order,
+  SummaryMetrics
 });
 

package/dist-es/models/models_0.js

@@ -154,3 +154,6 @@ export const Order = {
     ASC: "Asc",
     DESC: "Desc",
 };
+export const SummaryMetrics = {
+    SAVINGS_PERCENTAGE: "SavingsPercentage",
+};

package/dist-es/protocols/Aws_json1_0.js

@@ -366,6 +366,7 @@ const de_ListRecommendationSummariesResponse = (output, context) => {
         estimatedTotalDedupedSavings: __limitedParseDouble,
         groupBy: __expectString,
         items: (_) => de_RecommendationSummariesList(_, context),
+        metrics: _json,
         nextToken: __expectString,
     });
 };

package/dist-types/commands/ListRecommendationSummariesCommand.d.ts

@@ -76,6 +76,9 @@ declare const ListRecommendationSummariesCommand_base: {
  *   },
  *   groupBy: "STRING_VALUE", // required
  *   maxResults: Number("int"),
+ *   metrics: [ // SummaryMetricsList
+ *     "SavingsPercentage",
+ *   ],
  *   nextToken: "STRING_VALUE",
  * };
  * const command = new ListRecommendationSummariesCommand(input);
@@ -91,6 +94,9 @@ declare const ListRecommendationSummariesCommand_base: {
  * //   ],
  * //   groupBy: "STRING_VALUE",
  * //   currencyCode: "STRING_VALUE",
+ * //   metrics: { // SummaryMetricsResult
+ * //     savingsPercentage: "STRING_VALUE",
+ * //   },
  * //   nextToken: "STRING_VALUE",
  * // };
  *

package/dist-types/commands/UpdateEnrollmentStatusCommand.d.ts

@@ -29,8 +29,8 @@ declare const UpdateEnrollmentStatusCommand_base: {
 /**
  * <p>Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization
  *       Hub service.</p>
- *          <p>If the account is a management account of an organization, this action can also be used to
- *       enroll member accounts of the organization.</p>
+ *          <p>If the account is a management account or delegated administrator of an organization, this
+ *       action can also be used to enroll member accounts of the organization.</p>
  *          <p>You must have the appropriate permissions to opt in to Cost Optimization Hub and to view
  *       its recommendations. When you opt in, Cost Optimization Hub automatically creates a
  *       service-linked role in your account to access its data.</p>

package/dist-types/models/models_0.d.ts

@@ -1911,7 +1911,7 @@ export interface ListEnrollmentStatusesResponse {
     items?: AccountEnrollmentStatus[];
     /**
      * <p>The enrollment status of all member accounts in the organization if the account is the
-     *       management account.</p>
+     *       management account or delegated administrator.</p>
      * @public
      */
     includeMemberAccounts?: boolean;
@@ -2169,6 +2169,17 @@ export interface ListRecommendationsResponse {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const SummaryMetrics: {
+    readonly SAVINGS_PERCENTAGE: "SavingsPercentage";
+};
+/**
+ * @public
+ */
+export type SummaryMetrics = (typeof SummaryMetrics)[keyof typeof SummaryMetrics];
 /**
  * @public
  */
@@ -2185,10 +2196,16 @@ export interface ListRecommendationSummariesRequest {
      */
     groupBy: string | undefined;
     /**
-     * <p>The maximum number of recommendations that are returned for the request.</p>
+     * <p>The maximum number of recommendations to be returned for the request.</p>
      * @public
      */
     maxResults?: number;
+    /**
+     * <p>Additional metrics to be returned for the request. The only valid value is
+     *         <code>savingsPercentage</code>.</p>
+     * @public
+     */
+    metrics?: SummaryMetrics[];
     /**
      * <p>The token to retrieve the next set of results.</p>
      * @public
@@ -2217,6 +2234,23 @@ export interface RecommendationSummary {
      */
     recommendationCount?: number;
 }
+/**
+ * <p>The results or descriptions for the additional metrics, based on whether the metrics were
+ *       or were not requested.</p>
+ * @public
+ */
+export interface SummaryMetricsResult {
+    /**
+     * <p>The savings percentage based on your Amazon Web Services spend over the past 30
+     *       days.</p>
+     *          <note>
+     *             <p>Savings percentage is only supported when filtering by Region, account ID, or
+     *         tags.</p>
+     *          </note>
+     * @public
+     */
+    savingsPercentage?: string;
+}
 /**
  * @public
  */
@@ -2227,7 +2261,7 @@ export interface ListRecommendationSummariesResponse {
      */
     estimatedTotalDedupedSavings?: number;
     /**
-     * <p>List of all savings recommendations.</p>
+     * <p>A list of all savings recommendations.</p>
      * @public
      */
     items?: RecommendationSummary[];
@@ -2241,6 +2275,12 @@ export interface ListRecommendationSummariesResponse {
      * @public
      */
     currencyCode?: string;
+    /**
+     * <p>The results or descriptions for the additional metrics, based on whether the metrics were
+     *       or were not requested.</p>
+     * @public
+     */
+    metrics?: SummaryMetricsResult;
     /**
      * <p>The token to retrieve the next set of results.</p>
      * @public
@@ -2258,7 +2298,7 @@ export interface UpdateEnrollmentStatusRequest {
     status: EnrollmentStatus | undefined;
     /**
      * <p>Indicates whether to enroll member accounts of the organization if the account is the
-     *       management account.</p>
+     *       management account or delegated administrator.</p>
      * @public
      */
     includeMemberAccounts?: boolean;

package/dist-types/ts3.4/models/models_0.d.ts

@@ -790,10 +790,16 @@ export interface ListRecommendationsResponse {
   items?: Recommendation[];
   nextToken?: string;
 }
+export declare const SummaryMetrics: {
+  readonly SAVINGS_PERCENTAGE: "SavingsPercentage";
+};
+export type SummaryMetrics =
+  (typeof SummaryMetrics)[keyof typeof SummaryMetrics];
 export interface ListRecommendationSummariesRequest {
   filter?: Filter;
   groupBy: string | undefined;
   maxResults?: number;
+  metrics?: SummaryMetrics[];
   nextToken?: string;
 }
 export interface RecommendationSummary {
@@ -801,11 +807,15 @@ export interface RecommendationSummary {
   estimatedMonthlySavings?: number;
   recommendationCount?: number;
 }
+export interface SummaryMetricsResult {
+  savingsPercentage?: string;
+}
 export interface ListRecommendationSummariesResponse {
   estimatedTotalDedupedSavings?: number;
   items?: RecommendationSummary[];
   groupBy?: string;
   currencyCode?: string;
+  metrics?: SummaryMetricsResult;
   nextToken?: string;
 }
 export interface UpdateEnrollmentStatusRequest {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-cost-optimization-hub",
   "description": "AWS SDK for JavaScript Cost Optimization Hub Client for Node.js, Browser and React Native",
-  "version": "3.623.0",
+  "version": "3.625.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-cost-optimization-hub",
@@ -20,10 +20,10 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/client-sso-oidc": "3.623.0",
-    "@aws-sdk/client-sts": "3.623.0",
-    "@aws-sdk/core": "3.623.0",
-    "@aws-sdk/credential-provider-node": "3.623.0",
+    "@aws-sdk/client-sso-oidc": "3.624.0",
+    "@aws-sdk/client-sts": "3.624.0",
+    "@aws-sdk/core": "3.624.0",
+    "@aws-sdk/credential-provider-node": "3.624.0",
     "@aws-sdk/middleware-host-header": "3.620.0",
     "@aws-sdk/middleware-logger": "3.609.0",
     "@aws-sdk/middleware-recursion-detection": "3.620.0",