You do not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.computeoptimizer#AccountId": { "type": "string" }, "com.amazonaws.computeoptimizer#AccountIds": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#AccountId" } }, "com.amazonaws.computeoptimizer#AutoScalingGroupArn": { "type": "string" }, "com.amazonaws.computeoptimizer#AutoScalingGroupArns": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#AutoScalingGroupArn" } }, "com.amazonaws.computeoptimizer#AutoScalingGroupConfiguration": { "type": "structure", "members": { "desiredCapacity": { "target": "com.amazonaws.computeoptimizer#DesiredCapacity", "traits": { "smithy.api#documentation": "The desired capacity, or number of instances, for the Auto Scaling group.
" } }, "minSize": { "target": "com.amazonaws.computeoptimizer#MinSize", "traits": { "smithy.api#documentation": "The minimum size, or minimum number of instances, for the Auto Scaling group.
" } }, "maxSize": { "target": "com.amazonaws.computeoptimizer#MaxSize", "traits": { "smithy.api#documentation": "The maximum size, or maximum number of instances, for the Auto Scaling group.
" } }, "instanceType": { "target": "com.amazonaws.computeoptimizer#InstanceType", "traits": { "smithy.api#documentation": "The instance type for the Auto Scaling group.
" } } }, "traits": { "smithy.api#documentation": "Describes the configuration of an Auto Scaling group.
" } }, "com.amazonaws.computeoptimizer#AutoScalingGroupName": { "type": "string" }, "com.amazonaws.computeoptimizer#AutoScalingGroupRecommendation": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.computeoptimizer#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the Auto Scaling group.
" } }, "autoScalingGroupArn": { "target": "com.amazonaws.computeoptimizer#AutoScalingGroupArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Auto Scaling group.
" } }, "autoScalingGroupName": { "target": "com.amazonaws.computeoptimizer#AutoScalingGroupName", "traits": { "smithy.api#documentation": "The name of the Auto Scaling group.
" } }, "finding": { "target": "com.amazonaws.computeoptimizer#Finding", "traits": { "smithy.api#documentation": "The finding classification of the Auto Scaling group.
\nFindings for Auto Scaling groups include:
\n\n \n NotOptimized\n —An Auto Scaling\n group is considered not optimized when AWS Compute Optimizer identifies a recommendation that\n can provide better performance for your workload.
\n \n Optimized\n —An Auto Scaling group is\n considered optimized when Compute Optimizer determines that the group is correctly\n provisioned to run your workload based on the chosen instance type. For\n optimized resources, Compute Optimizer might recommend a new generation instance type.
An array of objects that describe the utilization metrics of the Auto Scaling group.
" } }, "lookBackPeriodInDays": { "target": "com.amazonaws.computeoptimizer#LookBackPeriodInDays", "traits": { "smithy.api#documentation": "The number of days for which utilization metrics were analyzed for the Auto Scaling\n group.
" } }, "currentConfiguration": { "target": "com.amazonaws.computeoptimizer#AutoScalingGroupConfiguration", "traits": { "smithy.api#documentation": "An array of objects that describe the current configuration of the Auto Scaling group.
" } }, "recommendationOptions": { "target": "com.amazonaws.computeoptimizer#AutoScalingGroupRecommendationOptions", "traits": { "smithy.api#documentation": "An array of objects that describe the recommendation options for the Auto Scaling\n group.
" } }, "lastRefreshTimestamp": { "target": "com.amazonaws.computeoptimizer#LastRefreshTimestamp", "traits": { "smithy.api#documentation": "The time stamp of when the Auto Scaling group recommendation was last refreshed.
" } } }, "traits": { "smithy.api#documentation": "Describes an Auto Scaling group recommendation.
" } }, "com.amazonaws.computeoptimizer#AutoScalingGroupRecommendationOption": { "type": "structure", "members": { "configuration": { "target": "com.amazonaws.computeoptimizer#AutoScalingGroupConfiguration", "traits": { "smithy.api#documentation": "An array of objects that describe an Auto Scaling group configuration.
" } }, "projectedUtilizationMetrics": { "target": "com.amazonaws.computeoptimizer#ProjectedUtilizationMetrics", "traits": { "smithy.api#documentation": "An array of objects that describe the projected utilization metrics of the Auto Scaling group\n recommendation option.
\n\nThe Cpu and Memory metrics are the only projected\n utilization metrics returned. Additionally, the Memory metric is\n returned only for resources that have the unified CloudWatch agent installed on them. For\n more information, see Enabling Memory\n Utilization with the CloudWatch Agent.
The performance risk of the Auto Scaling group configuration recommendation.
\nPerformance risk indicates the likelihood of the recommended instance type not meeting\n the resource needs of your workload. Compute Optimizer calculates an individual performance risk\n score for each specification of the recommended instance, including CPU, memory, EBS\n throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS.\n The performance\n risk of the recommended instance is calculated as the maximum performance risk score\n across the analyzed resource specifications.
\nThe value ranges from 0 to 5, with 0 meaning that the recommended resource is\n predicted to always provide enough hardware capability. The higher the performance risk\n is, the more likely you should validate whether the recommended resource meets the\n performance requirements of your workload before migrating your resource.
" } }, "rank": { "target": "com.amazonaws.computeoptimizer#Rank", "traits": { "smithy.api#documentation": "The rank of the Auto Scaling group recommendation option.
\nThe top recommendation option is ranked as 1.
Describes a recommendation option for an Auto Scaling group.
" } }, "com.amazonaws.computeoptimizer#AutoScalingGroupRecommendationOptions": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#AutoScalingGroupRecommendationOption" } }, "com.amazonaws.computeoptimizer#AutoScalingGroupRecommendations": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#AutoScalingGroupRecommendation" } }, "com.amazonaws.computeoptimizer#Code": { "type": "string" }, "com.amazonaws.computeoptimizer#ComputeOptimizerService": { "type": "service", "version": "2019-11-01", "operations": [ { "target": "com.amazonaws.computeoptimizer#DescribeRecommendationExportJobs" }, { "target": "com.amazonaws.computeoptimizer#ExportAutoScalingGroupRecommendations" }, { "target": "com.amazonaws.computeoptimizer#ExportEBSVolumeRecommendations" }, { "target": "com.amazonaws.computeoptimizer#ExportEC2InstanceRecommendations" }, { "target": "com.amazonaws.computeoptimizer#ExportLambdaFunctionRecommendations" }, { "target": "com.amazonaws.computeoptimizer#GetAutoScalingGroupRecommendations" }, { "target": "com.amazonaws.computeoptimizer#GetEBSVolumeRecommendations" }, { "target": "com.amazonaws.computeoptimizer#GetEC2InstanceRecommendations" }, { "target": "com.amazonaws.computeoptimizer#GetEC2RecommendationProjectedMetrics" }, { "target": "com.amazonaws.computeoptimizer#GetEnrollmentStatus" }, { "target": "com.amazonaws.computeoptimizer#GetLambdaFunctionRecommendations" }, { "target": "com.amazonaws.computeoptimizer#GetRecommendationSummaries" }, { "target": "com.amazonaws.computeoptimizer#UpdateEnrollmentStatus" } ], "traits": { "aws.api#service": { "sdkId": "Compute Optimizer", "arnNamespace": "compute-optimizer", "cloudFormationName": "ComputeOptimizer", "cloudTrailEventSource": "computeoptimizer.amazonaws.com", "endpointPrefix": "compute-optimizer" }, "aws.auth#sigv4": { "name": "compute-optimizer" }, "aws.protocols#awsJson1_0": {}, "smithy.api#documentation": "AWS Compute Optimizer is a service that analyzes the configuration and utilization\n metrics of your AWS compute resources, such as EC2 instances, Auto Scaling groups, AWS Lambda\n functions, and Amazon EBS volumes. It reports whether your resources are optimal, and\n generates optimization recommendations to reduce the cost and improve the performance of\n your workloads. Compute Optimizer also provides recent utilization metric data, as well as projected\n utilization metric data for the recommendations, which you can use to evaluate which\n recommendation provides the best price-performance trade-off. The analysis of your usage\n patterns can help you decide when to move or resize your running resources, and still\n meet your performance and capacity requirements. For more information about Compute Optimizer,\n including the required permissions to use the service, see the AWS Compute Optimizer User\n Guide.
", "smithy.api#title": "AWS Compute Optimizer" } }, "com.amazonaws.computeoptimizer#CreationTimestamp": { "type": "timestamp" }, "com.amazonaws.computeoptimizer#CurrentInstanceType": { "type": "string" }, "com.amazonaws.computeoptimizer#DescribeRecommendationExportJobs": { "type": "operation", "input": { "target": "com.amazonaws.computeoptimizer#DescribeRecommendationExportJobsRequest" }, "output": { "target": "com.amazonaws.computeoptimizer#DescribeRecommendationExportJobsResponse" }, "errors": [ { "target": "com.amazonaws.computeoptimizer#AccessDeniedException" }, { "target": "com.amazonaws.computeoptimizer#InternalServerException" }, { "target": "com.amazonaws.computeoptimizer#InvalidParameterValueException" }, { "target": "com.amazonaws.computeoptimizer#MissingAuthenticationToken" }, { "target": "com.amazonaws.computeoptimizer#OptInRequiredException" }, { "target": "com.amazonaws.computeoptimizer#ResourceNotFoundException" }, { "target": "com.amazonaws.computeoptimizer#ServiceUnavailableException" }, { "target": "com.amazonaws.computeoptimizer#ThrottlingException" } ], "traits": { "smithy.api#documentation": "Describes recommendation export jobs created in the last seven days.
\n\nUse the ExportAutoScalingGroupRecommendations or\n ExportEC2InstanceRecommendations actions to request an export of your\n recommendations. Then use the DescribeRecommendationExportJobs action to\n view your export jobs.
The identification numbers of the export jobs to return.
\n\nAn export job ID is returned when you create an export using the\n ExportAutoScalingGroupRecommendations or\n ExportEC2InstanceRecommendations actions.
All export jobs created in the last seven days are returned if this parameter is\n omitted.
" } }, "filters": { "target": "com.amazonaws.computeoptimizer#JobFilters", "traits": { "smithy.api#documentation": "An array of objects that describe a filter to return a more specific list of export\n jobs.
" } }, "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { "smithy.api#documentation": "The token to advance to the next page of export jobs.
" } }, "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of export jobs to return with a single request.
\nTo retrieve the remaining results, make another request with the returned\n NextToken value.
An array of objects that describe recommendation export jobs.
" } }, "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { "smithy.api#documentation": "The token to use to advance to the next page of export jobs.
\nThis value is null when there are no more pages of export jobs to return.
" } } } }, "com.amazonaws.computeoptimizer#DesiredCapacity": { "type": "integer" }, "com.amazonaws.computeoptimizer#DestinationBucket": { "type": "string" }, "com.amazonaws.computeoptimizer#DestinationKey": { "type": "string" }, "com.amazonaws.computeoptimizer#DestinationKeyPrefix": { "type": "string" }, "com.amazonaws.computeoptimizer#EBSFilter": { "type": "structure", "members": { "name": { "target": "com.amazonaws.computeoptimizer#EBSFilterName", "traits": { "smithy.api#documentation": "The name of the filter.
\n\nSpecify Finding to return recommendations with a specific finding\n classification (e.g., NotOptimized).
The value of the filter.
\n\nThe valid values are Optimized, or NotOptimized.
Describes a filter that returns a more specific list of Amazon Elastic Block Store (Amazon EBS) volume\n recommendations. Use this filter with the GetEBSVolumeRecommendations\n action.
You can use LambdaFunctionRecommendationFilter with the\n GetLambdaFunctionRecommendations action, JobFilter with\n the DescribeRecommendationExportJobs action, and Filter with\n the GetAutoScalingGroupRecommendations and\n GetEC2InstanceRecommendations actions.
The name of the utilization metric.
\nThe following utilization metrics are available:
\n\n VolumeReadOpsPerSecond - The completed read operations per second\n from the volume in a specified period of time.
Unit: Count
\n\n VolumeWriteOpsPerSecond - The completed write operations per\n second to the volume in a specified period of time.
Unit: Count
\n\n VolumeReadBytesPerSecond - The bytes read per second from the\n volume in a specified period of time.
Unit: Bytes
\n\n VolumeWriteBytesPerSecond - The bytes written to the volume in a\n specified period of time.
Unit: Bytes
\nThe statistic of the utilization metric.
\n\nThe Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using\n only the Maximum statistic, which is the highest value observed during the\n specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the\n Average statistic, which is the value of Sum /\n SampleCount during the specified period. For more information, see\n Viewing resource\n recommendations in the AWS Compute Optimizer User Guide. You can\n also get averaged utilization metric data for your resources using Amazon CloudWatch. For more\n information, see the Amazon CloudWatch User\n Guide.
The value of the utilization metric.
" } } }, "traits": { "smithy.api#documentation": "Describes a utilization metric of an Amazon Elastic Block Store (Amazon EBS) volume.
\n\nCompare the utilization metric data of your resource against its projected utilization\n metric data to determine the performance difference between your current resource and\n the recommended option.
" } }, "com.amazonaws.computeoptimizer#EBSUtilizationMetrics": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#EBSUtilizationMetric" } }, "com.amazonaws.computeoptimizer#ErrorMessage": { "type": "string" }, "com.amazonaws.computeoptimizer#ExportAutoScalingGroupRecommendations": { "type": "operation", "input": { "target": "com.amazonaws.computeoptimizer#ExportAutoScalingGroupRecommendationsRequest" }, "output": { "target": "com.amazonaws.computeoptimizer#ExportAutoScalingGroupRecommendationsResponse" }, "errors": [ { "target": "com.amazonaws.computeoptimizer#AccessDeniedException" }, { "target": "com.amazonaws.computeoptimizer#InternalServerException" }, { "target": "com.amazonaws.computeoptimizer#InvalidParameterValueException" }, { "target": "com.amazonaws.computeoptimizer#LimitExceededException" }, { "target": "com.amazonaws.computeoptimizer#MissingAuthenticationToken" }, { "target": "com.amazonaws.computeoptimizer#OptInRequiredException" }, { "target": "com.amazonaws.computeoptimizer#ServiceUnavailableException" }, { "target": "com.amazonaws.computeoptimizer#ThrottlingException" } ], "traits": { "smithy.api#documentation": "Exports optimization recommendations for Auto Scaling groups.
\n\nRecommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that\n you specify. For more information, see Exporting\n Recommendations in the Compute Optimizer User Guide.
\n\nYou can have only one Auto Scaling group export job in progress per AWS\n Region.
" } }, "com.amazonaws.computeoptimizer#ExportAutoScalingGroupRecommendationsRequest": { "type": "structure", "members": { "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { "smithy.api#documentation": "The IDs of the AWS accounts for which to export Auto Scaling group\n recommendations.
\n \n \n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.
\nThis parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.
\nYou can specify multiple account IDs per request.
" } }, "filters": { "target": "com.amazonaws.computeoptimizer#Filters", "traits": { "smithy.api#documentation": "An array of objects that describe a filter to export a more specific set of Auto Scaling group\n recommendations.
" } }, "fieldsToExport": { "target": "com.amazonaws.computeoptimizer#ExportableAutoScalingGroupFields", "traits": { "smithy.api#documentation": "The recommendations data to include in the export file. For more information about the\n fields that can be exported, see Exported files in the Compute Optimizer User Guide.
" } }, "s3DestinationConfig": { "target": "com.amazonaws.computeoptimizer#S3DestinationConfig", "traits": { "smithy.api#documentation": "An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for\n the export job.
\nYou must create the destination Amazon S3 bucket for your recommendations export before you\n create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the\n S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the\n export file to it. If you plan to specify an object prefix when you create the export\n job, you must include the object prefix in the policy that you add to the S3 bucket. For\n more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user\n guide.
", "smithy.api#required": {} } }, "fileFormat": { "target": "com.amazonaws.computeoptimizer#FileFormat", "traits": { "smithy.api#documentation": "The format of the export file.
\nThe only export file format currently supported is Csv.
Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.
\n\nThe member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and\n AWS Organizations trusted access in the AWS Compute Optimizer User\n Guide.
\n \n \n\nRecommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.
\nThis parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.
" } } } }, "com.amazonaws.computeoptimizer#ExportAutoScalingGroupRecommendationsResponse": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.computeoptimizer#JobId", "traits": { "smithy.api#documentation": "The identification number of the export job.
\nUse the DescribeRecommendationExportJobs action, and specify the job ID\n to view the status of an export job.
An object that describes the destination Amazon S3 bucket of a recommendations export\n file.
" } } } }, "com.amazonaws.computeoptimizer#ExportDestination": { "type": "structure", "members": { "s3": { "target": "com.amazonaws.computeoptimizer#S3Destination", "traits": { "smithy.api#documentation": "An object that describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys\n of a recommendations export file, and its associated metadata file.
" } } }, "traits": { "smithy.api#documentation": "Describes the destination of the recommendations export and metadata files.
" } }, "com.amazonaws.computeoptimizer#ExportEBSVolumeRecommendations": { "type": "operation", "input": { "target": "com.amazonaws.computeoptimizer#ExportEBSVolumeRecommendationsRequest" }, "output": { "target": "com.amazonaws.computeoptimizer#ExportEBSVolumeRecommendationsResponse" }, "errors": [ { "target": "com.amazonaws.computeoptimizer#AccessDeniedException" }, { "target": "com.amazonaws.computeoptimizer#InternalServerException" }, { "target": "com.amazonaws.computeoptimizer#InvalidParameterValueException" }, { "target": "com.amazonaws.computeoptimizer#LimitExceededException" }, { "target": "com.amazonaws.computeoptimizer#MissingAuthenticationToken" }, { "target": "com.amazonaws.computeoptimizer#OptInRequiredException" }, { "target": "com.amazonaws.computeoptimizer#ServiceUnavailableException" }, { "target": "com.amazonaws.computeoptimizer#ThrottlingException" } ], "traits": { "smithy.api#documentation": "Exports optimization recommendations for Amazon EBS volumes.
\n\nRecommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that\n you specify. For more information, see Exporting\n Recommendations in the Compute Optimizer User Guide.
\n\nYou can have only one Amazon EBS volume export job in progress per AWS\n Region.
" } }, "com.amazonaws.computeoptimizer#ExportEBSVolumeRecommendationsRequest": { "type": "structure", "members": { "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { "smithy.api#documentation": "The IDs of the AWS accounts for which to export Amazon EBS volume\n recommendations.
\n \n \n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.
\nThis parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.
\nYou can specify multiple account IDs per request.
" } }, "filters": { "target": "com.amazonaws.computeoptimizer#EBSFilters", "traits": { "smithy.api#documentation": "An array of objects that describe a filter to export a more specific set of Amazon EBS\n volume recommendations.
" } }, "fieldsToExport": { "target": "com.amazonaws.computeoptimizer#ExportableVolumeFields", "traits": { "smithy.api#documentation": "The recommendations data to include in the export file. For more information about the\n fields that can be exported, see Exported files in the Compute Optimizer User Guide.
" } }, "s3DestinationConfig": { "target": "com.amazonaws.computeoptimizer#S3DestinationConfig", "traits": { "smithy.api#required": {} } }, "fileFormat": { "target": "com.amazonaws.computeoptimizer#FileFormat", "traits": { "smithy.api#documentation": "The format of the export file.
\nThe only export file format currently supported is Csv.
Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.
\n\nThe member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and\n AWS Organizations trusted access in the AWS Compute Optimizer User\n Guide.
\n \n \n\nRecommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.
\nThis parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.
" } } } }, "com.amazonaws.computeoptimizer#ExportEBSVolumeRecommendationsResponse": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.computeoptimizer#JobId", "traits": { "smithy.api#documentation": "The identification number of the export job.
\nUse the DescribeRecommendationExportJobs action, and specify the job ID\n to view the status of an export job.
Exports optimization recommendations for Amazon EC2 instances.
\n\nRecommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that\n you specify. For more information, see Exporting\n Recommendations in the Compute Optimizer User Guide.
\n\nYou can have only one Amazon EC2 instance export job in progress per AWS\n Region.
" } }, "com.amazonaws.computeoptimizer#ExportEC2InstanceRecommendationsRequest": { "type": "structure", "members": { "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { "smithy.api#documentation": "The IDs of the AWS accounts for which to export instance\n recommendations.
\n \n \n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.
\nThis parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.
\nYou can specify multiple account IDs per request.
" } }, "filters": { "target": "com.amazonaws.computeoptimizer#Filters", "traits": { "smithy.api#documentation": "An array of objects that describe a filter to export a more specific set of instance\n recommendations.
" } }, "fieldsToExport": { "target": "com.amazonaws.computeoptimizer#ExportableInstanceFields", "traits": { "smithy.api#documentation": "The recommendations data to include in the export file. For more information about the\n fields that can be exported, see Exported files in the Compute Optimizer User Guide.
" } }, "s3DestinationConfig": { "target": "com.amazonaws.computeoptimizer#S3DestinationConfig", "traits": { "smithy.api#documentation": "An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for\n the export job.
\nYou must create the destination Amazon S3 bucket for your recommendations export before you\n create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the\n S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the\n export file to it. If you plan to specify an object prefix when you create the export\n job, you must include the object prefix in the policy that you add to the S3 bucket. For\n more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user\n guide.
", "smithy.api#required": {} } }, "fileFormat": { "target": "com.amazonaws.computeoptimizer#FileFormat", "traits": { "smithy.api#documentation": "The format of the export file.
\nThe only export file format currently supported is Csv.
Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.
\n\nThe member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and\n AWS Organizations trusted access in the AWS Compute Optimizer User\n Guide.
\n \n \n\nRecommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.
" } } } }, "com.amazonaws.computeoptimizer#ExportEC2InstanceRecommendationsResponse": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.computeoptimizer#JobId", "traits": { "smithy.api#documentation": "The identification number of the export job.
\nUse the DescribeRecommendationExportJobs action, and specify the job ID\n to view the status of an export job.
An object that describes the destination Amazon S3 bucket of a recommendations export\n file.
" } } } }, "com.amazonaws.computeoptimizer#ExportLambdaFunctionRecommendations": { "type": "operation", "input": { "target": "com.amazonaws.computeoptimizer#ExportLambdaFunctionRecommendationsRequest" }, "output": { "target": "com.amazonaws.computeoptimizer#ExportLambdaFunctionRecommendationsResponse" }, "errors": [ { "target": "com.amazonaws.computeoptimizer#AccessDeniedException" }, { "target": "com.amazonaws.computeoptimizer#InternalServerException" }, { "target": "com.amazonaws.computeoptimizer#InvalidParameterValueException" }, { "target": "com.amazonaws.computeoptimizer#LimitExceededException" }, { "target": "com.amazonaws.computeoptimizer#MissingAuthenticationToken" }, { "target": "com.amazonaws.computeoptimizer#OptInRequiredException" }, { "target": "com.amazonaws.computeoptimizer#ServiceUnavailableException" }, { "target": "com.amazonaws.computeoptimizer#ThrottlingException" } ], "traits": { "smithy.api#documentation": "Exports optimization recommendations for AWS Lambda functions.
\n \n \n\nRecommendations are exported in a comma-separated values (.csv) file, and its metadata\n in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that\n you specify. For more information, see Exporting\n Recommendations in the Compute Optimizer User Guide.
\n\nYou can have only one Lambda function export job in progress per AWS\n Region.
" } }, "com.amazonaws.computeoptimizer#ExportLambdaFunctionRecommendationsRequest": { "type": "structure", "members": { "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { "smithy.api#documentation": "The IDs of the AWS accounts for which to export Lambda function\n recommendations.
\n \n \n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to export recommendations.
\nThis parameter cannot be specified together with the include member accounts\n parameter. The parameters are mutually exclusive.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the include member accounts parameter, is omitted.
\nYou can specify multiple account IDs per request.
" } }, "filters": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionRecommendationFilters", "traits": { "smithy.api#documentation": "An array of objects that describe a filter to export a more specific set of Lambda\n function recommendations.
" } }, "fieldsToExport": { "target": "com.amazonaws.computeoptimizer#ExportableLambdaFunctionFields", "traits": { "smithy.api#documentation": "The recommendations data to include in the export file. For more information about the\n fields that can be exported, see Exported files in the Compute Optimizer User Guide.
" } }, "s3DestinationConfig": { "target": "com.amazonaws.computeoptimizer#S3DestinationConfig", "traits": { "smithy.api#required": {} } }, "fileFormat": { "target": "com.amazonaws.computeoptimizer#FileFormat", "traits": { "smithy.api#documentation": "The format of the export file.
\nThe only export file format currently supported is Csv.
Indicates whether to include recommendations for resources in all member accounts of\n the organization if your account is the management account of an organization.
\n\nThe member accounts must also be opted in to Compute Optimizer, and trusted access for\n Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and\n AWS Organizations trusted access in the AWS Compute Optimizer User\n Guide.
\n \n \n\nRecommendations for member accounts of the organization are not included in the export\n file if this parameter is omitted.
\nThis parameter cannot be specified together with the account IDs parameter. The\n parameters are mutually exclusive.
\nRecommendations for member accounts are not included in the export if this parameter,\n or the account IDs parameter, is omitted.
" } } } }, "com.amazonaws.computeoptimizer#ExportLambdaFunctionRecommendationsResponse": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.computeoptimizer#JobId", "traits": { "smithy.api#documentation": "The identification number of the export job.
\nUse the DescribeRecommendationExportJobs action, and specify the job ID\n to view the status of an export job.
The name of the filter.
\n\nSpecify Finding to return recommendations with a specific finding\n classification (e.g., Underprovisioned).
Specify RecommendationSourceType to return recommendations of a specific\n resource type (e.g., Ec2Instance).
Specify FindingReasonCodes to return recommendations with a specific\n finding reason code (e.g., CPUUnderprovisioned).
The value of the filter.
\n\nThe valid values for this parameter are as follows, depending on what you specify for\n the name parameter and the resource type that you wish to filter results\n for:
Specify Optimized or NotOptimized if you specify the\n name parameter as Finding and you want to filter\n results for Auto Scaling groups.
Specify Underprovisioned, Overprovisioned, or\n Optimized if you specify the name parameter as\n Finding and you want to filter results for EC2\n instances.
Specify Ec2Instance or AutoScalingGroup if you\n specify the name parameter as\n RecommendationSourceType.
Specify one of the following options if you specify the name\n parameter as FindingReasonCodes:
\n \n CPUOverprovisioned\n — The\n instance’s CPU configuration can be sized down while still meeting the\n performance requirements of your workload.
\n \n CPUUnderprovisioned\n —\n The instance’s CPU configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better CPU performance.
\n \n MemoryOverprovisioned\n —\n The instance’s memory configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n MemoryUnderprovisioned\n —\n The instance’s memory configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better memory performance.
\n \n EBSThroughputOverprovisioned\n — The\n instance’s EBS throughput configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n EBSThroughputUnderprovisioned\n — The\n instance’s EBS throughput configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better EBS throughput performance.
\n \n EBSIOPSOverprovisioned\n —\n The instance’s EBS IOPS configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n EBSIOPSUnderprovisioned\n \n — The instance’s EBS IOPS configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better EBS IOPS performance.
\n \n NetworkBandwidthOverprovisioned\n — The\n instance’s network bandwidth configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n NetworkBandwidthUnderprovisioned\n — The\n instance’s network bandwidth configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better network bandwidth performance. This finding reason\n happens when the NetworkIn or NetworkOut\n performance of an instance is impacted.
\n \n NetworkPPSOverprovisioned\n — The instance’s\n network PPS (packets per second) configuration can be sized down while\n still meeting the performance requirements of your workload.
\n \n NetworkPPSUnderprovisioned\n — The instance’s\n network PPS (packets per second) configuration doesn't meet the\n performance requirements of your workload and there is an alternative\n instance type that provides better network PPS performance.
\n \n DiskIOPSOverprovisioned\n \n — The instance’s disk IOPS configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n DiskIOPSUnderprovisioned\n \n — The instance’s disk IOPS configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better disk IOPS performance.
\n \n DiskThroughputOverprovisioned\n — The\n instance’s disk throughput configuration can be sized down while still\n meeting the performance requirements of your workload.
\n \n DiskThroughputUnderprovisioned\n — The\n instance’s disk throughput configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type\n that provides better disk throughput performance.
Describes a filter that returns a more specific list of recommendations. Use this\n filter with the GetAutoScalingGroupRecommendations and\n GetEC2InstanceRecommendations actions.
You can use EBSFilter with the GetEBSVolumeRecommendations\n action, LambdaFunctionRecommendationFilter with the\n GetLambdaFunctionRecommendations action, and JobFilter\n with the DescribeRecommendationExportJobs action.
Returns Auto Scaling group recommendations.
\n\nAWS Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific\n set of requirements. For more information, see the Supported resources and\n requirements in the AWS Compute Optimizer User Guide.
" } }, "com.amazonaws.computeoptimizer#GetAutoScalingGroupRecommendationsRequest": { "type": "structure", "members": { "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { "smithy.api#documentation": "The ID of the AWS account for which to return Auto Scaling group\n recommendations.
\n \n \n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return Auto Scaling group\n recommendations.
\nOnly one account ID can be specified per request.
" } }, "autoScalingGroupArns": { "target": "com.amazonaws.computeoptimizer#AutoScalingGroupArns", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return\n recommendations.
" } }, "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { "smithy.api#documentation": "The token to advance to the next page of Auto Scaling group recommendations.
" } }, "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of Auto Scaling group recommendations to return with a single\n request.
\nTo retrieve the remaining results, make another request with the returned\n NextToken value.
An array of objects that describe a filter that returns a more specific list of Auto Scaling\n group recommendations.
" } } } }, "com.amazonaws.computeoptimizer#GetAutoScalingGroupRecommendationsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { "smithy.api#documentation": "The token to use to advance to the next page of Auto Scaling group recommendations.
\nThis value is null when there are no more pages of Auto Scaling group recommendations to\n return.
" } }, "autoScalingGroupRecommendations": { "target": "com.amazonaws.computeoptimizer#AutoScalingGroupRecommendations", "traits": { "smithy.api#documentation": "An array of objects that describe Auto Scaling group recommendations.
" } }, "errors": { "target": "com.amazonaws.computeoptimizer#GetRecommendationErrors", "traits": { "smithy.api#documentation": "An array of objects that describe errors of the request.
\nFor example, an error is returned if you request recommendations for an unsupported\n Auto Scaling group.
" } } } }, "com.amazonaws.computeoptimizer#GetEBSVolumeRecommendations": { "type": "operation", "input": { "target": "com.amazonaws.computeoptimizer#GetEBSVolumeRecommendationsRequest" }, "output": { "target": "com.amazonaws.computeoptimizer#GetEBSVolumeRecommendationsResponse" }, "errors": [ { "target": "com.amazonaws.computeoptimizer#AccessDeniedException" }, { "target": "com.amazonaws.computeoptimizer#InternalServerException" }, { "target": "com.amazonaws.computeoptimizer#InvalidParameterValueException" }, { "target": "com.amazonaws.computeoptimizer#MissingAuthenticationToken" }, { "target": "com.amazonaws.computeoptimizer#OptInRequiredException" }, { "target": "com.amazonaws.computeoptimizer#ResourceNotFoundException" }, { "target": "com.amazonaws.computeoptimizer#ServiceUnavailableException" }, { "target": "com.amazonaws.computeoptimizer#ThrottlingException" } ], "traits": { "smithy.api#documentation": "Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
\n\nAWS Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific\n set of requirements. For more information, see the Supported resources and\n requirements in the AWS Compute Optimizer User Guide.
" } }, "com.amazonaws.computeoptimizer#GetEBSVolumeRecommendationsRequest": { "type": "structure", "members": { "volumeArns": { "target": "com.amazonaws.computeoptimizer#VolumeArns", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volumes for which to return\n recommendations.
" } }, "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { "smithy.api#documentation": "The token to advance to the next page of volume recommendations.
" } }, "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of volume recommendations to return with a single request.
\nTo retrieve the remaining results, make another request with the returned\n NextToken value.
An array of objects that describe a filter that returns a more specific list of volume\n recommendations.
" } }, "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { "smithy.api#documentation": "The ID of the AWS account for which to return volume\n recommendations.
\n \n \n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return volume recommendations.
\nOnly one account ID can be specified per request.
" } } } }, "com.amazonaws.computeoptimizer#GetEBSVolumeRecommendationsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { "smithy.api#documentation": "The token to use to advance to the next page of volume recommendations.
\nThis value is null when there are no more pages of volume recommendations to\n return.
" } }, "volumeRecommendations": { "target": "com.amazonaws.computeoptimizer#VolumeRecommendations", "traits": { "smithy.api#documentation": "An array of objects that describe volume recommendations.
" } }, "errors": { "target": "com.amazonaws.computeoptimizer#GetRecommendationErrors", "traits": { "smithy.api#documentation": "An array of objects that describe errors of the request.
\nFor example, an error is returned if you request recommendations for an unsupported\n volume.
" } } } }, "com.amazonaws.computeoptimizer#GetEC2InstanceRecommendations": { "type": "operation", "input": { "target": "com.amazonaws.computeoptimizer#GetEC2InstanceRecommendationsRequest" }, "output": { "target": "com.amazonaws.computeoptimizer#GetEC2InstanceRecommendationsResponse" }, "errors": [ { "target": "com.amazonaws.computeoptimizer#AccessDeniedException" }, { "target": "com.amazonaws.computeoptimizer#InternalServerException" }, { "target": "com.amazonaws.computeoptimizer#InvalidParameterValueException" }, { "target": "com.amazonaws.computeoptimizer#MissingAuthenticationToken" }, { "target": "com.amazonaws.computeoptimizer#OptInRequiredException" }, { "target": "com.amazonaws.computeoptimizer#ResourceNotFoundException" }, { "target": "com.amazonaws.computeoptimizer#ServiceUnavailableException" }, { "target": "com.amazonaws.computeoptimizer#ThrottlingException" } ], "traits": { "smithy.api#documentation": "Returns Amazon EC2 instance recommendations.
\n\nAWS Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet\n a specific set of requirements. For more information, see the Supported\n resources and requirements in the AWS Compute Optimizer User\n Guide.
" } }, "com.amazonaws.computeoptimizer#GetEC2InstanceRecommendationsRequest": { "type": "structure", "members": { "instanceArns": { "target": "com.amazonaws.computeoptimizer#InstanceArns", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the instances for which to return\n recommendations.
" } }, "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { "smithy.api#documentation": "The token to advance to the next page of instance recommendations.
" } }, "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of instance recommendations to return with a single request.
\nTo retrieve the remaining results, make another request with the returned\n NextToken value.
An array of objects that describe a filter that returns a more specific list of\n instance recommendations.
" } }, "accountIds": { "target": "com.amazonaws.computeoptimizer#AccountIds", "traits": { "smithy.api#documentation": "The ID of the AWS account for which to return instance\n recommendations.
\n \n \n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return instance recommendations.
\nOnly one account ID can be specified per request.
" } } } }, "com.amazonaws.computeoptimizer#GetEC2InstanceRecommendationsResponse": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { "smithy.api#documentation": "The token to use to advance to the next page of instance recommendations.
\nThis value is null when there are no more pages of instance recommendations to\n return.
" } }, "instanceRecommendations": { "target": "com.amazonaws.computeoptimizer#InstanceRecommendations", "traits": { "smithy.api#documentation": "An array of objects that describe instance recommendations.
" } }, "errors": { "target": "com.amazonaws.computeoptimizer#GetRecommendationErrors", "traits": { "smithy.api#documentation": "An array of objects that describe errors of the request.
\nFor example, an error is returned if you request recommendations for an instance of an\n unsupported instance family.
" } } } }, "com.amazonaws.computeoptimizer#GetEC2RecommendationProjectedMetrics": { "type": "operation", "input": { "target": "com.amazonaws.computeoptimizer#GetEC2RecommendationProjectedMetricsRequest" }, "output": { "target": "com.amazonaws.computeoptimizer#GetEC2RecommendationProjectedMetricsResponse" }, "errors": [ { "target": "com.amazonaws.computeoptimizer#AccessDeniedException" }, { "target": "com.amazonaws.computeoptimizer#InternalServerException" }, { "target": "com.amazonaws.computeoptimizer#InvalidParameterValueException" }, { "target": "com.amazonaws.computeoptimizer#MissingAuthenticationToken" }, { "target": "com.amazonaws.computeoptimizer#OptInRequiredException" }, { "target": "com.amazonaws.computeoptimizer#ResourceNotFoundException" }, { "target": "com.amazonaws.computeoptimizer#ServiceUnavailableException" }, { "target": "com.amazonaws.computeoptimizer#ThrottlingException" } ], "traits": { "smithy.api#documentation": "Returns the projected utilization metrics of Amazon EC2 instance recommendations.
\n\nThe Cpu and Memory metrics are the only projected\n utilization metrics returned when you run this action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.
The Amazon Resource Name (ARN) of the instances for which to return recommendation\n projected metrics.
", "smithy.api#required": {} } }, "stat": { "target": "com.amazonaws.computeoptimizer#MetricStatistic", "traits": { "smithy.api#documentation": "The statistic of the projected metrics.
", "smithy.api#required": {} } }, "period": { "target": "com.amazonaws.computeoptimizer#Period", "traits": { "smithy.api#documentation": "The granularity, in seconds, of the projected metrics data points.
", "smithy.api#required": {} } }, "startTime": { "target": "com.amazonaws.computeoptimizer#Timestamp", "traits": { "smithy.api#documentation": "The time stamp of the first projected metrics data point to return.
", "smithy.api#required": {} } }, "endTime": { "target": "com.amazonaws.computeoptimizer#Timestamp", "traits": { "smithy.api#documentation": "The time stamp of the last projected metrics data point to return.
", "smithy.api#required": {} } } } }, "com.amazonaws.computeoptimizer#GetEC2RecommendationProjectedMetricsResponse": { "type": "structure", "members": { "recommendedOptionProjectedMetrics": { "target": "com.amazonaws.computeoptimizer#RecommendedOptionProjectedMetrics", "traits": { "smithy.api#documentation": "An array of objects that describe a projected metrics.
" } } } }, "com.amazonaws.computeoptimizer#GetEnrollmentStatus": { "type": "operation", "input": { "target": "com.amazonaws.computeoptimizer#GetEnrollmentStatusRequest" }, "output": { "target": "com.amazonaws.computeoptimizer#GetEnrollmentStatusResponse" }, "errors": [ { "target": "com.amazonaws.computeoptimizer#AccessDeniedException" }, { "target": "com.amazonaws.computeoptimizer#InternalServerException" }, { "target": "com.amazonaws.computeoptimizer#InvalidParameterValueException" }, { "target": "com.amazonaws.computeoptimizer#MissingAuthenticationToken" }, { "target": "com.amazonaws.computeoptimizer#ServiceUnavailableException" }, { "target": "com.amazonaws.computeoptimizer#ThrottlingException" } ], "traits": { "smithy.api#documentation": "Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer\n service.
\n \n \n\nIf the account is the management account of an organization, this action also confirms\n the enrollment status of member accounts within the organization.
" } }, "com.amazonaws.computeoptimizer#GetEnrollmentStatusRequest": { "type": "structure", "members": {} }, "com.amazonaws.computeoptimizer#GetEnrollmentStatusResponse": { "type": "structure", "members": { "status": { "target": "com.amazonaws.computeoptimizer#Status", "traits": { "smithy.api#documentation": "The enrollment status of the account.
" } }, "statusReason": { "target": "com.amazonaws.computeoptimizer#StatusReason", "traits": { "smithy.api#documentation": "The reason for the enrollment status of the account.
\nFor example, an account might show a status of Pending because member\n accounts of an organization require more time to be enrolled in the service.
Confirms the enrollment status of member accounts within the organization, if the\n account is a management account of an organization.
" } } } }, "com.amazonaws.computeoptimizer#GetLambdaFunctionRecommendations": { "type": "operation", "input": { "target": "com.amazonaws.computeoptimizer#GetLambdaFunctionRecommendationsRequest" }, "output": { "target": "com.amazonaws.computeoptimizer#GetLambdaFunctionRecommendationsResponse" }, "errors": [ { "target": "com.amazonaws.computeoptimizer#AccessDeniedException" }, { "target": "com.amazonaws.computeoptimizer#InternalServerException" }, { "target": "com.amazonaws.computeoptimizer#InvalidParameterValueException" }, { "target": "com.amazonaws.computeoptimizer#LimitExceededException" }, { "target": "com.amazonaws.computeoptimizer#MissingAuthenticationToken" }, { "target": "com.amazonaws.computeoptimizer#OptInRequiredException" }, { "target": "com.amazonaws.computeoptimizer#ServiceUnavailableException" }, { "target": "com.amazonaws.computeoptimizer#ThrottlingException" } ], "traits": { "smithy.api#documentation": "Returns AWS Lambda function recommendations.
\n \n \n\nAWS Compute Optimizer generates recommendations for functions that meet a specific set of\n requirements. For more information, see the Supported resources and\n requirements in the AWS Compute Optimizer User Guide.
" } }, "com.amazonaws.computeoptimizer#GetLambdaFunctionRecommendationsRequest": { "type": "structure", "members": { "functionArns": { "target": "com.amazonaws.computeoptimizer#FunctionArns", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the functions for which to return\n recommendations.
\n\nYou can specify a qualified or unqualified ARN. If you specify an\n unqualified ARN without a function version suffix, Compute Optimizer will return recommendations for\n the latest ($LATEST) version of the function. If you specify a qualified\n ARN with a version suffix, Compute Optimizer will return recommendations for the specified function\n version. For more information about using function versions, see Using\n versions in the AWS Lambda Developer Guide.
The ID of the AWS account for which to return function\n recommendations.
\n \n \n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return function recommendations.
\n\nOnly one account ID can be specified per request.
" } }, "filters": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionRecommendationFilters", "traits": { "smithy.api#documentation": "An array of objects that describe a filter that returns a more specific list of\n function recommendations.
" } }, "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { "smithy.api#documentation": "The token to advance to the next page of function recommendations.
" } }, "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of function recommendations to return with a single request.
\n\nTo retrieve the remaining results, make another request with the returned\n NextToken value.
The token to use to advance to the next page of function recommendations.
\n\nThis value is null when there are no more pages of function recommendations to\n return.
" } }, "lambdaFunctionRecommendations": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionRecommendations", "traits": { "smithy.api#documentation": "An array of objects that describe function recommendations.
" } } } }, "com.amazonaws.computeoptimizer#GetRecommendationError": { "type": "structure", "members": { "identifier": { "target": "com.amazonaws.computeoptimizer#Identifier", "traits": { "smithy.api#documentation": "The ID of the error.
" } }, "code": { "target": "com.amazonaws.computeoptimizer#Code", "traits": { "smithy.api#documentation": "The error code.
" } }, "message": { "target": "com.amazonaws.computeoptimizer#Message", "traits": { "smithy.api#documentation": "The message, or reason, for the error.
" } } }, "traits": { "smithy.api#documentation": "Describes an error experienced when getting recommendations.
\nFor example, an error is returned if you request recommendations for an unsupported\n Auto Scaling group, or if you request recommendations for an instance of an unsupported instance\n family.
" } }, "com.amazonaws.computeoptimizer#GetRecommendationErrors": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#GetRecommendationError" } }, "com.amazonaws.computeoptimizer#GetRecommendationSummaries": { "type": "operation", "input": { "target": "com.amazonaws.computeoptimizer#GetRecommendationSummariesRequest" }, "output": { "target": "com.amazonaws.computeoptimizer#GetRecommendationSummariesResponse" }, "errors": [ { "target": "com.amazonaws.computeoptimizer#AccessDeniedException" }, { "target": "com.amazonaws.computeoptimizer#InternalServerException" }, { "target": "com.amazonaws.computeoptimizer#InvalidParameterValueException" }, { "target": "com.amazonaws.computeoptimizer#MissingAuthenticationToken" }, { "target": "com.amazonaws.computeoptimizer#OptInRequiredException" }, { "target": "com.amazonaws.computeoptimizer#ServiceUnavailableException" }, { "target": "com.amazonaws.computeoptimizer#ThrottlingException" } ], "traits": { "smithy.api#documentation": "Returns the optimization findings for an account.
\nIt returns the number of:
\nAmazon EC2 instances in an account that are Underprovisioned,\n Overprovisioned, or Optimized.
Auto Scaling groups in an account that are NotOptimized, or\n Optimized.
Amazon EBS volumes in an account that are NotOptimized, or\n Optimized.
Lambda functions in an account that are NotOptimized, or\n Optimized.
The ID of the AWS account for which to return recommendation\n summaries.
\n \n \n\nIf your account is the management account of an organization, use this parameter to\n specify the member account for which you want to return recommendation summaries.
\nOnly one account ID can be specified per request.
" } }, "nextToken": { "target": "com.amazonaws.computeoptimizer#NextToken", "traits": { "smithy.api#documentation": "The token to advance to the next page of recommendation summaries.
" } }, "maxResults": { "target": "com.amazonaws.computeoptimizer#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of recommendation summaries to return with a single request.
\nTo retrieve the remaining results, make another request with the returned\n NextToken value.
The token to use to advance to the next page of recommendation summaries.
\nThis value is null when there are no more pages of recommendation summaries to\n return.
" } }, "recommendationSummaries": { "target": "com.amazonaws.computeoptimizer#RecommendationSummaries", "traits": { "smithy.api#documentation": "An array of objects that summarize a recommendation.
" } } } }, "com.amazonaws.computeoptimizer#Identifier": { "type": "string" }, "com.amazonaws.computeoptimizer#IncludeMemberAccounts": { "type": "boolean" }, "com.amazonaws.computeoptimizer#InstanceArn": { "type": "string" }, "com.amazonaws.computeoptimizer#InstanceArns": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#InstanceArn" } }, "com.amazonaws.computeoptimizer#InstanceName": { "type": "string" }, "com.amazonaws.computeoptimizer#InstanceRecommendation": { "type": "structure", "members": { "instanceArn": { "target": "com.amazonaws.computeoptimizer#InstanceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the current instance.
" } }, "accountId": { "target": "com.amazonaws.computeoptimizer#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the instance.
" } }, "instanceName": { "target": "com.amazonaws.computeoptimizer#InstanceName", "traits": { "smithy.api#documentation": "The name of the current instance.
" } }, "currentInstanceType": { "target": "com.amazonaws.computeoptimizer#CurrentInstanceType", "traits": { "smithy.api#documentation": "The instance type of the current instance.
" } }, "finding": { "target": "com.amazonaws.computeoptimizer#Finding", "traits": { "smithy.api#documentation": "The finding classification of the instance.
\nFindings for instances include:
\n\n \n Underprovisioned\n —An instance is\n considered under-provisioned when at least one specification of your instance,\n such as CPU, memory, or network, does not meet the performance requirements of\n your workload. Under-provisioned instances may lead to poor application\n performance.
\n \n Overprovisioned\n —An instance is\n considered over-provisioned when at least one specification of your instance,\n such as CPU, memory, or network, can be sized down while still meeting the\n performance requirements of your workload, and no specification is\n under-provisioned. Over-provisioned instances may lead to unnecessary\n infrastructure cost.
\n \n Optimized\n —An instance\n is considered optimized when all specifications of your instance, such as CPU,\n memory, and network, meet the performance requirements of your workload and is\n not over provisioned. For optimized resources, AWS Compute Optimizer might recommend a new\n generation instance type.
The reason for the finding classification of the instance.
\nFinding reason codes for instances include:
\n\n \n CPUOverprovisioned\n — The\n instance’s CPU configuration can be sized down while still meeting the\n performance requirements of your workload. This is identified by analyzing the\n CPUUtilization metric of the current instance during the\n look-back period.
\n \n CPUUnderprovisioned\n — The\n instance’s CPU configuration doesn't meet the performance requirements of your\n workload and there is an alternative instance type that provides better CPU\n performance. This is identified by analyzing the CPUUtilization\n metric of the current instance during the look-back period.
\n \n MemoryOverprovisioned\n — The\n instance’s memory configuration can be sized down while still meeting the\n performance requirements of your workload. This is identified by analyzing the\n memory utilization metric of the current instance during the look-back\n period.
\n \n MemoryUnderprovisioned\n — The\n instance’s memory configuration doesn't meet the performance requirements of\n your workload and there is an alternative instance type that provides better\n memory performance. This is identified by analyzing the memory utilization\n metric of the current instance during the look-back period.
Memory utilization is analyzed only for resources that have the\n unified CloudWatch agent installed on them. For more information, see Enabling memory\n utilization with the Amazon CloudWatch Agent in the AWS Compute Optimizer\n User Guide. On Linux instances, Compute Optimizer analyses the\n mem_used_percent metric in the CWAgent\n namespace, or the legacy MemoryUtilization metric in the\n System/Linux namespace. On Windows instances, Compute Optimizer analyses\n the Memory % Committed Bytes In Use metric in the\n CWAgent namespace.
\n \n EBSThroughputOverprovisioned\n —\n The instance’s EBS throughput configuration can be sized down while still\n meeting the performance requirements of your workload. This is identified by\n analyzing the VolumeReadOps and VolumeWriteOps metrics\n of EBS volumes attached to the current instance during the look-back\n period.
\n \n EBSThroughputUnderprovisioned\n —\n The instance’s EBS throughput configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type that\n provides better EBS throughput performance. This is identified by analyzing the\n VolumeReadOps and VolumeWriteOps metrics of EBS\n volumes attached to the current instance during the look-back period.
\n \n EBSIOPSOverprovisioned\n — The\n instance’s EBS IOPS configuration can be sized down while still meeting the\n performance requirements of your workload. This is identified by analyzing the\n VolumeReadBytes and VolumeWriteBytes metric of EBS\n volumes attached to the current instance during the look-back period.
\n \n EBSIOPSUnderprovisioned\n — The\n instance’s EBS IOPS configuration doesn't meet the performance requirements of\n your workload and there is an alternative instance type that provides better EBS\n IOPS performance. This is identified by analyzing the\n VolumeReadBytes and VolumeWriteBytes metric of EBS\n volumes attached to the current instance during the look-back period.
\n \n NetworkBandwidthOverprovisioned\n \n — The instance’s network bandwidth configuration can be sized down while still\n meeting the performance requirements of your workload. This is identified by\n analyzing the NetworkIn and NetworkOut metrics of the\n current instance during the look-back period.
\n \n NetworkBandwidthUnderprovisioned\n \n — The instance’s network bandwidth configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type that\n provides better network bandwidth performance. This is identified by analyzing\n the NetworkIn and NetworkOut metrics of the current\n instance during the look-back period. This finding reason happens when the\n NetworkIn or NetworkOut performance of an instance\n is impacted.
\n \n NetworkPPSOverprovisioned\n — The\n instance’s network PPS (packets per second) configuration can be sized down\n while still meeting the performance requirements of your workload. This is\n identified by analyzing the NetworkPacketsIn and\n NetworkPacketsIn metrics of the current instance during the\n look-back period.
\n \n NetworkPPSUnderprovisioned\n — The\n instance’s network PPS (packets per second) configuration doesn't meet the\n performance requirements of your workload and there is an alternative instance\n type that provides better network PPS performance. This is identified by\n analyzing the NetworkPacketsIn and NetworkPacketsIn\n metrics of the current instance during the look-back period.
\n \n DiskIOPSOverprovisioned\n — The\n instance’s disk IOPS configuration can be sized down while still meeting the\n performance requirements of your workload. This is identified by analyzing the\n DiskReadOps and DiskWriteOps metrics of the\n current instance during the look-back period.
\n \n DiskIOPSUnderprovisioned\n — The\n instance’s disk IOPS configuration doesn't meet the performance requirements of\n your workload and there is an alternative instance type that provides better\n disk IOPS performance. This is identified by analyzing the\n DiskReadOps and DiskWriteOps metrics of the\n current instance during the look-back period.
\n \n DiskThroughputOverprovisioned\n —\n The instance’s disk throughput configuration can be sized down while still\n meeting the performance requirements of your workload. This is identified by\n analyzing the DiskReadBytes and DiskWriteBytes metrics\n of the current instance during the look-back period.
\n \n DiskThroughputUnderprovisioned\n —\n The instance’s disk throughput configuration doesn't meet the performance\n requirements of your workload and there is an alternative instance type that\n provides better disk throughput performance. This is identified by analyzing the\n DiskReadBytes and DiskWriteBytes metrics of the\n current instance during the look-back period.
For more information about instance metrics, see List the\n available CloudWatch metrics for your instances in the Amazon Elastic Compute Cloud\n User Guide. For more information about EBS volume metrics, see Amazon CloudWatch metrics for Amazon EBS in the Amazon Elastic Compute Cloud User\n Guide.
\nAn array of objects that describe the utilization metrics of the instance.
" } }, "lookBackPeriodInDays": { "target": "com.amazonaws.computeoptimizer#LookBackPeriodInDays", "traits": { "smithy.api#documentation": "The number of days for which utilization metrics were analyzed for the\n instance.
" } }, "recommendationOptions": { "target": "com.amazonaws.computeoptimizer#RecommendationOptions", "traits": { "smithy.api#documentation": "An array of objects that describe the recommendation options for the instance.
" } }, "recommendationSources": { "target": "com.amazonaws.computeoptimizer#RecommendationSources", "traits": { "smithy.api#documentation": "An array of objects that describe the source resource of the recommendation.
" } }, "lastRefreshTimestamp": { "target": "com.amazonaws.computeoptimizer#LastRefreshTimestamp", "traits": { "smithy.api#documentation": "The time stamp of when the instance recommendation was last refreshed.
" } } }, "traits": { "smithy.api#documentation": "Describes an Amazon EC2 instance recommendation.
" } }, "com.amazonaws.computeoptimizer#InstanceRecommendationFindingReasonCode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CPUOverprovisioned", "name": "CPU_OVER_PROVISIONED" }, { "value": "CPUUnderprovisioned", "name": "CPU_UNDER_PROVISIONED" }, { "value": "MemoryOverprovisioned", "name": "MEMORY_OVER_PROVISIONED" }, { "value": "MemoryUnderprovisioned", "name": "MEMORY_UNDER_PROVISIONED" }, { "value": "EBSThroughputOverprovisioned", "name": "EBS_THROUGHPUT_OVER_PROVISIONED" }, { "value": "EBSThroughputUnderprovisioned", "name": "EBS_THROUGHPUT_UNDER_PROVISIONED" }, { "value": "EBSIOPSOverprovisioned", "name": "EBS_IOPS_OVER_PROVISIONED" }, { "value": "EBSIOPSUnderprovisioned", "name": "EBS_IOPS_UNDER_PROVISIONED" }, { "value": "NetworkBandwidthOverprovisioned", "name": "NETWORK_BANDWIDTH_OVER_PROVISIONED" }, { "value": "NetworkBandwidthUnderprovisioned", "name": "NETWORK_BANDWIDTH_UNDER_PROVISIONED" }, { "value": "NetworkPPSOverprovisioned", "name": "NETWORK_PPS_OVER_PROVISIONED" }, { "value": "NetworkPPSUnderprovisioned", "name": "NETWORK_PPS_UNDER_PROVISIONED" }, { "value": "DiskIOPSOverprovisioned", "name": "DISK_IOPS_OVER_PROVISIONED" }, { "value": "DiskIOPSUnderprovisioned", "name": "DISK_IOPS_UNDER_PROVISIONED" }, { "value": "DiskThroughputOverprovisioned", "name": "DISK_THROUGHPUT_OVER_PROVISIONED" }, { "value": "DiskThroughputUnderprovisioned", "name": "DISK_THROUGHPUT_UNDER_PROVISIONED" } ] } }, "com.amazonaws.computeoptimizer#InstanceRecommendationFindingReasonCodes": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#InstanceRecommendationFindingReasonCode" } }, "com.amazonaws.computeoptimizer#InstanceRecommendationOption": { "type": "structure", "members": { "instanceType": { "target": "com.amazonaws.computeoptimizer#InstanceType", "traits": { "smithy.api#documentation": "The instance type of the instance recommendation.
" } }, "projectedUtilizationMetrics": { "target": "com.amazonaws.computeoptimizer#ProjectedUtilizationMetrics", "traits": { "smithy.api#documentation": "An array of objects that describe the projected utilization metrics of the instance\n recommendation option.
\n\nThe Cpu and Memory metrics are the only projected\n utilization metrics returned. Additionally, the Memory metric is\n returned only for resources that have the unified CloudWatch agent installed on them. For\n more information, see Enabling Memory\n Utilization with the CloudWatch Agent.
Describes the configuration differences between the current instance and the\n recommended instance type. You should consider the configuration differences before\n migrating your workloads from the current instance to the recommended instance type. The\n Change the instance type guide for Linux and Change the instance type\n guide for Windows provide general guidance for getting started with an\n instance migration.
\n\nPlatform differences include:
\n\n \n Hypervisor\n — The\n hypervisor of the recommended instance type is different than that of the\n current instance. For example, the recommended instance type uses a Nitro\n hypervisor and the current instance uses a Xen hypervisor. The differences that\n you should consider between these hypervisors are covered in the Nitro Hypervisor\n section of the Amazon EC2 frequently asked questions. For more information, see\n Instances built on the Nitro System in the Amazon EC2\n User Guide for Linux, or Instances built on the Nitro System in the Amazon EC2\n User Guide for Windows.
\n \n NetworkInterface\n — The network\n interface of the recommended instance type is different than that of the current\n instance. For example, the recommended instance type supports enhanced\n networking and the current instance might not. To enable enhanced networking for\n the recommended instance type, you will need to install the Elastic Network\n Adapter (ENA) driver or the Intel 82599 Virtual Function driver. For more\n information, see Networking and storage features and Enhanced networking\n on Linux in the Amazon EC2 User Guide for\n Linux, or Networking and storage features and Enhanced\n networking on Windows in the Amazon EC2 User Guide for\n Windows.
\n \n StorageInterface\n — The storage\n interface of the recommended instance type is different than that of the current\n instance. For example, the recommended instance type uses an NVMe storage\n interface and the current instance does not. To access NVMe volumes for the\n recommended instance type, you will need to install or upgrade the NVMe driver.\n For more information, see Networking and storage features and Amazon EBS and NVMe on\n Linux instances in the Amazon EC2 User Guide for\n Linux, or Networking and storage features and Amazon EBS and NVMe\n on Windows instances in the Amazon EC2 User Guide for\n Windows.
\n \n InstanceStoreAvailability\n — The recommended\n instance type does not support instance store volumes and the current instance\n does. Before migrating, you might need to back up the data on your instance\n store volumes if you want to preserve them. For more information, see How do I back up an instance store volume on my Amazon EC2 instance to\n Amazon EBS? in the AWS Premium Support Knowledge\n Base. For more information, see Networking and storage features and Amazon EC2 instance\n store in the Amazon EC2 User Guide for Linux, or see\n Networking and storage features and Amazon EC2 instance\n store in the Amazon EC2 User Guide for\n Windows.
\n \n VirtualizationType\n — The\n recommended instance type uses the hardware virtual machine (HVM) virtualization\n type and the current instance uses the paravirtual (PV) virtualization type. For\n more information about the differences between these virtualization types, see\n Linux AMI\n virtualization types in the Amazon EC2 User Guide for\n Linux, or Windows AMI virtualization types in the Amazon EC2 User\n Guide for Windows.
The performance risk of the instance recommendation option.
\nPerformance risk indicates the likelihood of the recommended instance type not meeting\n the resource needs of your workload. Compute Optimizer calculates an individual performance risk\n score for each specification of the recommended instance, including CPU, memory, EBS\n throughput, EBS IOPS, disk throughput, disk IOPS, network throughput, and network PPS.\n The performance\n risk of the recommended instance is calculated as the maximum performance risk score\n across the analyzed resource specifications.
\nThe value ranges from 0 to 5, with 0 meaning\n that the recommended resource is predicted to always provide enough hardware capability.\n The higher the performance risk is, the more likely you should validate whether the\n recommendation will meet the performance requirements of your workload before migrating\n your resource.
The rank of the instance recommendation option.
\nThe top recommendation option is ranked as 1.
Describes a recommendation option for an Amazon EC2 instance.
" } }, "com.amazonaws.computeoptimizer#InstanceRecommendations": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#InstanceRecommendation" } }, "com.amazonaws.computeoptimizer#InstanceType": { "type": "string" }, "com.amazonaws.computeoptimizer#InternalServerException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.computeoptimizer#ErrorMessage" } }, "traits": { "smithy.api#documentation": "An internal error has occurred. Try your call again.
", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.computeoptimizer#InvalidParameterValueException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.computeoptimizer#ErrorMessage" } }, "traits": { "smithy.api#documentation": "An invalid or out-of-range value was supplied for the input parameter.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.computeoptimizer#JobFilter": { "type": "structure", "members": { "name": { "target": "com.amazonaws.computeoptimizer#JobFilterName", "traits": { "smithy.api#documentation": "The name of the filter.
\n\nSpecify ResourceType to return export jobs of a specific resource type\n (e.g., Ec2Instance).
Specify JobStatus to return export jobs with a specific status (e.g,\n Complete).
The value of the filter.
\n\nThe valid values for this parameter are as follows, depending on what you specify for\n the name parameter:
Specify Ec2Instance or AutoScalingGroup if you\n specify the name parameter as ResourceType. There is\n no filter for EBS volumes because volume recommendations cannot be exported at\n this time.
Specify Queued, InProgress, Complete,\n or Failed if you specify the name parameter as\n JobStatus.
Describes a filter that returns a more specific list of recommendation export jobs.\n Use this filter with the DescribeRecommendationExportJobs action.
You can use EBSFilter with the GetEBSVolumeRecommendations\n action, LambdaFunctionRecommendationFilter with the\n GetLambdaFunctionRecommendations action, and Filter with\n the GetAutoScalingGroupRecommendations and\n GetEC2InstanceRecommendations actions.
The name of the projected utilization metric.
" } }, "statistic": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionMemoryMetricStatistic", "traits": { "smithy.api#documentation": "The statistic of the projected utilization metric.
" } }, "value": { "target": "com.amazonaws.computeoptimizer#MetricValue", "traits": { "smithy.api#documentation": "The values of the projected utilization metrics.
" } } }, "traits": { "smithy.api#documentation": "Describes a projected utilization metric of an AWS Lambda function\n recommendation option.
" } }, "com.amazonaws.computeoptimizer#LambdaFunctionMemoryProjectedMetrics": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionMemoryProjectedMetric" } }, "com.amazonaws.computeoptimizer#LambdaFunctionMemoryRecommendationOption": { "type": "structure", "members": { "rank": { "target": "com.amazonaws.computeoptimizer#Rank", "traits": { "smithy.api#documentation": "The rank of the function recommendation option.
\n\nThe top recommendation option is ranked as 1.
The memory size, in MB, of the function recommendation option.
" } }, "projectedUtilizationMetrics": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionMemoryProjectedMetrics", "traits": { "smithy.api#documentation": "An array of objects that describe the projected utilization metrics of the function\n recommendation option.
" } } }, "traits": { "smithy.api#documentation": "Describes a recommendation option for an AWS Lambda function.
" } }, "com.amazonaws.computeoptimizer#LambdaFunctionMemoryRecommendationOptions": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionMemoryRecommendationOption" } }, "com.amazonaws.computeoptimizer#LambdaFunctionMetricName": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Duration", "name": "DURATION" }, { "value": "Memory", "name": "MEMORY" } ] } }, "com.amazonaws.computeoptimizer#LambdaFunctionMetricStatistic": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Maximum", "name": "MAXIMUM" }, { "value": "Average", "name": "AVERAGE" } ] } }, "com.amazonaws.computeoptimizer#LambdaFunctionRecommendation": { "type": "structure", "members": { "functionArn": { "target": "com.amazonaws.computeoptimizer#FunctionArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the current function.
" } }, "functionVersion": { "target": "com.amazonaws.computeoptimizer#FunctionVersion", "traits": { "smithy.api#documentation": "The version number of the current function.
" } }, "accountId": { "target": "com.amazonaws.computeoptimizer#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the function.
" } }, "currentMemorySize": { "target": "com.amazonaws.computeoptimizer#MemorySize", "traits": { "smithy.api#documentation": "The amount of memory, in MB, that's allocated to the current function.
" } }, "numberOfInvocations": { "target": "com.amazonaws.computeoptimizer#NumberOfInvocations", "traits": { "smithy.api#documentation": "The number of times your function code was executed during the look-back\n period.
" } }, "utilizationMetrics": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionUtilizationMetrics", "traits": { "smithy.api#documentation": "An array of objects that describe the utilization metrics of the function.
" } }, "lookbackPeriodInDays": { "target": "com.amazonaws.computeoptimizer#LookBackPeriodInDays", "traits": { "smithy.api#documentation": "The number of days for which utilization metrics were analyzed for the\n function.
" } }, "lastRefreshTimestamp": { "target": "com.amazonaws.computeoptimizer#LastRefreshTimestamp", "traits": { "smithy.api#documentation": "The time stamp of when the function recommendation was last refreshed.
" } }, "finding": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionRecommendationFinding", "traits": { "smithy.api#documentation": "The finding classification of the function.
\nFindings for functions include:
\n\n \n Optimized\n — The function is\n correctly provisioned to run your workload based on its current configuration\n and its utilization history. This finding classification does not include\n finding reason codes.
\n \n NotOptimized\n — The function is\n performing at a higher level (over-provisioned) or at a lower level\n (under-provisioned) than required for your workload because its current\n configuration is not optimal. Over-provisioned resources might lead to\n unnecessary infrastructure cost, and under-provisioned resources might lead to\n poor application performance. This finding classification can include the\n MemoryUnderprovisioned and MemoryUnderprovisioned\n finding reason codes.
\n \n Unavailable\n — Compute Optimizer was unable to\n generate a recommendation for the function. This could be because the function\n has not accumulated sufficient metric data, or the function does not qualify for\n a recommendation. This finding classification can include the\n InsufficientData and Inconclusive finding reason\n codes.
Functions with a finding of unavailable are not returned unless you\n specify the filter parameter with a value of\n Unavailable in your\n GetLambdaFunctionRecommendations request.
The reason for the finding classification of the function.
\nFunctions that have a finding classification of Optimized don't have\n a finding reason code.
Finding reason codes for functions include:
\n\n \n MemoryOverprovisioned\n — The\n function is over-provisioned when its memory configuration can be sized down\n while still meeting the performance requirements of your workload. An\n over-provisioned function might lead to unnecessary infrastructure cost. This\n finding reason code is part of the NotOptimized finding\n classification.
\n \n MemoryUnderprovisioned\n — The\n function is under-provisioned when its memory configuration doesn't meet the\n performance requirements of the workload. An under-provisioned function might\n lead to poor application performance. This finding reason code is part of the\n NotOptimized finding classification.
\n \n InsufficientData\n — The\n function does not have sufficient metric data for Compute Optimizer to generate a\n recommendation. For more information, see the Supported resources and\n requirements in the AWS Compute Optimizer User Guide. This\n finding reason code is part of the Unavailable finding\n classification.
\n \n Inconclusive\n — The function does\n not qualify for a recommendation because Compute Optimizer cannot generate a recommendation\n with a high degree of confidence. This finding reason code is part of the\n Unavailable finding classification.
An array of objects that describe the memory configuration recommendation options for\n the function.
" } } }, "traits": { "smithy.api#documentation": "Describes an AWS Lambda function recommendation.
" } }, "com.amazonaws.computeoptimizer#LambdaFunctionRecommendationFilter": { "type": "structure", "members": { "name": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionRecommendationFilterName", "traits": { "smithy.api#documentation": "The name of the filter.
\n\nSpecify Finding to return recommendations with a specific finding\n classification (e.g., NotOptimized).
Specify FindingReasonCode to return recommendations with a specific\n finding reason code (e.g., MemoryUnderprovisioned).
The value of the filter.
\n\nThe valid values for this parameter are as follows, depending on what you specify for\n the name parameter:
Specify Optimized, NotOptimized, or\n Unavailable if you specify the name parameter as\n Finding.
Specify MemoryOverprovisioned,\n MemoryUnderprovisioned, InsufficientData, or\n Inconclusive if you specify the name parameter as\n FindingReasonCode.
Describes a filter that returns a more specific list of AWS Lambda function\n recommendations. Use this filter with the GetLambdaFunctionRecommendations\n action.
You can use EBSFilter with the GetEBSVolumeRecommendations\n action, JobFilter with the DescribeRecommendationExportJobs\n action, and Filter with the GetAutoScalingGroupRecommendations\n and GetEC2InstanceRecommendations actions.
The name of the utilization metric.
\nThe following utilization metrics are available:
\n\n Duration - The amount of time that your function code spends\n processing an event.
\n Memory - The amount of memory used per invocation.
The statistic of the utilization metric.
\n\nThe Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using\n only the Maximum statistic, which is the highest value observed during the\n specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the\n Average statistic, which is the value of Sum /\n SampleCount during the specified period. For more information, see\n Viewing resource\n recommendations in the AWS Compute Optimizer User Guide. You can\n also get averaged utilization metric data for your resources using Amazon CloudWatch. For more\n information, see the Amazon CloudWatch User\n Guide.
The value of the utilization metric.
" } } }, "traits": { "smithy.api#documentation": "Describes a utilization metric of an AWS Lambda function.
" } }, "com.amazonaws.computeoptimizer#LambdaFunctionUtilizationMetrics": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#LambdaFunctionUtilizationMetric" } }, "com.amazonaws.computeoptimizer#LastRefreshTimestamp": { "type": "timestamp" }, "com.amazonaws.computeoptimizer#LastUpdatedTimestamp": { "type": "timestamp" }, "com.amazonaws.computeoptimizer#LimitExceededException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.computeoptimizer#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The request exceeds a limit of the service.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.computeoptimizer#LookBackPeriodInDays": { "type": "double" }, "com.amazonaws.computeoptimizer#MaxResults": { "type": "integer", "traits": { "smithy.api#box": {} } }, "com.amazonaws.computeoptimizer#MaxSize": { "type": "integer" }, "com.amazonaws.computeoptimizer#MemberAccountsEnrolled": { "type": "boolean" }, "com.amazonaws.computeoptimizer#MemorySize": { "type": "integer" }, "com.amazonaws.computeoptimizer#Message": { "type": "string" }, "com.amazonaws.computeoptimizer#MetadataKey": { "type": "string" }, "com.amazonaws.computeoptimizer#MetricName": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Cpu", "name": "CPU" }, { "value": "Memory", "name": "MEMORY" }, { "value": "EBS_READ_OPS_PER_SECOND", "name": "EBS_READ_OPS_PER_SECOND" }, { "value": "EBS_WRITE_OPS_PER_SECOND", "name": "EBS_WRITE_OPS_PER_SECOND" }, { "value": "EBS_READ_BYTES_PER_SECOND", "name": "EBS_READ_BYTES_PER_SECOND" }, { "value": "EBS_WRITE_BYTES_PER_SECOND", "name": "EBS_WRITE_BYTES_PER_SECOND" }, { "value": "DISK_READ_OPS_PER_SECOND", "name": "DISK_READ_OPS_PER_SECOND" }, { "value": "DISK_WRITE_OPS_PER_SECOND", "name": "DISK_WRITE_OPS_PER_SECOND" }, { "value": "DISK_READ_BYTES_PER_SECOND", "name": "DISK_READ_BYTES_PER_SECOND" }, { "value": "DISK_WRITE_BYTES_PER_SECOND", "name": "DISK_WRITE_BYTES_PER_SECOND" }, { "value": "NETWORK_IN_BYTES_PER_SECOND", "name": "NETWORK_IN_BYTES_PER_SECOND" }, { "value": "NETWORK_OUT_BYTES_PER_SECOND", "name": "NETWORK_OUT_BYTES_PER_SECOND" }, { "value": "NETWORK_PACKETS_IN_PER_SECOND", "name": "NETWORK_PACKETS_IN_PER_SECOND" }, { "value": "NETWORK_PACKETS_OUT_PER_SECOND", "name": "NETWORK_PACKETS_OUT_PER_SECOND" } ] } }, "com.amazonaws.computeoptimizer#MetricStatistic": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Maximum", "name": "MAXIMUM" }, { "value": "Average", "name": "AVERAGE" } ] } }, "com.amazonaws.computeoptimizer#MetricValue": { "type": "double" }, "com.amazonaws.computeoptimizer#MetricValues": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#MetricValue" } }, "com.amazonaws.computeoptimizer#MinSize": { "type": "integer" }, "com.amazonaws.computeoptimizer#MissingAuthenticationToken": { "type": "structure", "members": { "message": { "target": "com.amazonaws.computeoptimizer#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The request must contain either a valid (registered) AWS access key ID or\n X.509 certificate.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.computeoptimizer#NextToken": { "type": "string" }, "com.amazonaws.computeoptimizer#NumberOfInvocations": { "type": "long" }, "com.amazonaws.computeoptimizer#OptInRequiredException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.computeoptimizer#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The account is not opted in to AWS Compute Optimizer.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.computeoptimizer#PerformanceRisk": { "type": "double", "traits": { "smithy.api#range": { "min": 0, "max": 5 } } }, "com.amazonaws.computeoptimizer#Period": { "type": "integer" }, "com.amazonaws.computeoptimizer#PlatformDifference": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Hypervisor", "name": "HYPERVISOR" }, { "value": "NetworkInterface", "name": "NETWORK_INTERFACE" }, { "value": "StorageInterface", "name": "STORAGE_INTERFACE" }, { "value": "InstanceStoreAvailability", "name": "INSTANCE_STORE_AVAILABILITY" }, { "value": "VirtualizationType", "name": "VIRTUALIZATION_TYPE" } ] } }, "com.amazonaws.computeoptimizer#PlatformDifferences": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#PlatformDifference" } }, "com.amazonaws.computeoptimizer#ProjectedMetric": { "type": "structure", "members": { "name": { "target": "com.amazonaws.computeoptimizer#MetricName", "traits": { "smithy.api#documentation": "The name of the projected utilization metric.
\nThe following projected utilization metrics are returned:
\n\n Cpu - The projected percentage of allocated EC2 compute units\n that would be in use on the recommendation option had you used that resource\n during the analyzed period. This metric identifies the processing power required\n to run an application on the recommendation option.
Depending on the instance type, tools in your operating system can show a\n lower percentage than CloudWatch when the instance is not allocated a full\n processor core.
\nUnits: Percent
\n\n Memory - The percentage of memory that would be in use on the\n recommendation option had you used that resource during the analyzed period.\n This metric identifies the amount of memory required to run an application on\n the recommendation option.
Units: Percent
\nThe Memory metric is returned only for resources that have\n the unified CloudWatch agent installed on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.
The time stamps of the projected utilization metric.
" } }, "values": { "target": "com.amazonaws.computeoptimizer#MetricValues", "traits": { "smithy.api#documentation": "The values of the projected utilization metrics.
" } } }, "traits": { "smithy.api#documentation": "Describes a projected utilization metric of a recommendation option, such as an Amazon EC2\n instance. This represents the projected utilization of a recommendation option had you\n used that resource during the analyzed period.
\n\nCompare the utilization metric data of your resource against its projected utilization\n metric data to determine the performance difference between your current resource and\n the recommended option.
\n\nThe Cpu and Memory metrics are the only projected\n utilization metrics returned when you run the\n GetEC2RecommendationProjectedMetrics action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.
The name of the finding reason code.
" } }, "value": { "target": "com.amazonaws.computeoptimizer#SummaryValue", "traits": { "smithy.api#documentation": "The value of the finding reason code summary.
" } } }, "traits": { "smithy.api#documentation": "A summary of a finding reason code.
" } }, "com.amazonaws.computeoptimizer#RecommendationExportJob": { "type": "structure", "members": { "jobId": { "target": "com.amazonaws.computeoptimizer#JobId", "traits": { "smithy.api#documentation": "The identification number of the export job.
" } }, "destination": { "target": "com.amazonaws.computeoptimizer#ExportDestination", "traits": { "smithy.api#documentation": "An object that describes the destination of the export file.
" } }, "resourceType": { "target": "com.amazonaws.computeoptimizer#ResourceType", "traits": { "smithy.api#documentation": "The resource type of the exported recommendations.
" } }, "status": { "target": "com.amazonaws.computeoptimizer#JobStatus", "traits": { "smithy.api#documentation": "The status of the export job.
" } }, "creationTimestamp": { "target": "com.amazonaws.computeoptimizer#CreationTimestamp", "traits": { "smithy.api#documentation": "The timestamp of when the export job was created.
" } }, "lastUpdatedTimestamp": { "target": "com.amazonaws.computeoptimizer#LastUpdatedTimestamp", "traits": { "smithy.api#documentation": "The timestamp of when the export job was last updated.
" } }, "failureReason": { "target": "com.amazonaws.computeoptimizer#FailureReason", "traits": { "smithy.api#documentation": "The reason for an export job failure.
" } } }, "traits": { "smithy.api#documentation": "Describes a recommendation export job.
\n\n\nUse the DescribeRecommendationExportJobs action to view your\n recommendation export jobs.
Use the ExportAutoScalingGroupRecommendations or\n ExportEC2InstanceRecommendations actions to request an export of your\n recommendations.
The Amazon Resource Name (ARN) of the recommendation source.
" } }, "recommendationSourceType": { "target": "com.amazonaws.computeoptimizer#RecommendationSourceType", "traits": { "smithy.api#documentation": "The resource type of the recommendation source.
" } } }, "traits": { "smithy.api#documentation": "Describes the source of a recommendation, such as an Amazon EC2 instance or Auto Scaling\n group.
" } }, "com.amazonaws.computeoptimizer#RecommendationSourceArn": { "type": "string" }, "com.amazonaws.computeoptimizer#RecommendationSourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Ec2Instance", "name": "EC2_INSTANCE" }, { "value": "AutoScalingGroup", "name": "AUTO_SCALING_GROUP" }, { "value": "EbsVolume", "name": "EBS_VOLUME" }, { "value": "LambdaFunction", "name": "LAMBDA_FUNCTION" } ] } }, "com.amazonaws.computeoptimizer#RecommendationSources": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#RecommendationSource" } }, "com.amazonaws.computeoptimizer#RecommendationSummaries": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#RecommendationSummary" } }, "com.amazonaws.computeoptimizer#RecommendationSummary": { "type": "structure", "members": { "summaries": { "target": "com.amazonaws.computeoptimizer#Summaries", "traits": { "smithy.api#documentation": "An array of objects that describe a recommendation summary.
" } }, "recommendationResourceType": { "target": "com.amazonaws.computeoptimizer#RecommendationSourceType", "traits": { "smithy.api#documentation": "The resource type of the recommendation.
" } }, "accountId": { "target": "com.amazonaws.computeoptimizer#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the recommendation summary.
" } } }, "traits": { "smithy.api#documentation": "A summary of a recommendation.
" } }, "com.amazonaws.computeoptimizer#RecommendedInstanceType": { "type": "string" }, "com.amazonaws.computeoptimizer#RecommendedOptionProjectedMetric": { "type": "structure", "members": { "recommendedInstanceType": { "target": "com.amazonaws.computeoptimizer#RecommendedInstanceType", "traits": { "smithy.api#documentation": "The recommended instance type.
" } }, "rank": { "target": "com.amazonaws.computeoptimizer#Rank", "traits": { "smithy.api#documentation": "The rank of the recommendation option projected metric.
\nThe top recommendation option is ranked as 1.
The projected metric rank correlates to the recommendation option rank. For example,\n the projected metric ranked as 1 is related to the recommendation option\n that is also ranked as 1 in the same response.
An array of objects that describe a projected utilization metric.
" } } }, "traits": { "smithy.api#documentation": "Describes a projected utilization metric of a recommendation option.
\n\nThe Cpu and Memory metrics are the only projected\n utilization metrics returned when you run the\n GetEC2RecommendationProjectedMetrics action. Additionally, the\n Memory metric is returned only for resources that have the unified\n CloudWatch agent installed on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.
A resource that is required for the action doesn't exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.computeoptimizer#ResourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Ec2Instance", "name": "EC2_INSTANCE" }, { "value": "AutoScalingGroup", "name": "AUTO_SCALING_GROUP" }, { "value": "EbsVolume", "name": "EBS_VOLUME" }, { "value": "LambdaFunction", "name": "LAMBDA_FUNCTION" } ] } }, "com.amazonaws.computeoptimizer#S3Destination": { "type": "structure", "members": { "bucket": { "target": "com.amazonaws.computeoptimizer#DestinationBucket", "traits": { "smithy.api#documentation": "The name of the Amazon S3 bucket used as the destination of an export file.
" } }, "key": { "target": "com.amazonaws.computeoptimizer#DestinationKey", "traits": { "smithy.api#documentation": "The Amazon S3 bucket key of an export file.
\nThe key uniquely identifies the object, or export file, in the S3 bucket.
" } }, "metadataKey": { "target": "com.amazonaws.computeoptimizer#MetadataKey", "traits": { "smithy.api#documentation": "The Amazon S3 bucket key of a metadata file.
\nThe key uniquely identifies the object, or metadata file, in the S3 bucket.
" } } }, "traits": { "smithy.api#documentation": "Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a\n recommendations export file, and its associated metadata file.
" } }, "com.amazonaws.computeoptimizer#S3DestinationConfig": { "type": "structure", "members": { "bucket": { "target": "com.amazonaws.computeoptimizer#DestinationBucket", "traits": { "smithy.api#documentation": "The name of the Amazon S3 bucket to use as the destination for an export job.
" } }, "keyPrefix": { "target": "com.amazonaws.computeoptimizer#DestinationKeyPrefix", "traits": { "smithy.api#documentation": "The Amazon S3 bucket prefix for an export job.
" } } }, "traits": { "smithy.api#documentation": "Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a\n recommendations export job.
\nYou must create the destination Amazon S3 bucket for your recommendations export before you\n create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the\n S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the\n export file to it. If you plan to specify an object prefix when you create the export\n job, you must include the object prefix in the policy that you add to the S3 bucket. For\n more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user\n guide.
" } }, "com.amazonaws.computeoptimizer#ServiceUnavailableException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.computeoptimizer#ErrorMessage" } }, "traits": { "smithy.api#documentation": "The request has failed due to a temporary failure of the server.
", "smithy.api#error": "server", "smithy.api#httpError": 503 } }, "com.amazonaws.computeoptimizer#Status": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "Active", "name": "ACTIVE" }, { "value": "Inactive", "name": "INACTIVE" }, { "value": "Pending", "name": "PENDING" }, { "value": "Failed", "name": "FAILED" } ] } }, "com.amazonaws.computeoptimizer#StatusReason": { "type": "string" }, "com.amazonaws.computeoptimizer#Summaries": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#Summary" } }, "com.amazonaws.computeoptimizer#Summary": { "type": "structure", "members": { "name": { "target": "com.amazonaws.computeoptimizer#Finding", "traits": { "smithy.api#documentation": "The finding classification of the recommendation.
" } }, "value": { "target": "com.amazonaws.computeoptimizer#SummaryValue", "traits": { "smithy.api#documentation": "The value of the recommendation summary.
" } }, "reasonCodeSummaries": { "target": "com.amazonaws.computeoptimizer#ReasonCodeSummaries", "traits": { "smithy.api#documentation": "An array of objects that summarize a finding reason code.
" } } }, "traits": { "smithy.api#documentation": "The summary of a recommendation.
" } }, "com.amazonaws.computeoptimizer#SummaryValue": { "type": "double" }, "com.amazonaws.computeoptimizer#ThrottlingException": { "type": "structure", "members": { "message": { "target": "com.amazonaws.computeoptimizer#ErrorMessage", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "The request was denied due to request throttling.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.computeoptimizer#Timestamp": { "type": "timestamp" }, "com.amazonaws.computeoptimizer#Timestamps": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#Timestamp" } }, "com.amazonaws.computeoptimizer#UpdateEnrollmentStatus": { "type": "operation", "input": { "target": "com.amazonaws.computeoptimizer#UpdateEnrollmentStatusRequest" }, "output": { "target": "com.amazonaws.computeoptimizer#UpdateEnrollmentStatusResponse" }, "errors": [ { "target": "com.amazonaws.computeoptimizer#AccessDeniedException" }, { "target": "com.amazonaws.computeoptimizer#InternalServerException" }, { "target": "com.amazonaws.computeoptimizer#InvalidParameterValueException" }, { "target": "com.amazonaws.computeoptimizer#MissingAuthenticationToken" }, { "target": "com.amazonaws.computeoptimizer#ServiceUnavailableException" }, { "target": "com.amazonaws.computeoptimizer#ThrottlingException" } ], "traits": { "smithy.api#documentation": "Updates the enrollment (opt in and opt out) status of an account to the\n AWS Compute Optimizer service.
\n \n \n\nIf the account is a management account of an organization, this action can also be used\n to enroll member accounts within the organization.
\n\nYou must have the appropriate permissions to opt in to Compute Optimizer, to view its\n recommendations, and to opt out. For more information, see Controlling access with AWS\n Identity and Access Management in the AWS Compute Optimizer User\n Guide.
\n \n \n\nWhen you opt in, Compute Optimizer automatically creates a Service-Linked Role in your\n account to access its data. For more information, see Using\n Service-Linked Roles for AWS Compute Optimizer in the AWS Compute Optimizer User\n Guide.
" } }, "com.amazonaws.computeoptimizer#UpdateEnrollmentStatusRequest": { "type": "structure", "members": { "status": { "target": "com.amazonaws.computeoptimizer#Status", "traits": { "smithy.api#documentation": "The new enrollment status of the account.
\nThe following status options are available:
\n\n Active - Opts in your account to the Compute Optimizer service. Compute Optimizer\n begins analyzing the configuration and utilization metrics of your AWS\n resources after you opt in. For more information, see Metrics\n analyzed by AWS Compute Optimizer in the AWS Compute Optimizer User\n Guide.
\n Inactive - Opts out your account from the Compute Optimizer service. Your\n account's recommendations and related metrics data will be deleted from Compute Optimizer\n after you opt out.
The Pending and Failed options cannot be used to update\n the enrollment status of an account. They are returned in the response of a request\n to update the enrollment status of an account.
Indicates whether to enroll member accounts of the organization if the account is the\n management account of an organization.
" } } } }, "com.amazonaws.computeoptimizer#UpdateEnrollmentStatusResponse": { "type": "structure", "members": { "status": { "target": "com.amazonaws.computeoptimizer#Status", "traits": { "smithy.api#documentation": "The enrollment status of the account.
" } }, "statusReason": { "target": "com.amazonaws.computeoptimizer#StatusReason", "traits": { "smithy.api#documentation": "The reason for the enrollment status of the account. For example, an account might\n show a status of Pending because member accounts of an organization require\n more time to be enrolled in the service.
The name of the utilization metric.
\nThe following utilization metrics are available:
\n\n Cpu - The percentage of allocated EC2 compute units that are\n currently in use on the instance. This metric identifies the processing power\n required to run an application on the instance.
Depending on the instance type, tools in your operating system can show a\n lower percentage than CloudWatch when the instance is not allocated a full\n processor core.
\nUnits: Percent
\n\n Memory - The percentage of memory that is currently in use on the\n instance. This metric identifies the amount of memory required to run an\n application on the instance.
Units: Percent
\nThe Memory metric is returned only for resources that have\n the unified CloudWatch agent installed on them. For more information, see Enabling Memory\n Utilization with the CloudWatch Agent.
\n EBS_READ_OPS_PER_SECOND - The completed read operations from all\n EBS volumes attached to the instance in a specified period of time.
Unit: Count
\n\n EBS_WRITE_OPS_PER_SECOND - The completed write operations to all\n EBS volumes attached to the instance in a specified period of time.
Unit: Count
\n\n EBS_READ_BYTES_PER_SECOND - The bytes read from all EBS volumes\n attached to the instance in a specified period of time.
Unit: Bytes
\n\n EBS_WRITE_BYTES_PER_SECOND - The bytes written to all EBS volumes\n attached to the instance in a specified period of time.
Unit: Bytes
\n\n DISK_READ_OPS_PER_SECOND - The completed read operations from all\n instance store volumes available to the instance in a specified period of\n time.
If there are no instance store volumes, either the value is 0 or\n the metric is not reported.
\n DISK_WRITE_OPS_PER_SECOND - The completed write operations from\n all instance store volumes available to the instance in a specified period of\n time.
If there are no instance store volumes, either the value is 0 or\n the metric is not reported.
\n DISK_READ_BYTES_PER_SECOND - The bytes read from all instance\n store volumes available to the instance. This metric is used to determine the\n volume of the data the application reads from the disk of the instance. This can\n be used to determine the speed of the application.
If there are no instance store volumes, either the value is 0 or\n the metric is not reported.
\n DISK_WRITE_BYTES_PER_SECOND - The bytes written to all instance\n store volumes available to the instance. This metric is used to determine the\n volume of the data the application writes onto the disk of the instance. This\n can be used to determine the speed of the application.
If there are no instance store volumes, either the value is 0 or\n the metric is not reported.
\n NETWORK_IN_BYTES_PER_SECOND - The number of bytes received by the\n instance on all network interfaces. This metric identifies the volume of\n incoming network traffic to a single instance.
\n NETWORK_OUT_BYTES_PER_SECOND - The number of bytes sent out by\n the instance on all network interfaces. This metric identifies the volume of\n outgoing network traffic from a single instance.
\n NETWORK_PACKETS_IN_PER_SECOND - The number of packets received by\n the instance on all network interfaces. This metric identifies the volume of\n incoming traffic in terms of the number of packets on a single instance.
\n NETWORK_PACKETS_OUT_PER_SECOND - The number of packets sent out\n by the instance on all network interfaces. This metric identifies the volume of\n outgoing traffic in terms of the number of packets on a single instance.
The statistic of the utilization metric.
\n\nThe Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using\n only the Maximum statistic, which is the highest value observed during the\n specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the\n Average statistic, which is the value of Sum /\n SampleCount during the specified period. For more information, see\n Viewing resource\n recommendations in the AWS Compute Optimizer User Guide. You can\n also get averaged utilization metric data for your resources using Amazon CloudWatch. For more\n information, see the Amazon CloudWatch User\n Guide.
The value of the utilization metric.
" } } }, "traits": { "smithy.api#documentation": "Describes a utilization metric of a resource, such as an Amazon EC2 instance.
\n\nCompare the utilization metric data of your resource against its projected utilization\n metric data to determine the performance difference between your current resource and\n the recommended option.
" } }, "com.amazonaws.computeoptimizer#UtilizationMetrics": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#UtilizationMetric" } }, "com.amazonaws.computeoptimizer#VolumeArn": { "type": "string" }, "com.amazonaws.computeoptimizer#VolumeArns": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#VolumeArn" } }, "com.amazonaws.computeoptimizer#VolumeBaselineIOPS": { "type": "integer" }, "com.amazonaws.computeoptimizer#VolumeBaselineThroughput": { "type": "integer" }, "com.amazonaws.computeoptimizer#VolumeBurstIOPS": { "type": "integer" }, "com.amazonaws.computeoptimizer#VolumeBurstThroughput": { "type": "integer" }, "com.amazonaws.computeoptimizer#VolumeConfiguration": { "type": "structure", "members": { "volumeType": { "target": "com.amazonaws.computeoptimizer#VolumeType", "traits": { "smithy.api#documentation": "The volume type.
\nThis can be gp2 for General Purpose SSD, io1 or\n io2 for Provisioned IOPS SSD, st1 for Throughput Optimized\n HDD, sc1 for Cold HDD, or standard for Magnetic\n volumes.
The size of the volume, in GiB.
" } }, "volumeBaselineIOPS": { "target": "com.amazonaws.computeoptimizer#VolumeBaselineIOPS", "traits": { "smithy.api#documentation": "The baseline IOPS of the volume.
" } }, "volumeBurstIOPS": { "target": "com.amazonaws.computeoptimizer#VolumeBurstIOPS", "traits": { "smithy.api#documentation": "The burst IOPS of the volume.
" } }, "volumeBaselineThroughput": { "target": "com.amazonaws.computeoptimizer#VolumeBaselineThroughput", "traits": { "smithy.api#documentation": "The baseline throughput of the volume.
" } }, "volumeBurstThroughput": { "target": "com.amazonaws.computeoptimizer#VolumeBurstThroughput", "traits": { "smithy.api#documentation": "The burst throughput of the volume.
" } } }, "traits": { "smithy.api#documentation": "Describes the configuration of an Amazon Elastic Block Store (Amazon EBS) volume.
" } }, "com.amazonaws.computeoptimizer#VolumeRecommendation": { "type": "structure", "members": { "volumeArn": { "target": "com.amazonaws.computeoptimizer#VolumeArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the current volume.
" } }, "accountId": { "target": "com.amazonaws.computeoptimizer#AccountId", "traits": { "smithy.api#documentation": "The AWS account ID of the volume.
" } }, "currentConfiguration": { "target": "com.amazonaws.computeoptimizer#VolumeConfiguration", "traits": { "smithy.api#documentation": "An array of objects that describe the current configuration of the volume.
" } }, "finding": { "target": "com.amazonaws.computeoptimizer#EBSFinding", "traits": { "smithy.api#documentation": "The finding classification of the volume.
\nFindings for volumes include:
\n\n \n NotOptimized\n —A volume\n is considered not optimized when AWS Compute Optimizer identifies a recommendation that can\n provide better performance for your workload.
\n \n Optimized\n —An volume is\n considered optimized when Compute Optimizer determines that the volume is correctly\n provisioned to run your workload based on the chosen volume type. For optimized\n resources, Compute Optimizer might recommend a new generation volume type.
An array of objects that describe the utilization metrics of the volume.
" } }, "lookBackPeriodInDays": { "target": "com.amazonaws.computeoptimizer#LookBackPeriodInDays", "traits": { "smithy.api#documentation": "The number of days for which utilization metrics were analyzed for the volume.
" } }, "volumeRecommendationOptions": { "target": "com.amazonaws.computeoptimizer#VolumeRecommendationOptions", "traits": { "smithy.api#documentation": "An array of objects that describe the recommendation options for the volume.
" } }, "lastRefreshTimestamp": { "target": "com.amazonaws.computeoptimizer#LastRefreshTimestamp", "traits": { "smithy.api#documentation": "The time stamp of when the volume recommendation was last refreshed.
" } } }, "traits": { "smithy.api#documentation": "Describes an Amazon Elastic Block Store (Amazon EBS) volume recommendation.
" } }, "com.amazonaws.computeoptimizer#VolumeRecommendationOption": { "type": "structure", "members": { "configuration": { "target": "com.amazonaws.computeoptimizer#VolumeConfiguration", "traits": { "smithy.api#documentation": "An array of objects that describe a volume configuration.
" } }, "performanceRisk": { "target": "com.amazonaws.computeoptimizer#PerformanceRisk", "traits": { "smithy.api#documentation": "The performance risk of the volume recommendation option.
\nPerformance risk is the likelihood of the recommended volume type meeting the\n performance requirement of your workload.
\nThe value ranges from 0 to 5, with 0 meaning\n that the recommended resource is predicted to always provide enough hardware capability.\n The higher the performance risk is, the more likely you should validate whether the\n recommendation will meet the performance requirements of your workload before migrating\n your resource.
The rank of the volume recommendation option.
\nThe top recommendation option is ranked as 1.
Describes a recommendation option for an Amazon Elastic Block Store (Amazon EBS) instance.
" } }, "com.amazonaws.computeoptimizer#VolumeRecommendationOptions": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#VolumeRecommendationOption" } }, "com.amazonaws.computeoptimizer#VolumeRecommendations": { "type": "list", "member": { "target": "com.amazonaws.computeoptimizer#VolumeRecommendation" } }, "com.amazonaws.computeoptimizer#VolumeSize": { "type": "integer" }, "com.amazonaws.computeoptimizer#VolumeType": { "type": "string" } } }