amazonka-compute-optimizer-2.0: Amazon Compute Optimizer SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ComputeOptimizer.PutRecommendationPreferences

Description

Creates a new recommendation preference or updates an existing recommendation preference, such as enhanced infrastructure metrics.

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

Synopsis

Creating a Request

data PutRecommendationPreferences Source #

See: newPutRecommendationPreferences smart constructor.

Constructors

PutRecommendationPreferences' 

Fields

  • enhancedInfrastructureMetrics :: Maybe EnhancedInfrastructureMetrics

    The status of the enhanced infrastructure metrics recommendation preference to create or update.

    Specify the Active status to activate the preference, or specify Inactive to deactivate the preference.

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

  • externalMetricsPreference :: Maybe ExternalMetricsPreference

    The provider of the external metrics recommendation preference to create or update.

    Specify a valid provider in the source field to activate the preference. To delete this preference, see the DeleteRecommendationPreferences action.

    This preference can only be set for the Ec2Instance resource type.

    For more information, see External metrics ingestion in the Compute Optimizer User Guide.

  • inferredWorkloadTypes :: Maybe InferredWorkloadTypesPreference

    The status of the inferred workload types recommendation preference to create or update.

    The inferred workload type feature is active by default. To deactivate it, create a recommendation preference.

    Specify the Inactive status to deactivate the feature, or specify Active to activate it.

    For more information, see Inferred workload types in the Compute Optimizer User Guide.

  • scope :: Maybe Scope

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

    You can create recommendation preferences 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.

    You cannot create recommendation preferences for Auto Scaling groups at the organization and account levels. You can create recommendation preferences for Auto Scaling groups only at the resource level by specifying a scope name of ResourceArn and a scope value of the Auto Scaling group Amazon Resource Name (ARN). This will configure the preference for all instances that are part of the specified Auto Scaling group. You also cannot create recommendation preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for standalone instances.

  • resourceType :: ResourceType

    The target resource type of the recommendation preference to create.

    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.

    The valid values for this parameter are Ec2Instance and AutoScalingGroup.

Instances

Instances details
ToJSON PutRecommendationPreferences Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

ToHeaders PutRecommendationPreferences Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

ToPath PutRecommendationPreferences Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

ToQuery PutRecommendationPreferences Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

AWSRequest PutRecommendationPreferences Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Generic PutRecommendationPreferences Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Associated Types

type Rep PutRecommendationPreferences :: Type -> Type #

Read PutRecommendationPreferences Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Show PutRecommendationPreferences Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

NFData PutRecommendationPreferences Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Eq PutRecommendationPreferences Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Hashable PutRecommendationPreferences Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

type AWSResponse PutRecommendationPreferences Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

type Rep PutRecommendationPreferences Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

