get_effective_recommendation_preferences `async` ¶

get_effective_recommendation_preferences(
    resource_arn: ResourceArn,
    *,
    config_overrides: Optional[AsyncComputeOptimizerClientConfig] = None,
) -> GetEffectiveRecommendationPreferencesResponse

Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics. Considers all applicable preferences that you might have set at the resource, account, and organization level.

When you create a recommendation preference, you can set its status to Active or Inactive. Use this action to view the recommendation preferences that are in effect, or Active.

Parameters:

resource_arn (ResourceArn) –

The Amazon Resource Name (ARN) of the resource for which to confirm effective recommendation preferences. Only EC2 instance and Auto Scaling group ARNs are currently supported.

Raises:

AccessDeniedException –

You do not have sufficient access to perform this action.
InternalServerException –

An internal error has occurred. Try your call again.
InvalidParameterValueException –

The value supplied for the input parameter is out of range or not valid.
MissingAuthenticationToken –

The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
OptInRequiredException –

The account is not opted in to Compute Optimizer.
ResourceNotFoundException –

A resource that is required for the action doesn't exist.
ServiceUnavailableException –

The request has failed due to a temporary failure of the server.
ThrottlingException –

The request was denied due to request throttling.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_compute_optimizer/_services/async_compute_optimizer.py

async def get_effective_recommendation_preferences(
    self,
    resource_arn: "capo_compute_optimizer.types.resource_arn.ResourceArn",
    *,
    config_overrides: Optional[AsyncComputeOptimizerClientConfig] = None,
) -> "capo_compute_optimizer.types.get_effective_recommendation_preferences_response.GetEffectiveRecommendationPreferencesResponse":
    """<p>Returns the recommendation preferences that are in effect for a given resource, such as enhanced infrastructure metrics. Considers all applicable preferences that you might have set at the resource, account, and organization level.</p> <p>When you create a recommendation preference, you can set its status to <code>Active</code> or <code>Inactive</code>. Use this action to view the recommendation preferences that are in effect, or <code>Active</code>.</p>

    Args:
        resource_arn: <p>The Amazon Resource Name (ARN) of the resource for which to confirm effective recommendation preferences. Only EC2 instance and Auto Scaling group ARNs are currently supported.</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_effective_recommendation_preferences_request.GetEffectiveRecommendationPreferencesRequest]",
    ) -> AsyncOperationResponse[
        "capo_compute_optimizer.types.get_effective_recommendation_preferences_response.GetEffectiveRecommendationPreferencesResponse"
    ]:
        import capo_compute_optimizer._operations.compute_optimizer_service.get_effective_recommendation_preferences

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetEffectiveRecommendationPreferences")
    )
    input_: capo_compute_optimizer.types.get_effective_recommendation_preferences_request.GetEffectiveRecommendationPreferencesRequest = {
        "resource_arn": resource_arn
    }

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

get_effective_recommendation_preferences async ¶

get_effective_recommendation_preferences `async` ¶