Cost Optimization Hub
This page documents function available when using the Cost_Optimization_Hub module, created with @service Cost_Optimization_Hub.
Index
Main.Cost_Optimization_Hub.get_preferencesMain.Cost_Optimization_Hub.get_recommendationMain.Cost_Optimization_Hub.list_enrollment_statusesMain.Cost_Optimization_Hub.list_recommendation_summariesMain.Cost_Optimization_Hub.list_recommendationsMain.Cost_Optimization_Hub.update_enrollment_statusMain.Cost_Optimization_Hub.update_preferences
Documentation
Main.Cost_Optimization_Hub.get_preferences — Methodget_preferences()
get_preferences(params::Dict{String,<:Any})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.
Main.Cost_Optimization_Hub.get_recommendation — Methodget_recommendation(recommendation_id)
get_recommendation(recommendation_id, params::Dict{String,<:Any})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.
Arguments
recommendation_id: The ID for the recommendation.
Main.Cost_Optimization_Hub.list_enrollment_statuses — Methodlist_enrollment_statuses()
list_enrollment_statuses(params::Dict{String,<:Any})Retrieves the enrollment status for an account. It can also return the list of accounts that are enrolled under the organization.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"accountId": The account ID of a member account in the organization."includeOrganizationInfo": Indicates whether to return the enrollment status for the organization."maxResults": The maximum number of objects that are returned for the request."nextToken": The token to retrieve the next set of results.
Main.Cost_Optimization_Hub.list_recommendation_summaries — Methodlist_recommendation_summaries(group_by)
list_recommendation_summaries(group_by, params::Dict{String,<:Any})Returns a concise representation of savings estimates for resources. Also returns de-duped savings across different types of recommendations. The following filters are not supported for this API: recommendationIds, resourceArns, and resourceIds.
Arguments
group_by: The grouping of recommendations by a dimension.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"filter":"maxResults": The maximum number of recommendations that are returned for the request."nextToken": The token to retrieve the next set of results.
Main.Cost_Optimization_Hub.list_recommendations — Methodlist_recommendations()
list_recommendations(params::Dict{String,<:Any})Returns a list of recommendations.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"filter": The constraints that you want all returned recommendations to match."includeAllRecommendations": List of all recommendations for a resource, or a single recommendation if de-duped by resourceId."maxResults": The maximum number of recommendations that are returned for the request."nextToken": The token to retrieve the next set of results."orderBy": The ordering of recommendations by a dimension.
Main.Cost_Optimization_Hub.update_enrollment_status — Methodupdate_enrollment_status(status)
update_enrollment_status(status, params::Dict{String,<:Any})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 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. When you opt in, Cost Optimization Hub automatically creates a service-linked role in your account to access its data.
Arguments
status: Sets the account status.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"includeMemberAccounts": Indicates whether to enroll member accounts of the organization if the account is the management account.
Main.Cost_Optimization_Hub.update_preferences — Methodupdate_preferences()
update_preferences(params::Dict{String,<:Any})Updates 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.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"memberAccountDiscountVisibility": Sets the "member account discount visibility" preference."savingsEstimationMode": Sets the "savings estimation mode" preference.