type Rep PutRecommendationPreferences = D1 ('MetaData "PutRecommendationPreferences" "Amazonka.ComputeOptimizer.PutRecommendationPreferences" "amazonka-compute-optimizer-2.0-5JAMFRZoNrnJ0UCJqIgHbk" 'False) (C1 ('MetaCons "PutRecommendationPreferences'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "enhancedInfrastructureMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnhancedInfrastructureMetrics)) :*: S1 ('MetaSel ('Just "externalMetricsPreference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExternalMetricsPreference))) :*: (S1 ('MetaSel ('Just "inferredWorkloadTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InferredWorkloadTypesPreference)) :*: (S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Scope)) :*: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceType)))))

newPutRecommendationPreferences Source #

Create a value of PutRecommendationPreferences with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutRecommendationPreferences, putRecommendationPreferences_enhancedInfrastructureMetrics - The status of the enhanced infrastructure metrics recommendation preference to create or update.

Specify the Active status to activate the preference, or specify Inactive to deactivate the preference.

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

PutRecommendationPreferences, putRecommendationPreferences_externalMetricsPreference - The provider of the external metrics recommendation preference to create or update.

Specify a valid provider in the source field to activate the preference. To delete this preference, see the DeleteRecommendationPreferences action.

This preference can only be set for the Ec2Instance resource type.

For more information, see External metrics ingestion in the Compute Optimizer User Guide.

PutRecommendationPreferences, putRecommendationPreferences_inferredWorkloadTypes - The status of the inferred workload types recommendation preference to create or update.

The inferred workload type feature is active by default. To deactivate it, create a recommendation preference.

Specify the Inactive status to deactivate the feature, or specify Active to activate it.

For more information, see Inferred workload types in the Compute Optimizer User Guide.

PutRecommendationPreferences, putRecommendationPreferences_scope - An object that describes the scope of the recommendation preference to create.

You can create recommendation preferences 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.

You cannot create recommendation preferences for Auto Scaling groups at the organization and account levels. You can create recommendation preferences for Auto Scaling groups only at the resource level by specifying a scope name of ResourceArn and a scope value of the Auto Scaling group Amazon Resource Name (ARN). This will configure the preference for all instances that are part of the specified Auto Scaling group. You also cannot create recommendation preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for standalone instances.

PutRecommendationPreferences, putRecommendationPreferences_resourceType - The target resource type of the recommendation preference to create.

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.

The valid values for this parameter are Ec2Instance and AutoScalingGroup.

Request Lenses

putRecommendationPreferences_enhancedInfrastructureMetrics :: Lens' PutRecommendationPreferences (Maybe EnhancedInfrastructureMetrics) Source #

The status of the enhanced infrastructure metrics recommendation preference to create or update.

Specify the Active status to activate the preference, or specify Inactive to deactivate the preference.

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

putRecommendationPreferences_externalMetricsPreference :: Lens' PutRecommendationPreferences (Maybe ExternalMetricsPreference) Source #

The provider of the external metrics recommendation preference to create or update.

Specify a valid provider in the source field to activate the preference. To delete this preference, see the DeleteRecommendationPreferences action.

This preference can only be set for the Ec2Instance resource type.

For more information, see External metrics ingestion in the Compute Optimizer User Guide.

putRecommendationPreferences_inferredWorkloadTypes :: Lens' PutRecommendationPreferences (Maybe InferredWorkloadTypesPreference) Source #

The status of the inferred workload types recommendation preference to create or update.

The inferred workload type feature is active by default. To deactivate it, create a recommendation preference.

Specify the Inactive status to deactivate the feature, or specify Active to activate it.

For more information, see Inferred workload types in the Compute Optimizer User Guide.

putRecommendationPreferences_scope :: Lens' PutRecommendationPreferences (Maybe Scope) Source #

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

You can create recommendation preferences 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.

You cannot create recommendation preferences for Auto Scaling groups at the organization and account levels. You can create recommendation preferences for Auto Scaling groups only at the resource level by specifying a scope name of ResourceArn and a scope value of the Auto Scaling group Amazon Resource Name (ARN). This will configure the preference for all instances that are part of the specified Auto Scaling group. You also cannot create recommendation preferences at the resource level for instances that are part of an Auto Scaling group. You can create recommendation preferences at the resource level only for standalone instances.

putRecommendationPreferences_resourceType :: Lens' PutRecommendationPreferences ResourceType Source #

The target resource type of the recommendation preference to create.

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.

The valid values for this parameter are Ec2Instance and AutoScalingGroup.

Destructuring the Response

data PutRecommendationPreferencesResponse Source #

Constructors

PutRecommendationPreferencesResponse' 

Fields

Instances

Instances details
Generic PutRecommendationPreferencesResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Read PutRecommendationPreferencesResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Show PutRecommendationPreferencesResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

NFData PutRecommendationPreferencesResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Eq PutRecommendationPreferencesResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

type Rep PutRecommendationPreferencesResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

type Rep PutRecommendationPreferencesResponse = D1 ('MetaData "PutRecommendationPreferencesResponse" "Amazonka.ComputeOptimizer.PutRecommendationPreferences" "amazonka-compute-optimizer-2.0-5JAMFRZoNrnJ0UCJqIgHbk" 'False) (C1 ('MetaCons "PutRecommendationPreferencesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutRecommendationPreferencesResponse Source #

Create a value of PutRecommendationPreferencesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:PutRecommendationPreferencesResponse', putRecommendationPreferencesResponse_httpStatus - The response's http status code.

Response Lenses