Class: Aws::ComputeOptimizer::Types::LambdaFunctionRecommendation

Inherits:

Struct

• Object
• Struct
• Aws::ComputeOptimizer::Types::LambdaFunctionRecommendation

Includes:

Structure

Defined in:

lib/aws-sdk-computeoptimizer/types.rb

Overview

Describes an Lambda function recommendation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_id ⇒ String

  The Amazon Web Services account ID of the function.

• #current_memory_size ⇒ Integer

  The amount of memory, in MB, that’s allocated to the current function.

• #current_performance_risk ⇒ String

  The risk of the current Lambda function not meeting the performance needs of its workloads.

• #effective_recommendation_preferences ⇒ Types::LambdaEffectiveRecommendationPreferences

  Describes the effective recommendation preferences for Lambda functions.

• #finding ⇒ String

  The finding classification of the function.

• #finding_reason_codes ⇒ Array<String>

  The reason for the finding classification of the function.

• #function_arn ⇒ String

  The Amazon Resource Name (ARN) of the current function.

• #function_version ⇒ String

  The version number of the current function.

• #last_refresh_timestamp ⇒ Time

  The timestamp of when the function recommendation was last generated.

• #lookback_period_in_days ⇒ Float

  The number of days for which utilization metrics were analyzed for the function.

• #memory_size_recommendation_options ⇒ Array<Types::LambdaFunctionMemoryRecommendationOption>

  An array of objects that describe the memory configuration recommendation options for the function.

• #number_of_invocations ⇒ Integer

  The number of times your function code was applied during the look-back period.

• #tags ⇒ Array<Types::Tag>

  A list of tags assigned to your Lambda function recommendations.

• #utilization_metrics ⇒ Array<Types::LambdaFunctionUtilizationMetric>

  An array of objects that describe the utilization metrics of the function.

Instance Attribute Details

#account_id ⇒ String

The Amazon Web Services account ID of the function.

Returns:

• (String)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 4580

