Amazonka.ComputeOptimizer.PutRecommendationPreferences

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.

Creating a Request

data PutRecommendationPreferences

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

ToJSON PutRecommendationPreferences

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Methods

toJSON :: PutRecommendationPreferences -> Value

toEncoding :: PutRecommendationPreferences -> Encoding

toJSONList :: [PutRecommendationPreferences] -> Value

toEncodingList :: [PutRecommendationPreferences] -> Encoding

ToHeaders PutRecommendationPreferences

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Methods

toHeaders :: PutRecommendationPreferences -> [Header]

ToPath PutRecommendationPreferences

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Methods

toPath :: PutRecommendationPreferences -> ByteString

ToQuery PutRecommendationPreferences

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Methods

toQuery :: PutRecommendationPreferences -> QueryString

AWSRequest PutRecommendationPreferences

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Associated Types

type AWSResponse PutRecommendationPreferences

Methods

request :: (Service -> Service) -> PutRecommendationPreferences -> Request PutRecommendationPreferences

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutRecommendationPreferences -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutRecommendationPreferences)))

Generic PutRecommendationPreferences

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Associated Types

type Rep PutRecommendationPreferences :: Type -> Type

Methods

from :: PutRecommendationPreferences -> Rep PutRecommendationPreferences x

to :: Rep PutRecommendationPreferences x -> PutRecommendationPreferences

Read PutRecommendationPreferences

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Methods

readsPrec :: Int -> ReadS PutRecommendationPreferences

readList :: ReadS [PutRecommendationPreferences]

readPrec :: ReadPrec PutRecommendationPreferences

readListPrec :: ReadPrec [PutRecommendationPreferences]

Show PutRecommendationPreferences

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Methods

showsPrec :: Int -> PutRecommendationPreferences -> ShowS

show :: PutRecommendationPreferences -> String

showList :: [PutRecommendationPreferences] -> ShowS

NFData PutRecommendationPreferences

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Methods

rnf :: PutRecommendationPreferences -> ()

Eq PutRecommendationPreferences

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Methods

(==) :: PutRecommendationPreferences -> PutRecommendationPreferences -> Bool

(/=) :: PutRecommendationPreferences -> PutRecommendationPreferences -> Bool

Hashable PutRecommendationPreferences

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Methods

hashWithSalt :: Int -> PutRecommendationPreferences -> Int

hash :: PutRecommendationPreferences -> Int

type AWSResponse PutRecommendationPreferences

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

type AWSResponse PutRecommendationPreferences = PutRecommendationPreferencesResponse

type Rep PutRecommendationPreferences

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

Arguments

:: ResourceType

PutRecommendationPreferences

-> PutRecommendationPreferences

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)

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)

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)

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)

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

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

See: newPutRecommendationPreferencesResponse smart constructor.

Constructors

PutRecommendationPreferencesResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic PutRecommendationPreferencesResponse

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Associated Types

type Rep PutRecommendationPreferencesResponse :: Type -> Type

Methods

from :: PutRecommendationPreferencesResponse -> Rep PutRecommendationPreferencesResponse x

to :: Rep PutRecommendationPreferencesResponse x -> PutRecommendationPreferencesResponse

Read PutRecommendationPreferencesResponse

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Methods

readsPrec :: Int -> ReadS PutRecommendationPreferencesResponse

readList :: ReadS [PutRecommendationPreferencesResponse]

readPrec :: ReadPrec PutRecommendationPreferencesResponse

readListPrec :: ReadPrec [PutRecommendationPreferencesResponse]

Show PutRecommendationPreferencesResponse

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Methods

showsPrec :: Int -> PutRecommendationPreferencesResponse -> ShowS

show :: PutRecommendationPreferencesResponse -> String

showList :: [PutRecommendationPreferencesResponse] -> ShowS

NFData PutRecommendationPreferencesResponse

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Methods

rnf :: PutRecommendationPreferencesResponse -> ()

Eq PutRecommendationPreferencesResponse

Defined in Amazonka.ComputeOptimizer.PutRecommendationPreferences

Methods

(==) :: PutRecommendationPreferencesResponse -> PutRecommendationPreferencesResponse -> Bool

(/=) :: PutRecommendationPreferencesResponse -> PutRecommendationPreferencesResponse -> Bool

type Rep PutRecommendationPreferencesResponse

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

Arguments

:: Int

$sel:httpStatus:PutRecommendationPreferencesResponse'

-> PutRecommendationPreferencesResponse

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

putRecommendationPreferencesResponse_httpStatus :: Lens' PutRecommendationPreferencesResponse Int

The response's http status code.