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.
Parameters:
-
group_by
(str)
–
The grouping of recommendations by a dimension.
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of recommendations to be returned for the request.
-
metrics
(Optional[SummaryMetricsList], default:
None
)
–
Additional metrics to be returned for the request. The only valid value is savingsPercentage.
-
next_token
(Optional[str], default:
None
)
–
The token to retrieve the next set of results.
Raises:
Source code in docs_src/capo_cost_optimization_hub/_services/cost_optimization_hub.py
| def list_recommendation_summaries(
self,
group_by: str,
*,
config_overrides: Optional[CostOptimizationHubClientConfig] = None,
filter: Optional["capo_cost_optimization_hub.types.filter.Filter"] = None,
max_results: Optional[
"capo_cost_optimization_hub.types.max_results.MaxResults"
] = None,
metrics: Optional[
"capo_cost_optimization_hub.types.summary_metrics_list.SummaryMetricsList"
] = None,
next_token: Optional[str] = None,
) -> "capo_cost_optimization_hub.types.list_recommendation_summaries_response.ListRecommendationSummariesResponse":
"""<p>Returns a concise representation of savings estimates for resources. Also returns de-duped savings across different types of recommendations.</p> <note> <p>The following filters are not supported for this API: <code>recommendationIds</code>, <code>resourceArns</code>, and <code>resourceIds</code>.</p> </note>
Args:
group_by: <p>The grouping of recommendations by a dimension.</p>
max_results: <p>The maximum number of recommendations to be returned for the request.</p>
metrics: <p>Additional metrics to be returned for the request. The only valid value is <code>savingsPercentage</code>.</p>
next_token: <p>The token to retrieve the next set of results.</p>
Raises:
capo_cost_optimization_hub.errors.access_denied_exception.AccessDeniedException: <p>You are not authorized to use this operation with the given parameters.</p>
capo_cost_optimization_hub.errors.internal_server_exception.InternalServerException: <p>An error on the server occurred during the processing of your request. Try again later.</p>
capo_cost_optimization_hub.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_cost_optimization_hub.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
capo_cost_optimization_hub.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_cost_optimization_hub.types.list_recommendation_summaries_request.ListRecommendationSummariesRequest]",
) -> OperationResponse[
"capo_cost_optimization_hub.types.list_recommendation_summaries_response.ListRecommendationSummariesResponse"
]:
import capo_cost_optimization_hub._operations.cost_optimization_hub_service.list_recommendation_summaries
output, http_response = (
capo_cost_optimization_hub._operations.cost_optimization_hub_service.list_recommendation_summaries.list_recommendation_summaries(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListRecommendationSummaries")
)
input_: capo_cost_optimization_hub.types.list_recommendation_summaries_request.ListRecommendationSummariesRequest = {
"group_by": group_by
}
if filter is not None:
input_["filter"] = filter
if max_results is not None:
input_["max_results"] = max_results
if metrics is not None:
input_["metrics"] = metrics
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|