list_recommendations async ¶

async def list_recommendations(
    self,
    *,
    config_overrides: Optional[AsyncCostOptimizationHubClientConfig] = None,
    filter: Optional["capo_cost_optimization_hub.types.filter.Filter"] = None,
    order_by: Optional["capo_cost_optimization_hub.types.order_by.OrderBy"] = None,
    include_all_recommendations: Optional[bool] = None,
    max_results: Optional[
        "capo_cost_optimization_hub.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[str] = None,
) -> "capo_cost_optimization_hub.types.list_recommendations_response.ListRecommendationsResponse":
    """<p>Returns a list of recommendations.</p>

    Args:
        filter: <p>The constraints that you want all returned recommendations to match.</p>
        order_by: <p>The ordering of recommendations by a dimension.</p>
        include_all_recommendations: <p>List of all recommendations for a resource, or a single recommendation if de-duped by <code>resourceId</code>.</p>
        max_results: <p>The maximum number of recommendations that are returned for the request.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cost_optimization_hub.types.list_recommendations_request.ListRecommendationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_cost_optimization_hub.types.list_recommendations_response.ListRecommendationsResponse"
    ]:
        import capo_cost_optimization_hub._operations.cost_optimization_hub_service.list_recommendations

        (
            output,
            http_response,
        ) = await capo_cost_optimization_hub._operations.cost_optimization_hub_service.list_recommendations.async_list_recommendations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRecommendations")
    )
    input_: capo_cost_optimization_hub.types.list_recommendations_request.ListRecommendationsRequest = {}
    if filter is not None:
        input_["filter"] = filter
    if order_by is not None:
        input_["order_by"] = order_by
    if include_all_recommendations is not None:
        input_["include_all_recommendations"] = include_all_recommendations
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output