diff --git a/clients/client-cost-explorer/src/commands/GetReservationPurchaseRecommendationCommand.ts b/clients/client-cost-explorer/src/commands/GetReservationPurchaseRecommendationCommand.ts index 49ef3518b71b2..ca48afb982228 100644 --- a/clients/client-cost-explorer/src/commands/GetReservationPurchaseRecommendationCommand.ts +++ b/clients/client-cost-explorer/src/commands/GetReservationPurchaseRecommendationCommand.ts @@ -231,6 +231,16 @@ export interface GetReservationPurchaseRecommendationCommandOutput * // EstimatedReservationCostForLookbackPeriod: "STRING_VALUE", * // UpfrontCost: "STRING_VALUE", * // RecurringStandardMonthlyCost: "STRING_VALUE", + * // ReservedCapacityDetails: { // ReservedCapacityDetails + * // DynamoDBCapacityDetails: { // DynamoDBCapacityDetails + * // CapacityUnits: "STRING_VALUE", + * // Region: "STRING_VALUE", + * // }, + * // }, + * // RecommendedNumberOfCapacityUnitsToPurchase: "STRING_VALUE", + * // MinimumNumberOfCapacityUnitsUsedPerHour: "STRING_VALUE", + * // MaximumNumberOfCapacityUnitsUsedPerHour: "STRING_VALUE", + * // AverageNumberOfCapacityUnitsUsedPerHour: "STRING_VALUE", * // }, * // ], * // RecommendationSummary: { // ReservationPurchaseRecommendationSummary diff --git a/clients/client-cost-explorer/src/models/models_0.ts b/clients/client-cost-explorer/src/models/models_0.ts index 23e95fed3e4c4..f417a5a2fca52 100644 --- a/clients/client-cost-explorer/src/models/models_0.ts +++ b/clients/client-cost-explorer/src/models/models_0.ts @@ -93,14 +93,14 @@ export interface Impact { } /** - *
The combination of Amazon Web Service, linked account, linked account name, + *
The combination of Amazon Web Servicesservice, linked account, linked account name, * Region, and usage type where a cost anomaly is observed. The linked account name will * only be available when the account name can be identified.
* @public */ export interface RootCause { /** - *The Amazon Web Service name that's associated with the cost anomaly.
+ *The Amazon Web Servicesservice name that's associated with the cost anomaly.
* @public */ Service?: string; @@ -155,7 +155,7 @@ export interface Anomaly { AnomalyEndDate?: string; /** - *The dimension for the anomaly (for example, an Amazon Web Service in a service + *
The dimension for the anomaly (for example, an Amazon Web Servicesservice in a service * monitor).
* @public */ @@ -2397,6 +2397,37 @@ export interface InstanceDetails { MemoryDBInstanceDetails?: MemoryDBInstanceDetails; } +/** + *The DynamoDB reservations that Amazon Web Services recommends that you purchase.
+ * @public + */ +export interface DynamoDBCapacityDetails { + /** + *The capacity unit of the recommended reservation.
+ * @public + */ + CapacityUnits?: string; + + /** + *The Amazon Web Services Region of the recommended reservation.
+ * @public + */ + Region?: string; +} + +/** + *Details about the reservations that Amazon Web Services recommends that you + * purchase.
+ * @public + */ +export interface ReservedCapacityDetails { + /** + *The DynamoDB reservations that Amazon Web Services recommends that you purchase.
+ * @public + */ + DynamoDBCapacityDetails?: DynamoDBCapacityDetails; +} + /** *Details about your recommended reservation purchase.
* @public @@ -2477,22 +2508,22 @@ export interface ReservationPurchaseRecommendationDetail { AverageNormalizedUnitsUsedPerHour?: string; /** - *The average utilization of your instances. Amazon Web Services uses this to calculate - * your recommended reservation purchases.
+ *The average utilization of your recommendations. Amazon Web Services uses this to + * calculate your recommended reservation purchases.
* @public */ AverageUtilization?: string; /** - *How long Amazon Web Services estimates that it takes for this instance to start saving - * you money, in months.
+ *How long Amazon Web Services estimates that it takes for this recommendation to start + * saving you money, in months.
* @public */ EstimatedBreakEvenInMonths?: string; /** *The currency code that Amazon Web Services used to calculate the costs for this - * instance.
+ * recommendation. * @public */ CurrencyCode?: string; @@ -2526,16 +2557,54 @@ export interface ReservationPurchaseRecommendationDetail { EstimatedReservationCostForLookbackPeriod?: string; /** - *How much purchasing this instance costs you upfront.
+ *How much purchasing this recommendation costs you upfront.
* @public */ UpfrontCost?: string; /** - *How much purchasing this instance costs you on a monthly basis.
+ *How much purchasing this recommendation costs you on a monthly basis.
* @public */ RecurringStandardMonthlyCost?: string; + + /** + *Details about the reservations that Amazon Web Services recommends that you + * purchase.
+ * @public + */ + ReservedCapacityDetails?: ReservedCapacityDetails; + + /** + *The number of reserved capacity units that Amazon Web Services recommends that you + * purchase.
+ * @public + */ + RecommendedNumberOfCapacityUnitsToPurchase?: string; + + /** + *The minimum number of provisioned capacity units that you used in an hour during the + * historical period. Amazon Web Services uses this to calculate your recommended + * reservation purchases.
+ * @public + */ + MinimumNumberOfCapacityUnitsUsedPerHour?: string; + + /** + *The maximum number of provisioned capacity units that you used in an hour during the + * historical period. Amazon Web Services uses this to calculate your recommended + * reservation purchases.
+ * @public + */ + MaximumNumberOfCapacityUnitsUsedPerHour?: string; + + /** + *The average number of provisioned capacity units that you used in an hour during the + * historical period. Amazon Web Services uses this to calculate your recommended + * reservation purchases.
+ * @public + */ + AverageNumberOfCapacityUnitsUsedPerHour?: string; } /** @@ -6421,9 +6490,9 @@ export interface GetDimensionValuesRequest { *BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible * values are the following:
- *- Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services.
+ *- Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Servicesservices.
*- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting - * reseller for Amazon Web Services in India.
+ * reseller for Amazon Web Servicesservices in India. *- Amazon Web Services Marketplace: The entity that supports the sale of solutions that are built on * Amazon Web Services by third-party software providers.
*The dimension for the anomaly (for example, an Amazon Web Service in a service\n monitor).
" + "smithy.api#documentation": "The dimension for the anomaly (for example, an Amazon Web Servicesservice in a service\n monitor).
" } }, "RootCauses": { @@ -3021,6 +3021,26 @@ "smithy.api#documentation": "The field that contains a list of disk (local storage) metrics that are associated\n with the current instance.
" } }, + "com.amazonaws.costexplorer#DynamoDBCapacityDetails": { + "type": "structure", + "members": { + "CapacityUnits": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "The capacity unit of the recommended reservation.
" + } + }, + "Region": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region of the recommended reservation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The DynamoDB reservations that Amazon Web Services recommends that you purchase.
" + } + }, "com.amazonaws.costexplorer#EBSResourceUtilization": { "type": "structure", "members": { @@ -4398,7 +4418,7 @@ "Context": { "target": "com.amazonaws.costexplorer#Context", "traits": { - "smithy.api#documentation": "The context for the call to GetDimensionValues
. This can be\n RESERVATIONS
or COST_AND_USAGE
. The default value is\n COST_AND_USAGE
. If the context is set to RESERVATIONS
, the\n resulting dimension values can be used in the GetReservationUtilization
\n operation. If the context is set to COST_AND_USAGE
, the resulting dimension\n values can be used in the GetCostAndUsage
operation.
If you set the context to COST_AND_USAGE
, you can use the following\n dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a
.
BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible\n values are the following:
\n- Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Services.
\n- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting\n reseller for Amazon Web Services in India.
\n- Amazon Web Services Marketplace: The entity that supports the sale of solutions that are built on\n Amazon Web Services by third-party software providers.
\nCACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or\n Linux.
\nDEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments.\n Valid values are SingleAZ
and MultiAZ
.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are\n Aurora or MySQL.
\nINSTANCE_TYPE - The type of Amazon EC2 instance. An example is\n m4.xlarge
.
INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use\n cases. Examples are Compute Optimized
(for example, C4
,\n C5
, C6g
, and C7g
), Memory\n Optimization
(for example, R4
, R5n
, R5b
,\n and R6g
).
INVOICING_ENTITY - The name of the entity that issues the Amazon Web Services\n invoice.
\nLEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services\n services, such as Amazon Web Services.
\nLINKED_ACCOUNT - The description in the attribute map that includes the full name\n of the member account. The value field contains the Amazon Web Services ID of the member\n account.
\nOPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
\nOPERATION - The action performed. Examples include RunInstance
and\n CreateBucket
.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or\n Linux.
\nPURCHASE_TYPE - The reservation type of the purchase that this usage is related to.\n Examples include On-Demand Instances and Standard Reserved Instances.
\nRESERVATION_ID - The unique identifier for an Amazon Web Services Reservation\n Instance.
\nSAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
\nSAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).
\nSERVICE - The Amazon Web Services service such as Amazon DynamoDB.
\nTENANCY - The tenancy of a resource. Examples are shared or dedicated.
\nUSAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response\n for the GetDimensionValues
operation includes a unit attribute. Examples\n include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2:\n CloudWatch – Alarms. The response for this operation includes a unit attribute.
\nREGION - The Amazon Web Services Region.
\nRECORD_TYPE - The different types of charges such as Reserved Instance (RI) fees,\n usage costs, tax refunds, and credits.
\nRESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in\n feature only available for last 14 days for EC2-Compute Service.
\nIf you set the context to RESERVATIONS
, you can use the following\n dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a
.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or\n Linux.
\nDEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments.\n Valid values are SingleAZ
and MultiAZ
.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is\n m4.xlarge
.
LINKED_ACCOUNT - The description in the attribute map that includes the full name\n of the member account. The value field contains the Amazon Web Services ID of the member\n account.
\nPLATFORM - The Amazon EC2 operating system. Examples are Windows or\n Linux.
\nREGION - The Amazon Web Services Region.
\nSCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are\n regional or a single Availability Zone.
\nTAG (Coverage only) - The tags that are associated with a Reserved Instance\n (RI).
\nTENANCY - The tenancy of a resource. Examples are shared or dedicated.
\nIf you set the context to SAVINGS_PLANS
, you can use the following\n dimensions for searching:
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
\nPAYMENT_OPTION - The payment option for the given Savings Plans (for example, All\n Upfront)
\nREGION - The Amazon Web Services Region.
\nINSTANCE_TYPE_FAMILY - The family of instances (For example,\n m5
)
LINKED_ACCOUNT - The description in the attribute map that includes the full name\n of the member account. The value field contains the Amazon Web Services ID of the member\n account.
\nSAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
\nThe context for the call to GetDimensionValues
. This can be\n RESERVATIONS
or COST_AND_USAGE
. The default value is\n COST_AND_USAGE
. If the context is set to RESERVATIONS
, the\n resulting dimension values can be used in the GetReservationUtilization
\n operation. If the context is set to COST_AND_USAGE
, the resulting dimension\n values can be used in the GetCostAndUsage
operation.
If you set the context to COST_AND_USAGE
, you can use the following\n dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a
.
BILLING_ENTITY - The Amazon Web Services seller that your account is with. Possible\n values are the following:
\n- Amazon Web Services(Amazon Web Services): The entity that sells Amazon Web Servicesservices.
\n- AISPL (Amazon Internet Services Pvt. Ltd.): The local Indian entity that's an acting\n reseller for Amazon Web Servicesservices in India.
\n- Amazon Web Services Marketplace: The entity that supports the sale of solutions that are built on\n Amazon Web Services by third-party software providers.
\nCACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or\n Linux.
\nDEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments.\n Valid values are SingleAZ
and MultiAZ
.
DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are\n Aurora or MySQL.
\nINSTANCE_TYPE - The type of Amazon EC2 instance. An example is\n m4.xlarge
.
INSTANCE_TYPE_FAMILY - A family of instance types optimized to fit different use\n cases. Examples are Compute Optimized
(for example, C4
,\n C5
, C6g
, and C7g
), Memory\n Optimization
(for example, R4
, R5n
, R5b
,\n and R6g
).
INVOICING_ENTITY - The name of the entity that issues the Amazon Web Services\n invoice.
\nLEGAL_ENTITY_NAME - The name of the organization that sells you Amazon Web Services\n services, such as Amazon Web Services.
\nLINKED_ACCOUNT - The description in the attribute map that includes the full name\n of the member account. The value field contains the Amazon Web Services ID of the member\n account.
\nOPERATING_SYSTEM - The operating system. Examples are Windows or Linux.
\nOPERATION - The action performed. Examples include RunInstance
and\n CreateBucket
.
PLATFORM - The Amazon EC2 operating system. Examples are Windows or\n Linux.
\nPURCHASE_TYPE - The reservation type of the purchase that this usage is related to.\n Examples include On-Demand Instances and Standard Reserved Instances.
\nRESERVATION_ID - The unique identifier for an Amazon Web Services Reservation\n Instance.
\nSAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
\nSAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute).
\nSERVICE - The Amazon Web Services service such as Amazon DynamoDB.
\nTENANCY - The tenancy of a resource. Examples are shared or dedicated.
\nUSAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response\n for the GetDimensionValues
operation includes a unit attribute. Examples\n include GB and Hrs.
USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2:\n CloudWatch – Alarms. The response for this operation includes a unit attribute.
\nREGION - The Amazon Web Services Region.
\nRECORD_TYPE - The different types of charges such as Reserved Instance (RI) fees,\n usage costs, tax refunds, and credits.
\nRESOURCE_ID - The unique identifier of the resource. ResourceId is an opt-in\n feature only available for last 14 days for EC2-Compute Service.
\nIf you set the context to RESERVATIONS
, you can use the following\n dimensions for searching:
AZ - The Availability Zone. An example is us-east-1a
.
CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or\n Linux.
\nDEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments.\n Valid values are SingleAZ
and MultiAZ
.
INSTANCE_TYPE - The type of Amazon EC2 instance. An example is\n m4.xlarge
.
LINKED_ACCOUNT - The description in the attribute map that includes the full name\n of the member account. The value field contains the Amazon Web Services ID of the member\n account.
\nPLATFORM - The Amazon EC2 operating system. Examples are Windows or\n Linux.
\nREGION - The Amazon Web Services Region.
\nSCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are\n regional or a single Availability Zone.
\nTAG (Coverage only) - The tags that are associated with a Reserved Instance\n (RI).
\nTENANCY - The tenancy of a resource. Examples are shared or dedicated.
\nIf you set the context to SAVINGS_PLANS
, you can use the following\n dimensions for searching:
SAVINGS_PLANS_TYPE - Type of Savings Plans (EC2 Instance or Compute)
\nPAYMENT_OPTION - The payment option for the given Savings Plans (for example, All\n Upfront)
\nREGION - The Amazon Web Services Region.
\nINSTANCE_TYPE_FAMILY - The family of instances (For example,\n m5
)
LINKED_ACCOUNT - The description in the attribute map that includes the full name\n of the member account. The value field contains the Amazon Web Services ID of the member\n account.
\nSAVINGS_PLAN_ARN - The unique identifier for your Savings Plans.
\nThe average utilization of your instances. Amazon Web Services uses this to calculate\n your recommended reservation purchases.
" + "smithy.api#documentation": "The average utilization of your recommendations. Amazon Web Services uses this to\n calculate your recommended reservation purchases.
" } }, "EstimatedBreakEvenInMonths": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "How long Amazon Web Services estimates that it takes for this instance to start saving\n you money, in months.
" + "smithy.api#documentation": "How long Amazon Web Services estimates that it takes for this recommendation to start\n saving you money, in months.
" } }, "CurrencyCode": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "The currency code that Amazon Web Services used to calculate the costs for this\n instance.
" + "smithy.api#documentation": "The currency code that Amazon Web Services used to calculate the costs for this\n recommendation.
" } }, "EstimatedMonthlySavingsAmount": { @@ -7346,13 +7366,43 @@ "UpfrontCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "How much purchasing this instance costs you upfront.
" + "smithy.api#documentation": "How much purchasing this recommendation costs you upfront.
" } }, "RecurringStandardMonthlyCost": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "How much purchasing this instance costs you on a monthly basis.
" + "smithy.api#documentation": "How much purchasing this recommendation costs you on a monthly basis.
" + } + }, + "ReservedCapacityDetails": { + "target": "com.amazonaws.costexplorer#ReservedCapacityDetails", + "traits": { + "smithy.api#documentation": "Details about the reservations that Amazon Web Services recommends that you\n purchase.
" + } + }, + "RecommendedNumberOfCapacityUnitsToPurchase": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "The number of reserved capacity units that Amazon Web Services recommends that you\n purchase.
" + } + }, + "MinimumNumberOfCapacityUnitsUsedPerHour": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "The minimum number of provisioned capacity units that you used in an hour during the\n historical period. Amazon Web Services uses this to calculate your recommended\n reservation purchases.
" + } + }, + "MaximumNumberOfCapacityUnitsUsedPerHour": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "The maximum number of provisioned capacity units that you used in an hour during the\n historical period. Amazon Web Services uses this to calculate your recommended\n reservation purchases.
" + } + }, + "AverageNumberOfCapacityUnitsUsedPerHour": { + "target": "com.amazonaws.costexplorer#GenericString", + "traits": { + "smithy.api#documentation": "The average number of provisioned capacity units that you used in an hour during the\n historical period. Amazon Web Services uses this to calculate your recommended\n reservation purchases.
" } } }, @@ -7462,6 +7512,20 @@ "target": "com.amazonaws.costexplorer#ReservationUtilizationGroup" } }, + "com.amazonaws.costexplorer#ReservedCapacityDetails": { + "type": "structure", + "members": { + "DynamoDBCapacityDetails": { + "target": "com.amazonaws.costexplorer#DynamoDBCapacityDetails", + "traits": { + "smithy.api#documentation": "The DynamoDB reservations that Amazon Web Services recommends that you purchase.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about the reservations that Amazon Web Services recommends that you\n purchase.
" + } + }, "com.amazonaws.costexplorer#ReservedHours": { "type": "string" }, @@ -7777,7 +7841,7 @@ "Service": { "target": "com.amazonaws.costexplorer#GenericString", "traits": { - "smithy.api#documentation": "The Amazon Web Service name that's associated with the cost anomaly.
" + "smithy.api#documentation": "The Amazon Web Servicesservice name that's associated with the cost anomaly.
" } }, "Region": { @@ -7806,7 +7870,7 @@ } }, "traits": { - "smithy.api#documentation": "The combination of Amazon Web Service, linked account, linked account name,\n Region, and usage type where a cost anomaly is observed. The linked account name will\n only be available when the account name can be identified.
" + "smithy.api#documentation": "The combination of Amazon Web Servicesservice, linked account, linked account name,\n Region, and usage type where a cost anomaly is observed. The linked account name will\n only be available when the account name can be identified.
" } }, "com.amazonaws.costexplorer#RootCauses": {