put_recommendation_preferences

ComputeOptimizer.Client.put_recommendation_preferences(**kwargs)

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 .

See also: AWS API Documentation

Request Syntax

response = client.put_recommendation_preferences(
    resourceType='Ec2Instance'|'AutoScalingGroup'|'EbsVolume'|'LambdaFunction'|'NotApplicable'|'EcsService',
    scope={
        'name': 'Organization'|'AccountId'|'ResourceArn',
        'value': 'string'
    },
    enhancedInfrastructureMetrics='Active'|'Inactive',
    inferredWorkloadTypes='Active'|'Inactive',
    externalMetricsPreference={
        'source': 'Datadog'|'Dynatrace'|'NewRelic'|'Instana'
    }
)

Parameters

• resourceType (string) --

  [REQUIRED]

  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.

  Note

  The valid values for this parameter are Ec2Instance and AutoScalingGroup .

• scope (dict) --

  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 .

  Note

  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.

  • name (string) --

    The name of the scope.

    The following scopes are possible:

    • Organization - Specifies that the recommendation preference applies at the organization level, for all member accounts of an organization.
    • AccountId - Specifies that the recommendation preference applies at the account level, for all resources of a given resource type in an account.
    • ResourceArn - Specifies that the recommendation preference applies at the individual resource level.
  • value (string) --

    The value of the scope.

    If you specified the name of the scope as:

    • Organization - The value must be ALL_ACCOUNTS .
    • AccountId - The value must be a 12-digit Amazon Web Services account ID.
    • ResourceArn - The value must be the Amazon Resource Name (ARN) of an EC2 instance or an Auto Scaling group.

    Only EC2 instance and Auto Scaling group ARNs are currently supported.

• enhancedInfrastructureMetrics (string) --

  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 .

• inferredWorkloadTypes (string) --

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

  Note

  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 .

• externalMetricsPreference (dict) --

  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 .

  • source (string) --

    Contains the source options for external metrics preferences.

Return type

dict

Returns

Response Syntax

{}

Response Structure

• (dict) --

Exceptions

• ComputeOptimizer.Client.exceptions.OptInRequiredException
• ComputeOptimizer.Client.exceptions.InternalServerException
• ComputeOptimizer.Client.exceptions.ServiceUnavailableException
• ComputeOptimizer.Client.exceptions.AccessDeniedException
• ComputeOptimizer.Client.exceptions.InvalidParameterValueException
• ComputeOptimizer.Client.exceptions.ResourceNotFoundException
• ComputeOptimizer.Client.exceptions.MissingAuthenticationToken
• ComputeOptimizer.Client.exceptions.ThrottlingException