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.Types.LambdaFunctionRecommendation

Description

 
Synopsis

Documentation

data LambdaFunctionRecommendation Source #

Describes an Lambda function recommendation.

See: newLambdaFunctionRecommendation smart constructor.

Constructors

LambdaFunctionRecommendation' 

Fields

  • accountId :: Maybe Text

    The Amazon Web Services account ID of the function.

  • currentMemorySize :: Maybe Int

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

  • currentPerformanceRisk :: Maybe CurrentPerformanceRisk

    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.

  • finding :: Maybe LambdaFunctionRecommendationFinding

    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.

      Functions with a finding of unavailable are not returned unless you specify the filter parameter with a value of Unavailable in your GetLambdaFunctionRecommendations request.

  • findingReasonCodes :: Maybe [LambdaFunctionRecommendationFindingReasonCode]

    The reason for the finding classification of the function.

    Functions that have a finding classification of Optimized don't have a finding reason code.

    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.
  • functionArn :: Maybe Text

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

  • functionVersion :: Maybe Text

    The version number of the current function.

  • lastRefreshTimestamp :: Maybe POSIX

    The timestamp of when the function recommendation was last generated.

  • lookbackPeriodInDays :: Maybe Double

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

  • memorySizeRecommendationOptions :: Maybe [LambdaFunctionMemoryRecommendationOption]

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

  • numberOfInvocations :: Maybe Integer

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

  • utilizationMetrics :: Maybe [LambdaFunctionUtilizationMetric]

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

Instances

Instances details
FromJSON LambdaFunctionRecommendation Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.Types.LambdaFunctionRecommendation

Generic LambdaFunctionRecommendation Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.Types.LambdaFunctionRecommendation

Associated Types

type Rep LambdaFunctionRecommendation :: Type -> Type #

Read LambdaFunctionRecommendation Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.Types.LambdaFunctionRecommendation

Show LambdaFunctionRecommendation Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.Types.LambdaFunctionRecommendation

NFData LambdaFunctionRecommendation Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.Types.LambdaFunctionRecommendation

Eq LambdaFunctionRecommendation Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.Types.LambdaFunctionRecommendation

Hashable LambdaFunctionRecommendation Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.Types.LambdaFunctionRecommendation

type Rep LambdaFunctionRecommendation Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.Types.LambdaFunctionRecommendation

type Rep LambdaFunctionRecommendation = D1 ('MetaData "LambdaFunctionRecommendation" "Amazonka.ComputeOptimizer.Types.LambdaFunctionRecommendation" "amazonka-compute-optimizer-2.0-5JAMFRZoNrnJ0UCJqIgHbk" 'False) (C1 ('MetaCons "LambdaFunctionRecommendation'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "currentMemorySize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "currentPerformanceRisk") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CurrentPerformanceRisk)))) :*: (S1 ('MetaSel ('Just "finding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LambdaFunctionRecommendationFinding)) :*: (S1 ('MetaSel ('Just "findingReasonCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LambdaFunctionRecommendationFindingReasonCode])) :*: S1 ('MetaSel ('Just "functionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "functionVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "lastRefreshTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "lookbackPeriodInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :*: (S1 ('MetaSel ('Just "memorySizeRecommendationOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LambdaFunctionMemoryRecommendationOption])) :*: (S1 ('MetaSel ('Just "numberOfInvocations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "utilizationMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LambdaFunctionUtilizationMetric])))))))

newLambdaFunctionRecommendation :: LambdaFunctionRecommendation Source #

Create a value of LambdaFunctionRecommendation 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:accountId:LambdaFunctionRecommendation', lambdaFunctionRecommendation_accountId - The Amazon Web Services account ID of the function.

$sel:currentMemorySize:LambdaFunctionRecommendation', lambdaFunctionRecommendation_currentMemorySize - The amount of memory, in MB, that's allocated to the current function.

