Skip to content

delete_recommendation_preferences

delete_recommendation_preferences(
    resource_type: ResourceType,
    recommendation_preference_names: RecommendationPreferenceNames,
    *,
    config_overrides: Optional[ComputeOptimizerClientConfig] = None,
    scope: Optional[Scope] = None,
) -> DeleteRecommendationPreferencesResponse

Deletes a recommendation preference, such as enhanced infrastructure metrics.

For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

Parameters:

  • resource_type (ResourceType) –

    The target resource type of the recommendation preference to delete.

    The Ec2Instance option encompasses standalone instances and instances that are part of Auto Scaling groups. The AutoScalingGroup option encompasses only instances that are part of an Auto Scaling group.

  • scope (Optional[Scope], default: None ) –

    An object that describes the scope of the recommendation preference to delete.

    You can delete recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see Activating enhanced infrastructure metrics in the Compute Optimizer User Guide.

  • recommendation_preference_names (RecommendationPreferenceNames) –

    The name of the recommendation preference to delete.

Raises:

Source code in docs_src/capo_compute_optimizer/_services/compute_optimizer.py
def delete_recommendation_preferences(
    self,
    resource_type: "capo_compute_optimizer.types.resource_type.ResourceType",
    recommendation_preference_names: "capo_compute_optimizer.types.recommendation_preference_names.RecommendationPreferenceNames",
    *,
    config_overrides: Optional[ComputeOptimizerClientConfig] = None,
    scope: Optional["capo_compute_optimizer.types.scope.Scope"] = None,
) -> "capo_compute_optimizer.types.delete_recommendation_preferences_response.DeleteRecommendationPreferencesResponse":
    """<p>Deletes a recommendation preference, such as enhanced infrastructure metrics.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Activating enhanced infrastructure metrics</a> in the <i>Compute Optimizer User Guide</i>.</p>

    Args:
        resource_type: <p>The target resource type of the recommendation preference to delete.</p> <p>The <code>Ec2Instance</code> option encompasses standalone instances and instances that are part of Auto Scaling groups. The <code>AutoScalingGroup</code> option encompasses only instances that are part of an Auto Scaling group.</p>
        scope: <p>An object that describes the scope of the recommendation preference to delete.</p> <p>You can delete recommendation preferences that are created at the organization level (for management accounts of an organization only), account level, and resource level. For more information, see <a href="https://docs.aws.amazon.com/compute-optimizer/latest/ug/enhanced-infrastructure-metrics.html">Activating enhanced infrastructure metrics</a> in the <i>Compute Optimizer User Guide</i>.</p>
        recommendation_preference_names: <p>The name of the recommendation preference to delete.</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.delete_recommendation_preferences_request.DeleteRecommendationPreferencesRequest]",
    ) -> OperationResponse[
        "capo_compute_optimizer.types.delete_recommendation_preferences_response.DeleteRecommendationPreferencesResponse"
    ]:
        import capo_compute_optimizer._operations.compute_optimizer_service.delete_recommendation_preferences

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteRecommendationPreferences")
    )
    input_: capo_compute_optimizer.types.delete_recommendation_preferences_request.DeleteRecommendationPreferencesRequest = {
        "resource_type": resource_type,
        "recommendation_preference_names": recommendation_preference_names,
    }
    if scope is not None:
        input_["scope"] = scope

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