get_idle_recommendations ¶

def get_idle_recommendations(
    self,
    *,
    config_overrides: Optional[ComputeOptimizerClientConfig] = None,
    resource_arns: Optional[
        "capo_compute_optimizer.types.resource_arns.ResourceArns"
    ] = None,
    next_token: Optional[
        "capo_compute_optimizer.types.next_token.NextToken"
    ] = None,
    max_results: Optional[
        "capo_compute_optimizer.types.idle_max_results.IdleMaxResults"
    ] = None,
    filters: Optional[
        "capo_compute_optimizer.types.idle_recommendation_filters.IdleRecommendationFilters"
    ] = None,
    account_ids: Optional[
        "capo_compute_optimizer.types.account_ids.AccountIds"
    ] = None,
    order_by: Optional["capo_compute_optimizer.types.order_by.OrderBy"] = None,
) -> "capo_compute_optimizer.types.get_idle_recommendations_response.GetIdleRecommendationsResponse":
    """<p>Returns idle resource recommendations. Compute Optimizer generates recommendations for idle resources that meet a specific set of requirements. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html">Resource requirements</a> in the <i>Compute Optimizer User Guide</i> </p>

    Args:
        resource_arns: <p>The ARN that identifies the idle resource.</p>
        next_token: <p>The token to advance to the next page of idle resource recommendations.</p>
        max_results: <p>The maximum number of idle resource recommendations to return with a single request. </p> <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>
        filters: <p>An array of objects to specify a filter that returns a more specific list of idle resource recommendations.</p>
        account_ids: <p>Return the idle resource recommendations to the specified Amazon Web Services account IDs.</p> <p>If your account is the management account or the delegated administrator of an organization, use this parameter to return the idle resource recommendations to specific member accounts.</p> <p>You can only specify one account ID per request.</p>
        order_by: <p>The order to sort the idle resource recommendations.</p>

    Raises:
        capo_compute_optimizer.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_compute_optimizer.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred. Try your call again.</p>
        capo_compute_optimizer.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value supplied for the input parameter is out of range or not valid.</p>
        capo_compute_optimizer.errors.missing_authentication_token.MissingAuthenticationToken: <p>The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.</p>
        capo_compute_optimizer.errors.opt_in_required_exception.OptInRequiredException: <p>The account is not opted in to Compute Optimizer.</p>
        capo_compute_optimizer.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action doesn't exist.</p>
        capo_compute_optimizer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed due to a temporary failure of the server.</p>
        capo_compute_optimizer.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_compute_optimizer.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_compute_optimizer.types.get_idle_recommendations_request.GetIdleRecommendationsRequest]",
    ) -> OperationResponse[
        "capo_compute_optimizer.types.get_idle_recommendations_response.GetIdleRecommendationsResponse"
    ]:
        import capo_compute_optimizer._operations.compute_optimizer_service.get_idle_recommendations

        output, http_response = (
            capo_compute_optimizer._operations.compute_optimizer_service.get_idle_recommendations.get_idle_recommendations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetIdleRecommendations")
    )
    input_: capo_compute_optimizer.types.get_idle_recommendations_request.GetIdleRecommendationsRequest = {}
    if resource_arns is not None:
        input_["resource_arns"] = resource_arns
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if filters is not None:
        input_["filters"] = filters
    if account_ids is not None:
        input_["account_ids"] = account_ids
    if order_by is not None:
        input_["order_by"] = order_by

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output