$sel:currentPerformanceRisk:LambdaFunctionRecommendation', lambdaFunctionRecommendation_currentPerformanceRisk - 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.

$sel:finding:LambdaFunctionRecommendation', lambdaFunctionRecommendation_finding - 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.

    Functions with a finding of unavailable are not returned unless you specify the filter parameter with a value of Unavailable in your GetLambdaFunctionRecommendations request.

$sel:findingReasonCodes:LambdaFunctionRecommendation', lambdaFunctionRecommendation_findingReasonCodes - The reason for the finding classification of the function.

Functions that have a finding classification of Optimized don't have a finding reason code.

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.

$sel:functionArn:LambdaFunctionRecommendation', lambdaFunctionRecommendation_functionArn - The Amazon Resource Name (ARN) of the current function.

$sel:functionVersion:LambdaFunctionRecommendation', lambdaFunctionRecommendation_functionVersion - The version number of the current function.

$sel:lastRefreshTimestamp:LambdaFunctionRecommendation', lambdaFunctionRecommendation_lastRefreshTimestamp - The timestamp of when the function recommendation was last generated.

$sel:lookbackPeriodInDays:LambdaFunctionRecommendation', lambdaFunctionRecommendation_lookbackPeriodInDays - The number of days for which utilization metrics were analyzed for the function.

$sel:memorySizeRecommendationOptions:LambdaFunctionRecommendation', lambdaFunctionRecommendation_memorySizeRecommendationOptions - An array of objects that describe the memory configuration recommendation options for the function.

$sel:numberOfInvocations:LambdaFunctionRecommendation', lambdaFunctionRecommendation_numberOfInvocations - The number of times your function code was applied during the look-back period.

$sel:utilizationMetrics:LambdaFunctionRecommendation', lambdaFunctionRecommendation_utilizationMetrics - An array of objects that describe the utilization metrics of the function.

lambdaFunctionRecommendation_accountId :: Lens' LambdaFunctionRecommendation (Maybe Text) Source #

The Amazon Web Services account ID of the function.

lambdaFunctionRecommendation_currentMemorySize :: Lens' LambdaFunctionRecommendation (Maybe Int) Source #

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

lambdaFunctionRecommendation_currentPerformanceRisk :: Lens' LambdaFunctionRecommendation (Maybe CurrentPerformanceRisk) Source #

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.

lambdaFunctionRecommendation_finding :: Lens' LambdaFunctionRecommendation (Maybe LambdaFunctionRecommendationFinding) Source #

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.

    Functions with a finding of unavailable are not returned unless you specify the filter parameter with a value of Unavailable in your GetLambdaFunctionRecommendations request.

lambdaFunctionRecommendation_findingReasonCodes :: Lens' LambdaFunctionRecommendation (Maybe [LambdaFunctionRecommendationFindingReasonCode]) Source #

The reason for the finding classification of the function.

Functions that have a finding classification of Optimized don't have a finding reason code.

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.

lambdaFunctionRecommendation_functionArn :: Lens' LambdaFunctionRecommendation (Maybe Text) Source #

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

lambdaFunctionRecommendation_lastRefreshTimestamp :: Lens' LambdaFunctionRecommendation (Maybe UTCTime) Source #

The timestamp of when the function recommendation was last generated.

lambdaFunctionRecommendation_lookbackPeriodInDays :: Lens' LambdaFunctionRecommendation (Maybe Double) Source #

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

lambdaFunctionRecommendation_memorySizeRecommendationOptions :: Lens' LambdaFunctionRecommendation (Maybe [LambdaFunctionMemoryRecommendationOption]) Source #

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

lambdaFunctionRecommendation_numberOfInvocations :: Lens' LambdaFunctionRecommendation (Maybe Integer) Source #

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

lambdaFunctionRecommendation_utilizationMetrics :: Lens' LambdaFunctionRecommendation (Maybe [LambdaFunctionUtilizationMetric]) Source #

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