class LambdaFunctionRecommendation < Struct.new(
  :function_arn,
  :function_version,
  :account_id,
  :current_memory_size,
  :number_of_invocations,
  :utilization_metrics,
  :lookback_period_in_days,
  :last_refresh_timestamp,
  :finding,
  :finding_reason_codes,
  :memory_size_recommendation_options,
  :current_performance_risk,
  :effective_recommendation_preferences,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#current_memory_size ⇒ Integer

The amount of memory, in MB, that’s allocated to the current function.

Returns:

• (Integer)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 4580

class LambdaFunctionRecommendation < Struct.new(
  :function_arn,
  :function_version,
  :account_id,
  :current_memory_size,
  :number_of_invocations,
  :utilization_metrics,
  :lookback_period_in_days,
  :last_refresh_timestamp,
  :finding,
  :finding_reason_codes,
  :memory_size_recommendation_options,
  :current_performance_risk,
  :effective_recommendation_preferences,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#current_performance_risk ⇒ String

The risk of the current Lambda function not meeting the performance needs of its workloads. The higher the risk, the more likely the current Lambda function requires more memory.

Returns:

• (String)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 4580

class LambdaFunctionRecommendation < Struct.new(
  :function_arn,
  :function_version,
  :account_id,
  :current_memory_size,
  :number_of_invocations,
  :utilization_metrics,
  :lookback_period_in_days,
  :last_refresh_timestamp,
  :finding,
  :finding_reason_codes,
  :memory_size_recommendation_options,
  :current_performance_risk,
  :effective_recommendation_preferences,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#effective_recommendation_preferences ⇒ Types::LambdaEffectiveRecommendationPreferences

Describes the effective recommendation preferences for Lambda functions.

Returns:

• (Types::LambdaEffectiveRecommendationPreferences)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 4580

class LambdaFunctionRecommendation < Struct.new(
  :function_arn,
  :function_version,
  :account_id,
  :current_memory_size,
  :number_of_invocations,
  :utilization_metrics,
  :lookback_period_in_days,
  :last_refresh_timestamp,
  :finding,
  :finding_reason_codes,
  :memory_size_recommendation_options,
  :current_performance_risk,
  :effective_recommendation_preferences,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#finding ⇒ String

The finding classification of the function.

Findings for functions include:

• Optimized — The function is correctly provisioned to run your workload based on its current configuration and its utilization history. This finding classification does not include finding reason codes.

• NotOptimized — The function is performing at a higher level (over-provisioned) or at a lower level (under-provisioned) than required for your workload because its current configuration is not optimal. Over-provisioned resources might lead to unnecessary infrastructure cost, and under-provisioned resources might lead to poor application performance. This finding classification can include the ‘MemoryUnderprovisioned` and `MemoryUnderprovisioned` finding reason codes.

• Unavailable — Compute Optimizer was unable to generate a recommendation for the function. This could be because the function has not accumulated sufficient metric data, or the function does not qualify for a recommendation. This finding classification can include the ‘InsufficientData` and `Inconclusive` finding reason codes.

  <note markdown=“1”> Functions with a finding of unavailable are not returned unless you specify the ‘filter` parameter with a value of `Unavailable` in your `GetLambdaFunctionRecommendations` request.

  </note>
  

Returns:

• (String)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 4580

class LambdaFunctionRecommendation < Struct.new(
  :function_arn,
  :function_version,
  :account_id,
  :current_memory_size,
  :number_of_invocations,
  :utilization_metrics,
  :lookback_period_in_days,
  :last_refresh_timestamp,
  :finding,
  :finding_reason_codes,
  :memory_size_recommendation_options,
  :current_performance_risk,
  :effective_recommendation_preferences,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#finding_reason_codes ⇒ Array<String>

The reason for the finding classification of the function.

<note markdown=“1”> Functions that have a finding classification of ‘Optimized` don’t have a finding reason code.

</note>

Finding reason codes for functions include:

• MemoryOverprovisioned — The function is over-provisioned when its memory configuration can be sized down while still meeting the performance requirements of your workload. An over-provisioned function might lead to unnecessary infrastructure cost. This finding reason code is part of the ‘NotOptimized` finding classification.

• MemoryUnderprovisioned — The function is under-provisioned when its memory configuration doesn’t meet the performance requirements of the workload. An under-provisioned function might lead to poor application performance. This finding reason code is part of the ‘NotOptimized` finding classification.

• InsufficientData — The function does not have sufficient metric data for Compute Optimizer to generate a recommendation. For more information, see the [Supported resources and requirements] in the *Compute Optimizer User Guide*. This finding reason code is part of the ‘Unavailable` finding classification.

• Inconclusive — The function does not qualify for a recommendation because Compute Optimizer cannot generate a recommendation with a high degree of confidence. This finding reason code is part of the ‘Unavailable` finding classification.

[1]: docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html

Returns:

• (Array<String>)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 4580

class LambdaFunctionRecommendation < Struct.new(
  :function_arn,
  :function_version,
  :account_id,
  :current_memory_size,
  :number_of_invocations,
  :utilization_metrics,
  :lookback_period_in_days,
  :last_refresh_timestamp,
  :finding,
  :finding_reason_codes,
  :memory_size_recommendation_options,
  :current_performance_risk,
  :effective_recommendation_preferences,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#function_arn ⇒ String

The Amazon Resource Name (ARN) of the current function.

Returns:

• (String)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 4580

class LambdaFunctionRecommendation < Struct.new(
  :function_arn,
  :function_version,
  :account_id,
  :current_memory_size,
  :number_of_invocations,
  :utilization_metrics,
  :lookback_period_in_days,
  :last_refresh_timestamp,
  :finding,
  :finding_reason_codes,
  :memory_size_recommendation_options,
  :current_performance_risk,
  :effective_recommendation_preferences,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#function_version ⇒ String

The version number of the current function.

Returns:

• (String)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 4580

class LambdaFunctionRecommendation < Struct.new(
  :function_arn,
  :function_version,
  :account_id,
  :current_memory_size,
  :number_of_invocations,
  :utilization_metrics,
  :lookback_period_in_days,
  :last_refresh_timestamp,
  :finding,
  :finding_reason_codes,
  :memory_size_recommendation_options,
  :current_performance_risk,
  :effective_recommendation_preferences,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_refresh_timestamp ⇒ Time

The timestamp of when the function recommendation was last generated.

Returns:

• (Time)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 4580

class LambdaFunctionRecommendation < Struct.new(
  :function_arn,
  :function_version,
  :account_id,
  :current_memory_size,
  :number_of_invocations,
  :utilization_metrics,
  :lookback_period_in_days,
  :last_refresh_timestamp,
  :finding,
  :finding_reason_codes,
  :memory_size_recommendation_options,
  :current_performance_risk,
  :effective_recommendation_preferences,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#lookback_period_in_days ⇒ Float

The number of days for which utilization metrics were analyzed for the function.

Returns:

• (Float)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 4580

class LambdaFunctionRecommendation < Struct.new(
  :function_arn,
  :function_version,
  :account_id,
  :current_memory_size,
  :number_of_invocations,
  :utilization_metrics,
  :lookback_period_in_days,
  :last_refresh_timestamp,
  :finding,
  :finding_reason_codes,
  :memory_size_recommendation_options,
  :current_performance_risk,
  :effective_recommendation_preferences,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#memory_size_recommendation_options ⇒ Array<Types::LambdaFunctionMemoryRecommendationOption>

An array of objects that describe the memory configuration recommendation options for the function.

Returns:

• (Array<Types::LambdaFunctionMemoryRecommendationOption>)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 4580

class LambdaFunctionRecommendation < Struct.new(
  :function_arn,
  :function_version,
  :account_id,
  :current_memory_size,
  :number_of_invocations,
  :utilization_metrics,
  :lookback_period_in_days,
  :last_refresh_timestamp,
  :finding,
  :finding_reason_codes,
  :memory_size_recommendation_options,
  :current_performance_risk,
  :effective_recommendation_preferences,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#number_of_invocations ⇒ Integer

The number of times your function code was applied during the look-back period.

Returns:

• (Integer)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 4580

class LambdaFunctionRecommendation < Struct.new(
  :function_arn,
  :function_version,
  :account_id,
  :current_memory_size,
  :number_of_invocations,
  :utilization_metrics,
  :lookback_period_in_days,
  :last_refresh_timestamp,
  :finding,
  :finding_reason_codes,
  :memory_size_recommendation_options,
  :current_performance_risk,
  :effective_recommendation_preferences,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of tags assigned to your Lambda function recommendations.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 4580

class LambdaFunctionRecommendation < Struct.new(
  :function_arn,
  :function_version,
  :account_id,
  :current_memory_size,
  :number_of_invocations,
  :utilization_metrics,
  :lookback_period_in_days,
  :last_refresh_timestamp,
  :finding,
  :finding_reason_codes,
  :memory_size_recommendation_options,
  :current_performance_risk,
  :effective_recommendation_preferences,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#utilization_metrics ⇒ Array<Types::LambdaFunctionUtilizationMetric>

An array of objects that describe the utilization metrics of the function.

Returns:

• (Array<Types::LambdaFunctionUtilizationMetric>)

# File 'lib/aws-sdk-computeoptimizer/types.rb', line 4580

class LambdaFunctionRecommendation < Struct.new(
  :function_arn,
  :function_version,
  :account_id,
  :current_memory_size,
  :number_of_invocations,
  :utilization_metrics,
  :lookback_period_in_days,
  :last_refresh_timestamp,
  :finding,
  :finding_reason_codes,
  :memory_size_recommendation_options,
  :current_performance_risk,
  :effective_recommendation_preferences,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end