The AWS SDK for JavaScript v2 has reached end-of-support.

We recommend that you migrate to AWS SDK for JavaScript v3. For additional details and information on how to migrate, please refer to the announcement.

Class: AWS.CostOptimizationHub

Inherits:

AWS.Service

Object
AWS.Service
AWS.CostOptimizationHub

show all

Identifier:: costoptimizationhub

API Version:: 2022-07-26

Defined in:: (unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

You can use the Cost Optimization Hub API to programmatically identify, filter, aggregate, and quantify savings for your cost optimization recommendations across multiple Amazon Web Services Regions and Amazon Web Services accounts in your organization.

The Cost Optimization Hub API provides the following endpoint:

https://cost-optimization-hub.us-east-1.amazonaws.com

Sending a Request Using CostOptimizationHub

var costoptimizationhub = new AWS.CostOptimizationHub();
costoptimizationhub.getPreferences(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the CostOptimizationHub object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var costoptimizationhub = new AWS.CostOptimizationHub({apiVersion: '2022-07-26'});

You can also set the API version globally in AWS.config.apiVersions using the costoptimizationhub service identifier:

AWS.config.apiVersions = {
  costoptimizationhub: '2022-07-26',
  // other service API versions
};

var costoptimizationhub = new AWS.CostOptimizationHub();

Version:

2022-07-26

Constructor Summary collapse

new AWS.CostOptimizationHub(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

getPreferences(params = {}, callback) ⇒ AWS.Request
Returns a set of preferences for an account in order to add account-specific preferences into the service.
getRecommendation(params = {}, callback) ⇒ AWS.Request
Returns both the current and recommended resource configuration and the estimated cost impact for a recommendation.

The recommendationId is only valid for up to a maximum of 24 hours as recommendations are refreshed daily.
listEnrollmentStatuses(params = {}, callback) ⇒ AWS.Request
Retrieves the enrollment status for an account.
listRecommendations(params = {}, callback) ⇒ AWS.Request
Returns a list of recommendations.

.
listRecommendationSummaries(params = {}, callback) ⇒ AWS.Request
Returns a concise representation of savings estimates for resources.
updateEnrollmentStatus(params = {}, callback) ⇒ AWS.Request
Updates the enrollment (opt in and opt out) status of an account to the Cost Optimization Hub service.

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.

You must have the appropriate permissions to opt in to Cost Optimization Hub and to view its recommendations.
updatePreferences(params = {}, callback) ⇒ AWS.Request
Updates a set of preferences for an account in order to add account-specific preferences into the service.
waitFor(state, params = {}, callback) ⇒ AWS.Request
Waits for a given CostOptimizationHub resource.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

new AWS.CostOptimizationHub(options = {}) ⇒ `Object`

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a CostOptimizationHub object

var costoptimizationhub = new AWS.CostOptimizationHub({apiVersion: '2022-07-26'});

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.CostOptimizationHub.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.CostOptimizationHub.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.CostOptimizationHub.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
useFipsEndpoint (Boolean) —
Enables FIPS compatible endpoints. Defaults to false.
useDualstackEndpoint (Boolean) —
Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

getPreferences(params = {}, callback) ⇒ `AWS.Request`

Returns a set of preferences for an account in order to add account-specific preferences into the service. These preferences impact how the savings associated with recommendations are presented—estimated savings after discounts or estimated savings before discounts, for example.

Service Reference:

GetPreferences

Examples:

Calling the getPreferences operation

var params = {
};
costoptimizationhub.getPreferences(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {})

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - savingsEstimationMode — (String)
    Retrieves the status of the "savings estimation mode" preference.
    Possible values include:
    
    "BeforeDiscounts"
    
    "AfterDiscounts"
  - memberAccountDiscountVisibility — (String)
    Retrieves the status of the "member account discount visibility" preference.
    Possible values include:
    
    "All"
    
    "None"

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getRecommendation(params = {}, callback) ⇒ `AWS.Request`

Returns both the current and recommended resource configuration and the estimated cost impact for a recommendation.

The recommendationId is only valid for up to a maximum of 24 hours as recommendations are refreshed daily. To retrieve the recommendationId, use the ListRecommendations API.

Service Reference:

GetRecommendation

Examples:

Calling the getRecommendation operation

var params = {
  recommendationId: 'STRING_VALUE' /* required */
};
costoptimizationhub.getRecommendation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- recommendationId — (String)
  The ID for the recommendation.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - recommendationId — (String)
    The ID for the recommendation.
  - resourceId — (String)
    The unique identifier for the resource. This is the same as the Amazon Resource Name (ARN), if available.
  - resourceArn — (String)
    The Amazon Resource Name (ARN) of the resource.
  - accountId — (String)
    The account that the recommendation is for.
  - currencyCode — (String)
    The currency code used for the recommendation.
  - recommendationLookbackPeriodInDays — (Integer)
    The lookback period that's used to generate the recommendation.
  - costCalculationLookbackPeriodInDays — (Integer)
    The lookback period used to calculate cost impact for a recommendation.
  - estimatedSavingsPercentage — (Float)
    The estimated savings percentage relative to the total cost over the cost calculation lookback period.
  - estimatedSavingsOverCostCalculationLookbackPeriod — (Float)
    The estimated savings amount over the lookback period used to calculate cost impact for a recommendation.
  - currentResourceType — (String)
    The type of resource.
    Possible values include:
    
    "Ec2Instance"
    
    "LambdaFunction"
    
    "EbsVolume"
    
    "EcsService"
    
    "Ec2AutoScalingGroup"
    
    "Ec2InstanceSavingsPlans"
    
    "ComputeSavingsPlans"
    
    "SageMakerSavingsPlans"
    
    "Ec2ReservedInstances"
    
    "RdsReservedInstances"
    
    "OpenSearchReservedInstances"
    
    "RedshiftReservedInstances"
    
    "ElastiCacheReservedInstances"
    
    "RdsDbInstanceStorage"
    
    "RdsDbInstance"
  - recommendedResourceType — (String)
    The resource type of the recommendation.
    Possible values include:
    
    "Ec2Instance"
    
    "LambdaFunction"
    
    "EbsVolume"
    
    "EcsService"
    
    "Ec2AutoScalingGroup"
    
    "Ec2InstanceSavingsPlans"
    
    "ComputeSavingsPlans"
    
    "SageMakerSavingsPlans"
    
    "Ec2ReservedInstances"
    
    "RdsReservedInstances"
    
    "OpenSearchReservedInstances"
    
    "RedshiftReservedInstances"
    
    "ElastiCacheReservedInstances"
    
    "RdsDbInstanceStorage"
    
    "RdsDbInstance"
  - region — (String)
    The Amazon Web Services Region of the resource.
  - source — (String)
    The source of the recommendation.
    Possible values include:
    
    "ComputeOptimizer"
    
    "CostExplorer"
  - lastRefreshTimestamp — (Date)
    The time when the recommendation was last generated.
  - estimatedMonthlySavings — (Float)
    The estimated monthly savings amount for the recommendation.
  - estimatedMonthlyCost — (Float)
    The estimated monthly cost of the current resource. For Reserved Instances and Savings Plans, it refers to the cost for eligible usage.
  - implementationEffort — (String)
    The effort required to implement the recommendation.
    Possible values include:
    
    "VeryLow"
    
    "Low"
    
    "Medium"
    
    "High"
    
    "VeryHigh"
  - restartNeeded — (Boolean)
    Whether or not implementing the recommendation requires a restart.
  - actionType — (String)
    The type of action you can take by adopting the recommendation.
    Possible values include:
    
    "Rightsize"
    
    "Stop"
    
    "Upgrade"
    
    "PurchaseSavingsPlans"
    
    "PurchaseReservedInstances"
    
    "MigrateToGraviton"
  - rollbackPossible — (Boolean)
    Whether or not implementing the recommendation can be rolled back.
  - currentResourceDetails — (map)
    The details for the resource.
    
    lambdaFunction — (map)
    The Lambda function recommendation details.
    
    configuration — (map)
    The Lambda function configuration used for recommendations.
    
    compute — (map)
    Details about the compute configuration.
    
    vCpu — (Float)
    The number of vCPU cores in the resource.
    
    memorySizeInMB — (Integer)
    The memory size of the resource.
    
    architecture — (String)
    The architecture of the resource.
    
    platform — (String)
    The platform of the resource. The platform is the specific combination of operating system, license model, and software on an instance.
    
    costCalculation — (map)
    Cost impact of the recommendation.
    
    usages — (Array<map>)
    Usage details of the resource recommendation.
    
    usageType — (String)
    The usage type.
    
    usageAmount — (Float)
    The usage amount.
    
    operation — (String)
    The operation value.
    
    productCode — (String)
    The product code.
    
    unit — (String)
    The usage unit.
    
    pricing — (map)
    Pricing details of the resource recommendation.
    
    estimatedCostBeforeDiscounts — (Float)
    The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
    
    estimatedNetUnusedAmortizedCommitments — (Float)
    The estimated net unused amortized commitment for the recommendation.
    
    estimatedDiscounts — (map)
    The estimated discounts for a recommendation.
    
    savingsPlansDiscount — (Float)
    Estimated Savings Plans discounts.
    
    reservedInstancesDiscount — (Float)
    Estimated reserved instance discounts.
    
    otherDiscount — (Float)
    Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount.
    
    estimatedCostAfterDiscounts — (Float)
    The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
    
    ecsService — (map)
    The ECS service recommendation details.
    
    configuration — (map)
    The ECS service configuration used for recommendations.
    
    compute — (map)
    Details about the compute configuration.
    
    vCpu — (Float)
    The number of vCPU cores in the resource.
    
    memorySizeInMB — (Integer)
    The memory size of the resource.
    
    architecture — (String)
    The architecture of the resource.
    
    platform — (String)
    The platform of the resource. The platform is the specific combination of operating system, license model, and software on an instance.
    
    costCalculation — (map)
    Cost impact of the recommendation.
    
    usages — (Array<map>)
    Usage details of the resource recommendation.
    
    usageType — (String)
    The usage type.
    
    usageAmount — (Float)
    The usage amount.
    
    operation — (String)
    The operation value.
    
    productCode — (String)
    The product code.
    
    unit — (String)
    The usage unit.
    
    pricing — (map)
    Pricing details of the resource recommendation.
    
    estimatedCostBeforeDiscounts — (Float)
    The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
    
    estimatedNetUnusedAmortizedCommitments — (Float)
    The estimated net unused amortized commitment for the recommendation.
    
    estimatedDiscounts — (map)
    The estimated discounts for a recommendation.
    
    savingsPlansDiscount — (Float)
    Estimated Savings Plans discounts.
    
    reservedInstancesDiscount — (Float)
    Estimated reserved instance discounts.
    
    otherDiscount — (Float)
    Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount.
    
    estimatedCostAfterDiscounts — (Float)
    The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
    
    ec2Instance — (map)
    The EC2 instance recommendation details.
    
    configuration — (map)
    The EC2 instance configuration used for recommendations.
    
    instance — (map)
    Details about the instance.
    
    type — (String)
    Details about the type.
    
    costCalculation — (map)
    Cost impact of the recommendation.
    
    usages — (Array<map>)
    Usage details of the resource recommendation.
    
    usageType — (String)
    The usage type.
    
    usageAmount — (Float)
    The usage amount.
    
    operation — (String)
    The operation value.
    
    productCode — (String)
    The product code.
    
    unit — (String)
    The usage unit.
    
    pricing — (map)
    Pricing details of the resource recommendation.
    
    estimatedCostBeforeDiscounts — (Float)
    The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
    
    estimatedNetUnusedAmortizedCommitments — (Float)
    The estimated net unused amortized commitment for the recommendation.
    
    estimatedDiscounts — (map)
    The estimated discounts for a recommendation.
    
    savingsPlansDiscount — (Float)
    Estimated Savings Plans discounts.
    
    reservedInstancesDiscount — (Float)
    Estimated reserved instance discounts.
    
    otherDiscount — (Float)
    Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount.
    
    estimatedCostAfterDiscounts — (Float)
    The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
    
    ebsVolume — (map)
    The Amazon Elastic Block Store volume recommendation details.
    
    configuration — (map)
    The Amazon Elastic Block Store volume configuration used for recommendations.
    
    storage — (map)
    The disk storage of the Amazon Elastic Block Store volume.
    
    type — (String)
    The storage type.
    
    sizeInGb — (Float)
    The storage volume.
    
    performance — (map)
    The Amazon Elastic Block Store performance configuration.
    
    iops — (Float)
    The number of I/O operations per second.
    
    throughput — (Float)
    The throughput that the volume supports.
    
    attachmentState — (String)
    The Amazon Elastic Block Store attachment state.
    
    costCalculation — (map)
    Cost impact of the recommendation.
    
    usages — (Array<map>)
    Usage details of the resource recommendation.
    
    usageType — (String)
    The usage type.
    
    usageAmount — (Float)
    The usage amount.
    
    operation — (String)
    The operation value.
    
    productCode — (String)
    The product code.
    
    unit — (String)
    The usage unit.
    
    pricing — (map)
    Pricing details of the resource recommendation.
    
    estimatedCostBeforeDiscounts — (Float)
    The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
    
    estimatedNetUnusedAmortizedCommitments — (Float)
    The estimated net unused amortized commitment for the recommendation.
    
    estimatedDiscounts — (map)
    The estimated discounts for a recommendation.
    
    savingsPlansDiscount — (Float)
    Estimated Savings Plans discounts.
    
    reservedInstancesDiscount — (Float)
    Estimated reserved instance discounts.
    
    otherDiscount — (Float)
    Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount.
    
    estimatedCostAfterDiscounts — (Float)
    The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
    
    ec2AutoScalingGroup — (map)
    The EC2 Auto Scaling group recommendation details.
    
    configuration — (map)
    The EC2 Auto Scaling group configuration used for recommendations.
    
    instance — (map)
    Details about the instance.
    
    type — (String)
    Details about the type.
    
    costCalculation — (map)
    Cost impact of the recommendation.
    
    usages — (Array<map>)
    Usage details of the resource recommendation.
    
    usageType — (String)
    The usage type.
    
    usageAmount — (Float)
    The usage amount.
    
    operation — (String)
    The operation value.
    
    productCode — (String)
    The product code.
    
    unit — (String)
    The usage unit.
    
    pricing — (map)
    Pricing details of the resource recommendation.
    
    estimatedCostBeforeDiscounts — (Float)
    The savings estimate using Amazon Web Services public pricing without incorporating any discounts.
    
    estimatedNetUnusedAmortizedCommitments — (Float)
    The estimated net unused amortized commitment for the recommendation.
    
    estimatedDiscounts — (map)
    The estimated discounts for a recommendation.
    
    savingsPlansDiscount — (Float)
    Estimated Savings Plans discounts.
    
    reservedInstancesDiscount — (Float)
    Estimated reserved instance discounts.
    
    otherDiscount — (Float)
    Estimated other discounts include all discounts that are not itemized. Itemized discounts include reservedInstanceDiscount and savingsPlansDiscount.
    
    estimatedCostAfterDiscounts — (Float)
    The savings estimate incorporating all discounts with Amazon Web Services, such as Reserved Instances and Savings Plans.
    
    ec2ReservedInstances — (map)
    The EC2 reserved instances recommendation details.
    
    configuration — (map)
    The EC2 reserved instances configuration used for recommendations.
    
    accountScope — (String)
    The account scope that you want your recommendations for.
    
    service — (String)
    The service that you want your recommendations for.
    
    normalizedUnitsToPurchase — (String)
    The number of normalized units that Amazon Web Services recommends that you purchase.
    
    term — (String)
    The reserved instances recommendation term in years.
    
    paymentOption — (String)
    The payment option for the commitment.
    
    numberOfInstancesToPurchase — (String)
    The number of instances that Amazon Web Services recommends that you purchase.
    
    offeringClass — (String)
    Indicates whether the recommendation is for standard or convertible reservations.
    
    instanceFamily — (String)
    The instance family of the recommended reservation.
    
    instanceType — (String)
    The type of instance that Amazon Web Services recommends.
    
    reservedInstancesRegion — (String)
    The Amazon Web Services Region of the commitment.
    
    currentGeneration — (String)
    Determines whether the recommendation is for a current generation instance.
    
    platform — (String)
    The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.
    
    tenancy — (String)
    Determines whether the recommended reservation is dedicated or shared.
    
    sizeFlexEligible — (Boolean)
    Determines whether the recommendation is size flexible.
    
    upfrontCost — (String)
    How much purchasing this instance costs you upfront.
    
    monthlyRecurringCost — (String)
    How much purchasing reserved instances costs you on a monthly basis.
    
    costCalculation — (map)
    Cost impact of the purchase recommendation.
    
    pricing — (map)
    Pricing details of the purchase recommendation.
    
    estimatedOnDemandCost — (Float)
    The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.
    
    monthlyReservationEligibleCost — (Float)
    The cost of paying for the recommended reserved instance monthly.
    
    savingsPercentage — (Float)
    The savings percentage relative to the total On-Demand costs that are associated with this instance.
    
    estimatedMonthlyAmortizedReservationCost — (Float)
    The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.
    
    rdsReservedInstances — (map)
    The RDS reserved instances recommendation details.
    
    configuration — (map)
    The RDS reserved instances configuration used for recommendations.
    
    accountScope — (String)
    The account scope that you want your recommendations for.
    
    service — (String)
    The service that you want your recommendations for.
    
    normalizedUnitsToPurchase — (String)
    The number of normalized units that Amazon Web Services recommends that you purchase.
    
    term — (String)
    The reserved instances recommendation term in years.
    
    paymentOption — (String)
    The payment option for the commitment.
    
    numberOfInstancesToPurchase — (String)
    The number of instances that Amazon Web Services recommends that you purchase.
    
    instanceFamily — (String)
    The instance family of the recommended reservation.
    
    instanceType — (String)
    The type of instance that Amazon Web Services recommends.
    
    reservedInstancesRegion — (String)
    The Amazon Web Services Region of the commitment.
    
    sizeFlexEligible — (Boolean)
    Determines whether the recommendation is size flexible.
    
    currentGeneration — (String)
    Determines whether the recommendation is for a current generation instance.
    
    upfrontCost — (String)
    How much purchasing this instance costs you upfront.
    
    monthlyRecurringCost — (String)
    How much purchasing this instance costs you on a monthly basis.
    
    licenseModel — (String)
    The license model that the recommended reservation supports.
    
    databaseEdition — (String)
    The database edition that the recommended reservation supports.
    
    databaseEngine — (String)
    The database engine that the recommended reservation supports.
    
    deploymentOption — (String)
    Determines whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.
    
    costCalculation — (map)
    Cost impact of the purchase recommendation.
    
    pricing — (map)
    Pricing details of the purchase recommendation.
    
    estimatedOnDemandCost — (Float)
    The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.
    
    monthlyReservationEligibleCost — (Float)
    The cost of paying for the recommended reserved instance monthly.
    
    savingsPercentage — (Float)
    The savings percentage relative to the total On-Demand costs that are associated with this instance.
    
    estimatedMonthlyAmortizedReservationCost — (Float)
    The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.
    
    elastiCacheReservedInstances — (map)
    The ElastiCache reserved instances recommendation details.
    
    configuration — (map)
    The ElastiCache reserved instances configuration used for recommendations.
    
    accountScope — (String)
    The account scope that you want your recommendations for.
    
    service — (String)
    The service that you want your recommendations for.
    
    normalizedUnitsToPurchase — (String)
    The number of normalized units that Amazon Web Services recommends that you purchase.
    
    term — (String)
    The reserved instances recommendation term in years.
    
    paymentOption — (String)
    The payment option for the commitment.
    
    numberOfInstancesToPurchase — (String)
    The number of instances that Amazon Web Services recommends that you purchase.
    
    instanceFamily — (String)
    The instance family of the recommended reservation.
    
    instanceType — (String)
    The type of instance that Amazon Web Services recommends.
    
    reservedInstancesRegion — (String)
    The Amazon Web Services Region of the commitment.
    
    currentGeneration — (String)
    Determines whether the recommendation is for a current generation instance.
    
    sizeFlexEligible — (Boolean)
    Determines whether the recommendation is size flexible.
    
    upfrontCost — (String)
    How much purchasing this instance costs you upfront.
    
    monthlyRecurringCost — (String)
    How much purchasing reserved instances costs you on a monthly basis.
    
    costCalculation — (map)
    Cost impact of the purchase recommendation.
    
    pricing — (map)
    Pricing details of the purchase recommendation.
    
    estimatedOnDemandCost — (Float)
    The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.
    
    monthlyReservationEligibleCost — (Float)
    The cost of paying for the recommended reserved instance monthly.
    
    savingsPercentage — (Float)
    The savings percentage relative to the total On-Demand costs that are associated with this instance.
    
    estimatedMonthlyAmortizedReservationCost — (Float)
    The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.
    
    openSearchReservedInstances — (map)
    The OpenSearch reserved instances recommendation details.
    
    configuration — (map)
    The OpenSearch reserved instances configuration used for recommendations.
    
    accountScope — (String)
    The account scope that you want your recommendations for.
    
    service — (String)
    The service that you want your recommendations for.
    
    normalizedUnitsToPurchase — (String)
    The number of normalized units that Amazon Web Services recommends that you purchase.
    
    term — (String)
    The reserved instances recommendation term in years.
    
    paymentOption — (String)
    The payment option for the commitment.
    
    numberOfInstancesToPurchase — (String)
    The number of instances that Amazon Web Services recommends that you purchase.
    
    instanceType — (String)
    The type of instance that Amazon Web Services recommends.
    
    reservedInstancesRegion — (String)
    The Amazon Web Services Region of the commitment.
    
    currentGeneration — (String)
    Determines whether the recommendation is for a current generation instance.
    
    sizeFlexEligible — (Boolean)
    Determines whether the recommendation is size flexible.
    
    upfrontCost — (String)
    How much purchasing this instance costs you upfront.
    
    monthlyRecurringCost — (String)
    How much purchasing reserved instances costs you on a monthly basis.
    
    costCalculation — (map)
    Cost impact of the purchase recommendation.
    
    pricing — (map)
    Pricing details of the purchase recommendation.
    
    estimatedOnDemandCost — (Float)
    The remaining On-Demand cost estimated to not be covered by the recommended reserved instance, over the length of the lookback period.
    
    monthlyReservationEligibleCost — (Float)
    The cost of paying for the recommended reserved instance monthly.
    
    savingsPercentage — (Float)
    The savings percentage relative to the total On-Demand costs that are associated with this instance.
    
    estimatedMonthlyAmortizedReservationCost — (Float)
    The estimated cost of your recurring monthly fees for the recommended reserved instance across the month.
    
    redshiftReservedInstances — (map)
    The Redshift reserved instances recommendation details.
    
    configuration — (map)
    The Redshift reserved instances configuration used for recommendations.
    
    accountScope — (String)
    The account scope that you want your recommendations for.
    
    service — (String)
    The service that you want your recommendations for.
    
    normalizedUnitsToPurchase — (String)
    The number of normalized units that Amazon Web Services recommends that you purchase.
    
    term — (String)
    The reserved instances recommendation term in years.
    
    paymentOption — (String)
    The payment option for the commitment.
    
    numberOfInstancesToPurchase — (String)
    The number of instances that Amazon Web Services recommends that you purchase.
    
    instanceFamily — (String)
    The instance family of the recommended reservation.
    
    instanceType — (String)
    The type of instance that Amazon Web Services recommends.
    
    reservedInstancesRegion — (String)
    The Amazon Web Services Region of the commitment.
    
    sizeFlexEligible — (Boolean)
    Determines whether the recommendation is size flexible.
    
    currentGeneration — (String)
    Determines whether the recommendation is for a current generation instance.
    
    upfrontCost — (String)
    How much purchasing this instance costs you upfront.

Class: AWS.CostOptimizationHub

Overview

Service Description

Sending a Request Using CostOptimizationHub

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

new AWS.CostOptimizationHub(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

getPreferences(params = {}, callback) ⇒ AWS.Request

getRecommendation(params = {}, callback) ⇒ AWS.Request

new AWS.CostOptimizationHub(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

getPreferences(params = {}, callback) ⇒ `AWS.Request`

getRecommendation(params = {}, callback) ⇒ `AWS.Request`