import {Request} from '../lib/request'; import {Response} from '../lib/response'; import {AWSError} from '../lib/error'; import {Service} from '../lib/service'; import {ServiceConfigurationOptions} from '../lib/service'; import {ConfigBase as Config} from '../lib/config-base'; interface Blob {} declare class ComputeOptimizer extends Service { /** * Constructs a service object. This object has one method for each API operation. */ constructor(options?: ComputeOptimizer.Types.ClientConfiguration) config: Config & ComputeOptimizer.Types.ClientConfiguration; /** * Describes recommendation export jobs created in the last seven days. Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs. */ describeRecommendationExportJobs(params: ComputeOptimizer.Types.DescribeRecommendationExportJobsRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.DescribeRecommendationExportJobsResponse) => void): Request; /** * Describes recommendation export jobs created in the last seven days. Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs. */ describeRecommendationExportJobs(callback?: (err: AWSError, data: ComputeOptimizer.Types.DescribeRecommendationExportJobsResponse) => void): Request; /** * Exports optimization recommendations for Auto Scaling groups. Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Auto Scaling group export job in progress per AWS Region. */ exportAutoScalingGroupRecommendations(params: ComputeOptimizer.Types.ExportAutoScalingGroupRecommendationsRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.ExportAutoScalingGroupRecommendationsResponse) => void): Request; /** * Exports optimization recommendations for Auto Scaling groups. Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Auto Scaling group export job in progress per AWS Region. */ exportAutoScalingGroupRecommendations(callback?: (err: AWSError, data: ComputeOptimizer.Types.ExportAutoScalingGroupRecommendationsResponse) => void): Request; /** * Exports optimization recommendations for Amazon EC2 instances. Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Amazon EC2 instance export job in progress per AWS Region. */ exportEC2InstanceRecommendations(params: ComputeOptimizer.Types.ExportEC2InstanceRecommendationsRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.ExportEC2InstanceRecommendationsResponse) => void): Request; /** * Exports optimization recommendations for Amazon EC2 instances. Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide. You can have only one Amazon EC2 instance export job in progress per AWS Region. */ exportEC2InstanceRecommendations(callback?: (err: AWSError, data: ComputeOptimizer.Types.ExportEC2InstanceRecommendationsResponse) => void): Request; /** * Returns Auto Scaling group recommendations. AWS Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide. */ getAutoScalingGroupRecommendations(params: ComputeOptimizer.Types.GetAutoScalingGroupRecommendationsRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.GetAutoScalingGroupRecommendationsResponse) => void): Request; /** * Returns Auto Scaling group recommendations. AWS Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide. */ getAutoScalingGroupRecommendations(callback?: (err: AWSError, data: ComputeOptimizer.Types.GetAutoScalingGroupRecommendationsResponse) => void): Request; /** * Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations. AWS Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide. */ getEBSVolumeRecommendations(params: ComputeOptimizer.Types.GetEBSVolumeRecommendationsRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.GetEBSVolumeRecommendationsResponse) => void): Request; /** * Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations. AWS Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide. */ getEBSVolumeRecommendations(callback?: (err: AWSError, data: ComputeOptimizer.Types.GetEBSVolumeRecommendationsResponse) => void): Request; /** * Returns Amazon EC2 instance recommendations. AWS Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide. */ getEC2InstanceRecommendations(params: ComputeOptimizer.Types.GetEC2InstanceRecommendationsRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.GetEC2InstanceRecommendationsResponse) => void): Request; /** * Returns Amazon EC2 instance recommendations. AWS Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide. */ getEC2InstanceRecommendations(callback?: (err: AWSError, data: ComputeOptimizer.Types.GetEC2InstanceRecommendationsResponse) => void): Request; /** * Returns the projected utilization metrics of Amazon EC2 instance recommendations. The Cpu and Memory metrics are the only projected utilization metrics returned when you run this action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent. */ getEC2RecommendationProjectedMetrics(params: ComputeOptimizer.Types.GetEC2RecommendationProjectedMetricsRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.GetEC2RecommendationProjectedMetricsResponse) => void): Request; /** * Returns the projected utilization metrics of Amazon EC2 instance recommendations. The Cpu and Memory metrics are the only projected utilization metrics returned when you run this action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent. */ getEC2RecommendationProjectedMetrics(callback?: (err: AWSError, data: ComputeOptimizer.Types.GetEC2RecommendationProjectedMetricsResponse) => void): Request; /** * Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer service. If the account is the management account of an organization, this action also confirms the enrollment status of member accounts within the organization. */ getEnrollmentStatus(params: ComputeOptimizer.Types.GetEnrollmentStatusRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.GetEnrollmentStatusResponse) => void): Request; /** * Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer service. If the account is the management account of an organization, this action also confirms the enrollment status of member accounts within the organization. */ getEnrollmentStatus(callback?: (err: AWSError, data: ComputeOptimizer.Types.GetEnrollmentStatusResponse) => void): Request; /** * Returns AWS Lambda function recommendations. AWS Compute Optimizer generates recommendations for functions that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide. */ getLambdaFunctionRecommendations(params: ComputeOptimizer.Types.GetLambdaFunctionRecommendationsRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.GetLambdaFunctionRecommendationsResponse) => void): Request; /** * Returns AWS Lambda function recommendations. AWS Compute Optimizer generates recommendations for functions that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide. */ getLambdaFunctionRecommendations(callback?: (err: AWSError, data: ComputeOptimizer.Types.GetLambdaFunctionRecommendationsResponse) => void): Request; /** * Returns the optimization findings for an account. It returns the number of: Amazon EC2 instances in an account that are Underprovisioned, Overprovisioned, or Optimized. Auto Scaling groups in an account that are NotOptimized, or Optimized. Amazon EBS volumes in an account that are NotOptimized, or Optimized. Lambda functions in an account that are NotOptimized, or Optimized. */ getRecommendationSummaries(params: ComputeOptimizer.Types.GetRecommendationSummariesRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.GetRecommendationSummariesResponse) => void): Request; /** * Returns the optimization findings for an account. It returns the number of: Amazon EC2 instances in an account that are Underprovisioned, Overprovisioned, or Optimized. Auto Scaling groups in an account that are NotOptimized, or Optimized. Amazon EBS volumes in an account that are NotOptimized, or Optimized. Lambda functions in an account that are NotOptimized, or Optimized. */ getRecommendationSummaries(callback?: (err: AWSError, data: ComputeOptimizer.Types.GetRecommendationSummariesResponse) => void): Request; /** * Updates the enrollment (opt in and opt out) status of an account to the AWS Compute Optimizer service. If the account is a management account of an organization, this action can also be used to enroll member accounts within the organization. You must have the appropriate permissions to opt in to Compute Optimizer, to view its recommendations, and to opt out. For more information, see Controlling access with AWS Identity and Access Management in the Compute Optimizer User Guide. When you opt in, Compute Optimizer automatically creates a Service-Linked Role in your account to access its data. For more information, see Using Service-Linked Roles for AWS Compute Optimizer in the Compute Optimizer User Guide. */ updateEnrollmentStatus(params: ComputeOptimizer.Types.UpdateEnrollmentStatusRequest, callback?: (err: AWSError, data: ComputeOptimizer.Types.UpdateEnrollmentStatusResponse) => void): Request; /** * Updates the enrollment (opt in and opt out) status of an account to the AWS Compute Optimizer service. If the account is a management account of an organization, this action can also be used to enroll member accounts within the organization. You must have the appropriate permissions to opt in to Compute Optimizer, to view its recommendations, and to opt out. For more information, see Controlling access with AWS Identity and Access Management in the Compute Optimizer User Guide. When you opt in, Compute Optimizer automatically creates a Service-Linked Role in your account to access its data. For more information, see Using Service-Linked Roles for AWS Compute Optimizer in the Compute Optimizer User Guide. */ updateEnrollmentStatus(callback?: (err: AWSError, data: ComputeOptimizer.Types.UpdateEnrollmentStatusResponse) => void): Request; } declare namespace ComputeOptimizer { export type AccountId = string; export type AccountIds = AccountId[]; export type AutoScalingGroupArn = string; export type AutoScalingGroupArns = AutoScalingGroupArn[]; export interface AutoScalingGroupConfiguration { /** * The desired capacity, or number of instances, for the Auto Scaling group. */ desiredCapacity?: DesiredCapacity; /** * The minimum size, or minimum number of instances, for the Auto Scaling group. */ minSize?: MinSize; /** * The maximum size, or maximum number of instances, for the Auto Scaling group. */ maxSize?: MaxSize; /** * The instance type for the Auto Scaling group. */ instanceType?: InstanceType; } export type AutoScalingGroupName = string; export interface AutoScalingGroupRecommendation { /** * The AWS account ID of the Auto Scaling group. */ accountId?: AccountId; /** * The Amazon Resource Name (ARN) of the Auto Scaling group. */ autoScalingGroupArn?: AutoScalingGroupArn; /** * The name of the Auto Scaling group. */ autoScalingGroupName?: AutoScalingGroupName; /** * The finding classification for the Auto Scaling group. Findings for Auto Scaling groups include: NotOptimized —An Auto Scaling group is considered not optimized when AWS Compute Optimizer identifies a recommendation that can provide better performance for your workload. Optimized —An Auto Scaling group is considered optimized when Compute Optimizer determines that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized resources, Compute Optimizer might recommend a new generation instance type. */ finding?: Finding; /** * An array of objects that describe the utilization metrics of the Auto Scaling group. */ utilizationMetrics?: UtilizationMetrics; /** * The number of days for which utilization metrics were analyzed for the Auto Scaling group. */ lookBackPeriodInDays?: LookBackPeriodInDays; /** * An array of objects that describe the current configuration of the Auto Scaling group. */ currentConfiguration?: AutoScalingGroupConfiguration; /** * An array of objects that describe the recommendation options for the Auto Scaling group. */ recommendationOptions?: AutoScalingGroupRecommendationOptions; /** * The time stamp of when the Auto Scaling group recommendation was last refreshed. */ lastRefreshTimestamp?: LastRefreshTimestamp; } export interface AutoScalingGroupRecommendationOption { /** * An array of objects that describe an Auto Scaling group configuration. */ configuration?: AutoScalingGroupConfiguration; /** * An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option. The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent. */ projectedUtilizationMetrics?: ProjectedUtilizationMetrics; /** * The performance risk of the Auto Scaling group configuration recommendation. Performance risk is the likelihood of the recommended instance type not meeting the performance requirement of your workload. The lowest performance risk is categorized as 0, and the highest as 5. */ performanceRisk?: PerformanceRisk; /** * The rank of the Auto Scaling group recommendation option. The top recommendation option is ranked as 1. */ rank?: Rank; } export type AutoScalingGroupRecommendationOptions = AutoScalingGroupRecommendationOption[]; export type AutoScalingGroupRecommendations = AutoScalingGroupRecommendation[]; export type Code = string; export type CreationTimestamp = Date; export type CurrentInstanceType = string; export interface DescribeRecommendationExportJobsRequest { /** * The identification numbers of the export jobs to return. An export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions. All export jobs created in the last seven days are returned if this parameter is omitted. */ jobIds?: JobIds; /** * An array of objects that describe a filter to return a more specific list of export jobs. */ filters?: JobFilters; /** * The token to advance to the next page of export jobs. */ nextToken?: NextToken; /** * The maximum number of export jobs to return with a single request. To retrieve the remaining results, make another request with the returned NextToken value. */ maxResults?: MaxResults; } export interface DescribeRecommendationExportJobsResponse { /** * An array of objects that describe recommendation export jobs. */ recommendationExportJobs?: RecommendationExportJobs; /** * The token to use to advance to the next page of export jobs. This value is null when there are no more pages of export jobs to return. */ nextToken?: NextToken; } export type DesiredCapacity = number; export type DestinationBucket = string; export type DestinationKey = string; export type DestinationKeyPrefix = string; export interface EBSFilter { /** * The name of the filter. Specify Finding to return recommendations with a specific finding classification (e.g., Optimized). */ name?: EBSFilterName; /** * The value of the filter. The valid values are Optimized, or NotOptimized. */ values?: FilterValues; } export type EBSFilterName = "Finding"|string; export type EBSFilters = EBSFilter[]; export type EBSFinding = "Optimized"|"NotOptimized"|string; export type EBSMetricName = "VolumeReadOpsPerSecond"|"VolumeWriteOpsPerSecond"|"VolumeReadBytesPerSecond"|"VolumeWriteBytesPerSecond"|string; export interface EBSUtilizationMetric { /** * The name of the utilization metric. The following utilization metrics are available: VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time. Unit: Count VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time. Unit: Count VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time. Unit: Bytes VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time. Unit: Bytes */ name?: EBSMetricName; /** * The statistic of the utilization metric. The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period. The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the AWS Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide. */ statistic?: MetricStatistic; /** * The value of the utilization metric. */ value?: MetricValue; } export type EBSUtilizationMetrics = EBSUtilizationMetric[]; export interface ExportAutoScalingGroupRecommendationsRequest { /** * The IDs of the AWS accounts for which to export Auto Scaling group recommendations. If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations. This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive. Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted. You can specify multiple account IDs per request. */ accountIds?: AccountIds; /** * An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations. */ filters?: Filters; /** * The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide. */ fieldsToExport?: ExportableAutoScalingGroupFields; /** * An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job. You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user guide. */ s3DestinationConfig: S3DestinationConfig; /** * The format of the export file. The only export file format currently supported is Csv. */ fileFormat?: FileFormat; /** * Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization. The member accounts must also be opted in to Compute Optimizer. Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted. This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive. Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted. */ includeMemberAccounts?: IncludeMemberAccounts; } export interface ExportAutoScalingGroupRecommendationsResponse { /** * The identification number of the export job. Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job. */ jobId?: JobId; /** * An object that describes the destination Amazon S3 bucket of a recommendations export file. */ s3Destination?: S3Destination; } export interface ExportDestination { /** * An object that describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata file. */ s3?: S3Destination; } export interface ExportEC2InstanceRecommendationsRequest { /** * The IDs of the AWS accounts for which to export instance recommendations. If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations. This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive. Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted. You can specify multiple account IDs per request. */ accountIds?: AccountIds; /** * An array of objects that describe a filter to export a more specific set of instance recommendations. */ filters?: Filters; /** * The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide. */ fieldsToExport?: ExportableInstanceFields; /** * An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job. You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user guide. */ s3DestinationConfig: S3DestinationConfig; /** * The format of the export file. The only export file format currently supported is Csv. */ fileFormat?: FileFormat; /** * Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization. The member accounts must also be opted in to Compute Optimizer. Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted. Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted. */ includeMemberAccounts?: IncludeMemberAccounts; } export interface ExportEC2InstanceRecommendationsResponse { /** * The identification number of the export job. Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job. */ jobId?: JobId; /** * An object that describes the destination Amazon S3 bucket of a recommendations export file. */ s3Destination?: S3Destination; } export type ExportableAutoScalingGroupField = "AccountId"|"AutoScalingGroupArn"|"AutoScalingGroupName"|"Finding"|"UtilizationMetricsCpuMaximum"|"UtilizationMetricsMemoryMaximum"|"UtilizationMetricsEbsReadOpsPerSecondMaximum"|"UtilizationMetricsEbsWriteOpsPerSecondMaximum"|"UtilizationMetricsEbsReadBytesPerSecondMaximum"|"UtilizationMetricsEbsWriteBytesPerSecondMaximum"|"LookbackPeriodInDays"|"CurrentConfigurationInstanceType"|"CurrentConfigurationDesiredCapacity"|"CurrentConfigurationMinSize"|"CurrentConfigurationMaxSize"|"CurrentOnDemandPrice"|"CurrentStandardOneYearNoUpfrontReservedPrice"|"CurrentStandardThreeYearNoUpfrontReservedPrice"|"CurrentVCpus"|"CurrentMemory"|"CurrentStorage"|"CurrentNetwork"|"RecommendationOptionsConfigurationInstanceType"|"RecommendationOptionsConfigurationDesiredCapacity"|"RecommendationOptionsConfigurationMinSize"|"RecommendationOptionsConfigurationMaxSize"|"RecommendationOptionsProjectedUtilizationMetricsCpuMaximum"|"RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum"|"RecommendationOptionsPerformanceRisk"|"RecommendationOptionsOnDemandPrice"|"RecommendationOptionsStandardOneYearNoUpfrontReservedPrice"|"RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice"|"RecommendationOptionsVcpus"|"RecommendationOptionsMemory"|"RecommendationOptionsStorage"|"RecommendationOptionsNetwork"|"LastRefreshTimestamp"|string; export type ExportableAutoScalingGroupFields = ExportableAutoScalingGroupField[]; export type ExportableInstanceField = "AccountId"|"InstanceArn"|"InstanceName"|"Finding"|"LookbackPeriodInDays"|"CurrentInstanceType"|"UtilizationMetricsCpuMaximum"|"UtilizationMetricsMemoryMaximum"|"UtilizationMetricsEbsReadOpsPerSecondMaximum"|"UtilizationMetricsEbsWriteOpsPerSecondMaximum"|"UtilizationMetricsEbsReadBytesPerSecondMaximum"|"UtilizationMetricsEbsWriteBytesPerSecondMaximum"|"CurrentOnDemandPrice"|"CurrentStandardOneYearNoUpfrontReservedPrice"|"CurrentStandardThreeYearNoUpfrontReservedPrice"|"CurrentVCpus"|"CurrentMemory"|"CurrentStorage"|"CurrentNetwork"|"RecommendationOptionsInstanceType"|"RecommendationOptionsProjectedUtilizationMetricsCpuMaximum"|"RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum"|"RecommendationOptionsPerformanceRisk"|"RecommendationOptionsVcpus"|"RecommendationOptionsMemory"|"RecommendationOptionsStorage"|"RecommendationOptionsNetwork"|"RecommendationOptionsOnDemandPrice"|"RecommendationOptionsStandardOneYearNoUpfrontReservedPrice"|"RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice"|"RecommendationsSourcesRecommendationSourceArn"|"RecommendationsSourcesRecommendationSourceType"|"LastRefreshTimestamp"|string; export type ExportableInstanceFields = ExportableInstanceField[]; export type FailureReason = string; export type FileFormat = "Csv"|string; export interface Filter { /** * The name of the filter. Specify Finding to return recommendations with a specific finding classification (e.g., Overprovisioned). Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., AutoScalingGroup). */ name?: FilterName; /** * The value of the filter. The valid values for this parameter are as follows, depending on what you specify for the name parameter and the resource type that you wish to filter results for: Specify Optimized or NotOptimized if you specified the name parameter as Finding and you want to filter results for Auto Scaling groups. Specify Underprovisioned, Overprovisioned, or Optimized if you specified the name parameter as Finding and you want to filter results for EC2 instances. Specify Ec2Instance or AutoScalingGroup if you specified the name parameter as RecommendationSourceType. */ values?: FilterValues; } export type FilterName = "Finding"|"RecommendationSourceType"|string; export type FilterValue = string; export type FilterValues = FilterValue[]; export type Filters = Filter[]; export type Finding = "Underprovisioned"|"Overprovisioned"|"Optimized"|"NotOptimized"|string; export type FindingReasonCode = "MemoryOverprovisioned"|"MemoryUnderprovisioned"|string; export type FunctionArn = string; export type FunctionArns = FunctionArn[]; export type FunctionVersion = string; export interface GetAutoScalingGroupRecommendationsRequest { /** * The ID of the AWS account for which to return Auto Scaling group recommendations. If your account is the management account of an organization, use this parameter to specify the member account for which you want to return Auto Scaling group recommendations. Only one account ID can be specified per request. */ accountIds?: AccountIds; /** * The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations. */ autoScalingGroupArns?: AutoScalingGroupArns; /** * The token to advance to the next page of Auto Scaling group recommendations. */ nextToken?: NextToken; /** * The maximum number of Auto Scaling group recommendations to return with a single request. To retrieve the remaining results, make another request with the returned NextToken value. */ maxResults?: MaxResults; /** * An array of objects that describe a filter that returns a more specific list of Auto Scaling group recommendations. */ filters?: Filters; } export interface GetAutoScalingGroupRecommendationsResponse { /** * The token to use to advance to the next page of Auto Scaling group recommendations. This value is null when there are no more pages of Auto Scaling group recommendations to return. */ nextToken?: NextToken; /** * An array of objects that describe Auto Scaling group recommendations. */ autoScalingGroupRecommendations?: AutoScalingGroupRecommendations; /** * An array of objects that describe errors of the request. For example, an error is returned if you request recommendations for an unsupported Auto Scaling group. */ errors?: GetRecommendationErrors; } export interface GetEBSVolumeRecommendationsRequest { /** * The Amazon Resource Name (ARN) of the volumes for which to return recommendations. */ volumeArns?: VolumeArns; /** * The token to advance to the next page of volume recommendations. */ nextToken?: NextToken; /** * The maximum number of volume recommendations to return with a single request. To retrieve the remaining results, make another request with the returned NextToken value. */ maxResults?: MaxResults; /** * An array of objects that describe a filter that returns a more specific list of volume recommendations. */ filters?: EBSFilters; /** * The ID of the AWS account for which to return volume recommendations. If your account is the management account of an organization, use this parameter to specify the member account for which you want to return volume recommendations. Only one account ID can be specified per request. */ accountIds?: AccountIds; } export interface GetEBSVolumeRecommendationsResponse { /** * The token to use to advance to the next page of volume recommendations. This value is null when there are no more pages of volume recommendations to return. */ nextToken?: NextToken; /** * An array of objects that describe volume recommendations. */ volumeRecommendations?: VolumeRecommendations; /** * An array of objects that describe errors of the request. For example, an error is returned if you request recommendations for an unsupported volume. */ errors?: GetRecommendationErrors; } export interface GetEC2InstanceRecommendationsRequest { /** * The Amazon Resource Name (ARN) of the instances for which to return recommendations. */ instanceArns?: InstanceArns; /** * The token to advance to the next page of instance recommendations. */ nextToken?: NextToken; /** * The maximum number of instance recommendations to return with a single request. To retrieve the remaining results, make another request with the returned NextToken value. */ maxResults?: MaxResults; /** * An array of objects that describe a filter that returns a more specific list of instance recommendations. */ filters?: Filters; /** * The ID of the AWS account for which to return instance recommendations. If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations. Only one account ID can be specified per request. */ accountIds?: AccountIds; } export interface GetEC2InstanceRecommendationsResponse { /** * The token to use to advance to the next page of instance recommendations. This value is null when there are no more pages of instance recommendations to return. */ nextToken?: NextToken; /** * An array of objects that describe instance recommendations. */ instanceRecommendations?: InstanceRecommendations; /** * An array of objects that describe errors of the request. For example, an error is returned if you request recommendations for an instance of an unsupported instance family. */ errors?: GetRecommendationErrors; } export interface GetEC2RecommendationProjectedMetricsRequest { /** * The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics. */ instanceArn: InstanceArn; /** * The statistic of the projected metrics. */ stat: MetricStatistic; /** * The granularity, in seconds, of the projected metrics data points. */ period: Period; /** * The time stamp of the first projected metrics data point to return. */ startTime: Timestamp; /** * The time stamp of the last projected metrics data point to return. */ endTime: Timestamp; } export interface GetEC2RecommendationProjectedMetricsResponse { /** * An array of objects that describe a projected metrics. */ recommendedOptionProjectedMetrics?: RecommendedOptionProjectedMetrics; } export interface GetEnrollmentStatusRequest { } export interface GetEnrollmentStatusResponse { /** * The enrollment status of the account. */ status?: Status; /** * The reason for the enrollment status of the account. For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service. */ statusReason?: StatusReason; /** * Confirms the enrollment status of member accounts within the organization, if the account is a management account of an organization. */ memberAccountsEnrolled?: MemberAccountsEnrolled; } export interface GetLambdaFunctionRecommendationsRequest { /** * The Amazon Resource Name (ARN) of the functions for which to return recommendations. You can specify a qualified or unqualified ARN. If you specify an unqualified ARN without a function version suffix, Compute Optimizer will return recommendations for the latest ($LATEST) version of the function. If you specify a qualified ARN with a version suffix, Compute Optimizer will return recommendations for the specified function version. For more information about using function versions, see Using versions in the AWS Lambda Developer Guide. */ functionArns?: FunctionArns; /** * The ID of the AWS account for which to return function recommendations. If your account is the management account of an organization, use this parameter to specify the member account for which you want to return function recommendations. Only one account ID can be specified per request. */ accountIds?: AccountIds; /** * An array of objects that describe a filter that returns a more specific list of function recommendations. */ filters?: LambdaFunctionRecommendationFilters; /** * The token to advance to the next page of function recommendations. */ nextToken?: NextToken; /** * The maximum number of function recommendations to return with a single request. To retrieve the remaining results, make another request with the returned NextToken value. */ maxResults?: MaxResults; } export interface GetLambdaFunctionRecommendationsResponse { /** * The token to use to advance to the next page of function recommendations. This value is null when there are no more pages of function recommendations to return. */ nextToken?: NextToken; /** * An array of objects that describe function recommendations. */ lambdaFunctionRecommendations?: LambdaFunctionRecommendations; } export interface GetRecommendationError { /** * The ID of the error. */ identifier?: Identifier; /** * The error code. */ code?: Code; /** * The message, or reason, for the error. */ message?: Message; } export type GetRecommendationErrors = GetRecommendationError[]; export interface GetRecommendationSummariesRequest { /** * The ID of the AWS account for which to return recommendation summaries. If your account is the management account of an organization, use this parameter to specify the member account for which you want to return recommendation summaries. Only one account ID can be specified per request. */ accountIds?: AccountIds; /** * The token to advance to the next page of recommendation summaries. */ nextToken?: NextToken; /** * The maximum number of recommendation summaries to return with a single request. To retrieve the remaining results, make another request with the returned NextToken value. */ maxResults?: MaxResults; } export interface GetRecommendationSummariesResponse { /** * The token to use to advance to the next page of recommendation summaries. This value is null when there are no more pages of recommendation summaries to return. */ nextToken?: NextToken; /** * An array of objects that summarize a recommendation. */ recommendationSummaries?: RecommendationSummaries; } export type Identifier = string; export type IncludeMemberAccounts = boolean; export type InstanceArn = string; export type InstanceArns = InstanceArn[]; export type InstanceName = string; export interface InstanceRecommendation { /** * The Amazon Resource Name (ARN) of the current instance. */ instanceArn?: InstanceArn; /** * The AWS account ID of the instance. */ accountId?: AccountId; /** * The name of the current instance. */ instanceName?: InstanceName; /** * The instance type of the current instance. */ currentInstanceType?: CurrentInstanceType; /** * The finding classification for the instance. Findings for instances include: Underprovisioned —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance. Overprovisioned —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost. Optimized —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. An optimized instance runs your workloads with optimal performance and infrastructure cost. For optimized resources, AWS Compute Optimizer might recommend a new generation instance type. */ finding?: Finding; /** * An array of objects that describe the utilization metrics of the instance. */ utilizationMetrics?: UtilizationMetrics; /** * The number of days for which utilization metrics were analyzed for the instance. */ lookBackPeriodInDays?: LookBackPeriodInDays; /** * An array of objects that describe the recommendation options for the instance. */ recommendationOptions?: RecommendationOptions; /** * An array of objects that describe the source resource of the recommendation. */ recommendationSources?: RecommendationSources; /** * The time stamp of when the instance recommendation was last refreshed. */ lastRefreshTimestamp?: LastRefreshTimestamp; } export interface InstanceRecommendationOption { /** * The instance type of the instance recommendation. */ instanceType?: InstanceType; /** * An array of objects that describe the projected utilization metrics of the instance recommendation option. The Cpu and Memory metrics are the only projected utilization metrics returned. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent. */ projectedUtilizationMetrics?: ProjectedUtilizationMetrics; /** * The performance risk of the instance recommendation option. Performance risk is the likelihood of the recommended instance type not meeting the performance requirement of your workload. The lowest performance risk is categorized as 0, and the highest as 5. */ performanceRisk?: PerformanceRisk; /** * The rank of the instance recommendation option. The top recommendation option is ranked as 1. */ rank?: Rank; } export type InstanceRecommendations = InstanceRecommendation[]; export type InstanceType = string; export interface JobFilter { /** * The name of the filter. Specify ResourceType to return export jobs of a specific resource type (e.g., Ec2Instance). Specify JobStatus to return export jobs with a specific status (e.g, Complete). */ name?: JobFilterName; /** * The value of the filter. The valid values for this parameter are as follows, depending on what you specify for the name parameter: Specify Ec2Instance or AutoScalingGroup if you specified the name parameter as ResourceType. There is no filter for EBS volumes because volume recommendations cannot be exported at this time. Specify Queued, InProgress, Complete, or Failed if you specified the name parameter as JobStatus. */ values?: FilterValues; } export type JobFilterName = "ResourceType"|"JobStatus"|string; export type JobFilters = JobFilter[]; export type JobId = string; export type JobIds = JobId[]; export type JobStatus = "Queued"|"InProgress"|"Complete"|"Failed"|string; export type LambdaFunctionMemoryMetricName = "Duration"|string; export type LambdaFunctionMemoryMetricStatistic = "LowerBound"|"UpperBound"|"Expected"|string; export interface LambdaFunctionMemoryProjectedMetric { /** * The name of the projected utilization metric. */ name?: LambdaFunctionMemoryMetricName; /** * The statistic of the projected utilization metric. */ statistic?: LambdaFunctionMemoryMetricStatistic; /** * The values of the projected utilization metrics. */ value?: MetricValue; } export type LambdaFunctionMemoryProjectedMetrics = LambdaFunctionMemoryProjectedMetric[]; export interface LambdaFunctionMemoryRecommendationOption { /** * The rank of the function recommendation option. The top recommendation option is ranked as 1. */ rank?: Rank; /** * The memory size, in MB, of the function recommendation option. */ memorySize?: MemorySize; /** * An array of objects that describe the projected utilization metrics of the function recommendation option. */ projectedUtilizationMetrics?: LambdaFunctionMemoryProjectedMetrics; } export type LambdaFunctionMemoryRecommendationOptions = LambdaFunctionMemoryRecommendationOption[]; export type LambdaFunctionMetricName = "Duration"|"Memory"|string; export type LambdaFunctionMetricStatistic = "Maximum"|"Average"|string; export interface LambdaFunctionRecommendation { /** * The Amazon Resource Name (ARN) of the current function. */ functionArn?: FunctionArn; /** * The version number of the current function. */ functionVersion?: FunctionVersion; /** * The AWS account ID of the function. */ accountId?: AccountId; /** * The amount of memory, in MB, that's allocated to the current function. */ currentMemorySize?: MemorySize; /** * The number of times your function code was executed during the look-back period. */ numberOfInvocations?: NumberOfInvocations; /** * An array of objects that describe the utilization metrics of the function. */ utilizationMetrics?: LambdaFunctionUtilizationMetrics; /** * The number of days for which utilization metrics were analyzed for the function. */ lookbackPeriodInDays?: LookBackPeriodInDays; /** * The time stamp of when the function recommendation was last refreshed. */ lastRefreshTimestamp?: LastRefreshTimestamp; /** * The finding classification for 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. */ finding?: LambdaFunctionRecommendationFinding; /** * The reason for the finding classification of the function. Functions that have a finding classification of Optimized don't have a finding reason code. Reason codes 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 AWS 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. */ findingReasonCodes?: LambdaFunctionRecommendationFindingReasonCodes; /** * An array of objects that describe the memory configuration recommendation options for the function. */ memorySizeRecommendationOptions?: LambdaFunctionMemoryRecommendationOptions; } export interface LambdaFunctionRecommendationFilter { /** * The name of the filter. Specify Finding to return recommendations with a specific finding classification (e.g., NotOptimized). Specify FindingReasonCode to return recommendations with a specific finding reason code (e.g., MemoryUnderprovisioned). */ name?: LambdaFunctionRecommendationFilterName; /** * The value of the filter. The valid values for this parameter are as follows, depending on what you specify for the name parameter: Specify Optimized, NotOptimized, or Unavailable if you specified the name parameter as Finding. Specify MemoryOverprovisioned, MemoryUnderprovisioned, InsufficientData, or Inconclusive if you specified the name parameter as FindingReasonCode. */ values?: FilterValues; } export type LambdaFunctionRecommendationFilterName = "Finding"|"FindingReasonCode"|string; export type LambdaFunctionRecommendationFilters = LambdaFunctionRecommendationFilter[]; export type LambdaFunctionRecommendationFinding = "Optimized"|"NotOptimized"|"Unavailable"|string; export type LambdaFunctionRecommendationFindingReasonCode = "MemoryOverprovisioned"|"MemoryUnderprovisioned"|"InsufficientData"|"Inconclusive"|string; export type LambdaFunctionRecommendationFindingReasonCodes = LambdaFunctionRecommendationFindingReasonCode[]; export type LambdaFunctionRecommendations = LambdaFunctionRecommendation[]; export interface LambdaFunctionUtilizationMetric { /** * The name of the utilization metric. The following utilization metrics are available: Duration - The amount of time that your function code spends processing an event. Memory - The amount of memory used per invocation. */ name?: LambdaFunctionMetricName; /** * The statistic of the utilization metric. The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period. The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the AWS Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide. */ statistic?: LambdaFunctionMetricStatistic; /** * The value of the utilization metric. */ value?: MetricValue; } export type LambdaFunctionUtilizationMetrics = LambdaFunctionUtilizationMetric[]; export type LastRefreshTimestamp = Date; export type LastUpdatedTimestamp = Date; export type LookBackPeriodInDays = number; export type MaxResults = number; export type MaxSize = number; export type MemberAccountsEnrolled = boolean; export type MemorySize = number; export type Message = string; export type MetadataKey = string; export type MetricName = "Cpu"|"Memory"|"EBS_READ_OPS_PER_SECOND"|"EBS_WRITE_OPS_PER_SECOND"|"EBS_READ_BYTES_PER_SECOND"|"EBS_WRITE_BYTES_PER_SECOND"|string; export type MetricStatistic = "Maximum"|"Average"|string; export type MetricValue = number; export type MetricValues = MetricValue[]; export type MinSize = number; export type NextToken = string; export type NumberOfInvocations = number; export type PerformanceRisk = number; export type Period = number; export interface ProjectedMetric { /** * The name of the projected utilization metric. The following projected utilization metrics are returned: Cpu - The projected percentage of allocated EC2 compute units that would be in use on the recommendation option had you used that resource during the analyzed period. This metric identifies the processing power required to run an application on the recommendation option. Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core. Units: Percent Memory - The percentage of memory that would be in use on the recommendation option had you used that resource during the analyzed period. This metric identifies the amount of memory required to run an application on the recommendation option. Units: Percent The Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent. */ name?: MetricName; /** * The time stamps of the projected utilization metric. */ timestamps?: Timestamps; /** * The values of the projected utilization metrics. */ values?: MetricValues; } export type ProjectedMetrics = ProjectedMetric[]; export type ProjectedUtilizationMetrics = UtilizationMetric[]; export type Rank = number; export type ReasonCodeSummaries = ReasonCodeSummary[]; export interface ReasonCodeSummary { /** * The name of the finding reason code. */ name?: FindingReasonCode; /** * The value of the finding reason code summary. */ value?: SummaryValue; } export interface RecommendationExportJob { /** * The identification number of the export job. */ jobId?: JobId; /** * An object that describes the destination of the export file. */ destination?: ExportDestination; /** * The resource type of the exported recommendations. */ resourceType?: ResourceType; /** * The status of the export job. */ status?: JobStatus; /** * The timestamp of when the export job was created. */ creationTimestamp?: CreationTimestamp; /** * The timestamp of when the export job was last updated. */ lastUpdatedTimestamp?: LastUpdatedTimestamp; /** * The reason for an export job failure. */ failureReason?: FailureReason; } export type RecommendationExportJobs = RecommendationExportJob[]; export type RecommendationOptions = InstanceRecommendationOption[]; export interface RecommendationSource { /** * The Amazon Resource Name (ARN) of the recommendation source. */ recommendationSourceArn?: RecommendationSourceArn; /** * The resource type of the recommendation source. */ recommendationSourceType?: RecommendationSourceType; } export type RecommendationSourceArn = string; export type RecommendationSourceType = "Ec2Instance"|"AutoScalingGroup"|"EbsVolume"|"LambdaFunction"|string; export type RecommendationSources = RecommendationSource[]; export type RecommendationSummaries = RecommendationSummary[]; export interface RecommendationSummary { /** * An array of objects that describe a recommendation summary. */ summaries?: Summaries; /** * The resource type of the recommendation. */ recommendationResourceType?: RecommendationSourceType; /** * The AWS account ID of the recommendation summary. */ accountId?: AccountId; } export type RecommendedInstanceType = string; export interface RecommendedOptionProjectedMetric { /** * The recommended instance type. */ recommendedInstanceType?: RecommendedInstanceType; /** * The rank of the recommendation option projected metric. The top recommendation option is ranked as 1. The projected metric rank correlates to the recommendation option rank. For example, the projected metric ranked as 1 is related to the recommendation option that is also ranked as 1 in the same response. */ rank?: Rank; /** * An array of objects that describe a projected utilization metric. */ projectedMetrics?: ProjectedMetrics; } export type RecommendedOptionProjectedMetrics = RecommendedOptionProjectedMetric[]; export type ResourceType = "Ec2Instance"|"AutoScalingGroup"|string; export interface S3Destination { /** * The name of the Amazon S3 bucket used as the destination of an export file. */ bucket?: DestinationBucket; /** * The Amazon S3 bucket key of an export file. The key uniquely identifies the object, or export file, in the S3 bucket. */ key?: DestinationKey; /** * The Amazon S3 bucket key of a metadata file. The key uniquely identifies the object, or metadata file, in the S3 bucket. */ metadataKey?: MetadataKey; } export interface S3DestinationConfig { /** * The name of the Amazon S3 bucket to use as the destination for an export job. */ bucket?: DestinationBucket; /** * The Amazon S3 bucket prefix for an export job. */ keyPrefix?: DestinationKeyPrefix; } export type Status = "Active"|"Inactive"|"Pending"|"Failed"|string; export type StatusReason = string; export type Summaries = Summary[]; export interface Summary { /** * The finding classification of the recommendation. */ name?: Finding; /** * The value of the recommendation summary. */ value?: SummaryValue; /** * An array of objects that summarize a finding reason code. */ reasonCodeSummaries?: ReasonCodeSummaries; } export type SummaryValue = number; export type Timestamp = Date; export type Timestamps = Timestamp[]; export interface UpdateEnrollmentStatusRequest { /** * The new enrollment status of the account. The following status options are available: Active - Opts in your account to the Compute Optimizer service. Compute Optimizer begins analyzing the configuration and utilization metrics of your AWS resources after you opt in. For more information, see Metrics analyzed by AWS Compute Optimizer in the Compute Optimizer User Guide. Inactive - Opts out your account from the Compute Optimizer service. Your account's recommendations and related metrics data will be deleted from Compute Optimizer after you opt out. The Pending and Failed options cannot be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account. */ status: Status; /** * Indicates whether to enroll member accounts of the organization if the account is the management account of an organization. */ includeMemberAccounts?: IncludeMemberAccounts; } export interface UpdateEnrollmentStatusResponse { /** * The enrollment status of the account. */ status?: Status; /** * The reason for the enrollment status of the account. For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service. */ statusReason?: StatusReason; } export interface UtilizationMetric { /** * The name of the utilization metric. The following utilization metrics are available: Cpu - The percentage of allocated EC2 compute units that are currently in use on the instance. This metric identifies the processing power required to run an application on the instance. Depending on the instance type, tools in your operating system can show a lower percentage than CloudWatch when the instance is not allocated a full processor core. Units: Percent Memory - The percentage of memory that is currently in use on the instance. This metric identifies the amount of memory required to run an application on the instance. Units: Percent The Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent. EBS_READ_OPS_PER_SECOND - The completed read operations from all EBS volumes attached to the instance in a specified period of time. Unit: Count EBS_WRITE_OPS_PER_SECOND - The completed write operations to all EBS volumes attached to the instance in a specified period of time. Unit: Count EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes attached to the instance in a specified period of time. Unit: Bytes EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes attached to the instance in a specified period of time. Unit: Bytes */ name?: MetricName; /** * The statistic of the utilization metric. The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period. The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the AWS Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide. */ statistic?: MetricStatistic; /** * The value of the utilization metric. */ value?: MetricValue; } export type UtilizationMetrics = UtilizationMetric[]; export type VolumeArn = string; export type VolumeArns = VolumeArn[]; export type VolumeBaselineIOPS = number; export type VolumeBaselineThroughput = number; export type VolumeBurstIOPS = number; export type VolumeBurstThroughput = number; export interface VolumeConfiguration { /** * The volume type. This can be gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes. */ volumeType?: VolumeType; /** * The size of the volume, in GiB. */ volumeSize?: VolumeSize; /** * The baseline IOPS of the volume. */ volumeBaselineIOPS?: VolumeBaselineIOPS; /** * The burst IOPS of the volume. */ volumeBurstIOPS?: VolumeBurstIOPS; /** * The baseline throughput of the volume. */ volumeBaselineThroughput?: VolumeBaselineThroughput; /** * The burst throughput of the volume. */ volumeBurstThroughput?: VolumeBurstThroughput; } export interface VolumeRecommendation { /** * The Amazon Resource Name (ARN) of the current volume. */ volumeArn?: VolumeArn; /** * The AWS account ID of the volume. */ accountId?: AccountId; /** * An array of objects that describe the current configuration of the volume. */ currentConfiguration?: VolumeConfiguration; /** * The finding classification for the volume. Findings for volumes include: NotOptimized —A volume is considered not optimized when AWS Compute Optimizer identifies a recommendation that can provide better performance for your workload. Optimized —An volume is considered optimized when Compute Optimizer determines that the volume is correctly provisioned to run your workload based on the chosen volume type. For optimized resources, Compute Optimizer might recommend a new generation volume type. */ finding?: EBSFinding; /** * An array of objects that describe the utilization metrics of the volume. */ utilizationMetrics?: EBSUtilizationMetrics; /** * The number of days for which utilization metrics were analyzed for the volume. */ lookBackPeriodInDays?: LookBackPeriodInDays; /** * An array of objects that describe the recommendation options for the volume. */ volumeRecommendationOptions?: VolumeRecommendationOptions; /** * The time stamp of when the volume recommendation was last refreshed. */ lastRefreshTimestamp?: LastRefreshTimestamp; } export interface VolumeRecommendationOption { /** * An array of objects that describe a volume configuration. */ configuration?: VolumeConfiguration; /** * The performance risk of the volume recommendation option. Performance risk is the likelihood of the recommended volume type not meeting the performance requirement of your workload. The lowest performance risk is categorized as 0, and the highest as 5. */ performanceRisk?: PerformanceRisk; /** * The rank of the volume recommendation option. The top recommendation option is ranked as 1. */ rank?: Rank; } export type VolumeRecommendationOptions = VolumeRecommendationOption[]; export type VolumeRecommendations = VolumeRecommendation[]; export type VolumeSize = number; export type VolumeType = string; /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ export type apiVersion = "2019-11-01"|"latest"|string; export interface ClientApiVersions { /** * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. */ apiVersion?: apiVersion; } export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; /** * Contains interfaces for use with the ComputeOptimizer client. */ export import Types = ComputeOptimizer; } export = ComputeOptimizer;