get_ec2_instance_recommendations async ¶

async def get_ec2_instance_recommendations(
    self,
    *,
    config_overrides: Optional[AsyncComputeOptimizerClientConfig] = None,
    instance_arns: Optional[
        "capo_compute_optimizer.types.instance_arns.InstanceArns"
    ] = None,
    next_token: Optional[
        "capo_compute_optimizer.types.next_token.NextToken"
    ] = None,
    max_results: Optional[
        "capo_compute_optimizer.types.max_results.MaxResults"
    ] = None,
    filters: Optional["capo_compute_optimizer.types.filters.Filters"] = None,
    account_ids: Optional[
        "capo_compute_optimizer.types.account_ids.AccountIds"
    ] = None,
    recommendation_preferences: Optional[
        "capo_compute_optimizer.types.recommendation_preferences.RecommendationPreferences"
    ] = None,
) -> "capo_compute_optimizer.types.get_ec2_instance_recommendations_response.GetEC2InstanceRecommendationsResponse":
    """<p>Returns Amazon EC2 instance recommendations.</p> <p>Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html">Supported resources and requirements</a> in the <i>Compute Optimizer User Guide</i>.</p>

    Args:
        instance_arns: <p>The Amazon Resource Name (ARN) of the instances for which to return recommendations.</p>
        next_token: <p>The token to advance to the next page of instance recommendations.</p>
        max_results: <p>The maximum number of instance 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 instance recommendations.</p>
        account_ids: <p>The ID of the Amazon Web Services account for which to return instance recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.</p> <p>Only one account ID can be specified per request.</p>
        recommendation_preferences: <p>An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.</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.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_compute_optimizer.types.get_ec2_instance_recommendations_request.GetEC2InstanceRecommendationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_compute_optimizer.types.get_ec2_instance_recommendations_response.GetEC2InstanceRecommendationsResponse"
    ]:
        import capo_compute_optimizer._operations.compute_optimizer_service.get_ec2_instance_recommendations

        (
            output,
            http_response,
        ) = await capo_compute_optimizer._operations.compute_optimizer_service.get_ec2_instance_recommendations.async_get_ec2_instance_recommendations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetEC2InstanceRecommendations")
    )
    input_: capo_compute_optimizer.types.get_ec2_instance_recommendations_request.GetEC2InstanceRecommendationsRequest = {}
    if instance_arns is not None:
        input_["instance_arns"] = instance_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 recommendation_preferences is not None:
        input_["recommendation_preferences"] = recommendation_preferences

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