AWS Compute Optimizer is a service that analyzes the configuration and utilization metrics of your AWS compute resources, such as EC2 instances, Auto Scaling groups, AWS Lambda functions, and Amazon EBS volumes. It reports whether your resources are optimal, and generates optimization recommendations to reduce the cost and improve the performance of your workloads. Compute Optimizer also provides recent utilization metric data, as well as projected utilization metric data for the recommendations, which you can use to evaluate which recommendation provides the best price-performance trade-off. The analysis of your usage patterns can help you decide when to move or resize your running resources, and still meet your performance and capacity requirements. For more information about Compute Optimizer, including the required permissions to use the service, see the AWS Compute Optimizer User Guide.
", + "service": "Compute Optimizer is a service that analyzes the configuration and utilization metrics of your Amazon Web Services compute resources, such as Amazon EC2 instances, Amazon EC2 Auto Scaling groups, Lambda functions, and Amazon EBS volumes. It reports whether your resources are optimal, and generates optimization recommendations to reduce the cost and improve the performance of your workloads. Compute Optimizer also provides recent utilization metric data, in addition to projected utilization metric data for the recommendations, which you can use to evaluate which recommendation provides the best price-performance trade-off. The analysis of your usage patterns can help you decide when to move or resize your running resources, and still meet your performance and capacity requirements. For more information about Compute Optimizer, including the required permissions to use the service, see the Compute Optimizer User Guide.
", "operations": { - "DescribeRecommendationExportJobs": "Describes recommendation export jobs created in the last seven days.
Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs.
Exports optimization recommendations for Auto Scaling groups.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.
You can have only one Auto Scaling group export job in progress per AWS Region.
", - "ExportEBSVolumeRecommendations": "Exports optimization recommendations for Amazon EBS volumes.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.
You can have only one Amazon EBS volume export job in progress per AWS Region.
", - "ExportEC2InstanceRecommendations": "Exports optimization recommendations for Amazon EC2 instances.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.
You can have only one Amazon EC2 instance export job in progress per AWS Region.
", - "ExportLambdaFunctionRecommendations": "Exports optimization recommendations for AWS Lambda functions.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.
You can have only one Lambda function export job in progress per AWS Region.
", - "GetAutoScalingGroupRecommendations": "Returns Auto Scaling group recommendations.
AWS Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.
", - "GetEBSVolumeRecommendations": "Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
AWS Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.
", - "GetEC2InstanceRecommendations": "Returns Amazon EC2 instance recommendations.
AWS Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.
", + "DescribeRecommendationExportJobs": "Describes recommendation export jobs created in the last seven days.
Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations. Then use the DescribeRecommendationExportJobs action to view your export jobs.
", + "ExportAutoScalingGroupRecommendations": "Exports optimization recommendations for Auto Scaling groups.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.
You can have only one Auto Scaling group export job in progress per Amazon Web Services Region.
", + "ExportEBSVolumeRecommendations": "Exports optimization recommendations for Amazon EBS volumes.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.
You can have only one Amazon EBS volume export job in progress per Amazon Web Services Region.
", + "ExportEC2InstanceRecommendations": "Exports optimization recommendations for Amazon EC2 instances.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.
You can have only one Amazon EC2 instance export job in progress per Amazon Web Services Region.
", + "ExportLambdaFunctionRecommendations": "Exports optimization recommendations for Lambda functions.
Recommendations are exported in a comma-separated values (.csv) file, and its metadata in a JavaScript Object Notation (JSON) (.json) file, to an existing Amazon Simple Storage Service (Amazon S3) bucket that you specify. For more information, see Exporting Recommendations in the Compute Optimizer User Guide.
You can have only one Lambda function export job in progress per Amazon Web Services Region.
", + "GetAutoScalingGroupRecommendations": "Returns Auto Scaling group recommendations.
Compute Optimizer generates recommendations for Amazon EC2 Auto Scaling groups that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
", + "GetEBSVolumeRecommendations": "Returns Amazon Elastic Block Store (Amazon EBS) volume recommendations.
Compute Optimizer generates recommendations for Amazon EBS volumes that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
", + "GetEC2InstanceRecommendations": "Returns Amazon EC2 instance recommendations.
Compute Optimizer generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) instances that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
", "GetEC2RecommendationProjectedMetrics": "Returns the projected utilization metrics of Amazon EC2 instance recommendations.
The Cpu and Memory metrics are the only projected utilization metrics returned when you run this action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer service.
If the account is the management account of an organization, this action also confirms the enrollment status of member accounts within the organization.
", - "GetLambdaFunctionRecommendations": "Returns AWS Lambda function recommendations.
AWS Compute Optimizer generates recommendations for functions that meet a specific set of requirements. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide.
", + "GetEnrollmentStatus": "Returns the enrollment (opt in) status of an account to the Compute Optimizer service.
If the account is the management account of an organization, this action also confirms the enrollment status of member accounts of the organization. Use the GetEnrollmentStatusesForOrganization action to get detailed information about the enrollment status of member accounts of an organization.
", + "GetEnrollmentStatusesForOrganization": "Returns the Compute Optimizer enrollment (opt-in) status of organization member accounts, if your account is an organization management account.
To get the enrollment status of standalone accounts, use the GetEnrollmentStatus action.
", + "GetLambdaFunctionRecommendations": "Returns Lambda function recommendations.
Compute Optimizer generates recommendations for functions that meet a specific set of requirements. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide.
", "GetRecommendationSummaries": "Returns the optimization findings for an account.
It returns the number of:
Amazon EC2 instances in an account that are Underprovisioned, Overprovisioned, or Optimized.
Auto Scaling groups in an account that are NotOptimized, or Optimized.
Amazon EBS volumes in an account that are NotOptimized, or Optimized.
Lambda functions in an account that are NotOptimized, or Optimized.
Updates the enrollment (opt in and opt out) status of an account to the AWS Compute Optimizer service.
If the account is a management account of an organization, this action can also be used to enroll member accounts within the organization.
You must have the appropriate permissions to opt in to Compute Optimizer, to view its recommendations, and to opt out. For more information, see Controlling access with AWS Identity and Access Management in the AWS Compute Optimizer User Guide.
When you opt in, Compute Optimizer automatically creates a Service-Linked Role in your account to access its data. For more information, see Using Service-Linked Roles for AWS Compute Optimizer in the AWS Compute Optimizer User Guide.
" + "UpdateEnrollmentStatus": "Updates the enrollment (opt in and opt out) status of an account to the Compute Optimizer service.
If the account is a management account of an organization, this action can also be used to enroll member accounts of the organization.
You must have the appropriate permissions to opt in to Compute Optimizer, to view its recommendations, and to opt out. For more information, see Controlling access with Amazon Web Services Identity and Access Management in the Compute Optimizer User Guide.
When you opt in, Compute Optimizer automatically creates a service-linked role in your account to access its data. For more information, see Using Service-Linked Roles for Compute Optimizer in the Compute Optimizer User Guide.
" }, "shapes": { "AccessDeniedException": { @@ -22,29 +23,42 @@ "refs": { } }, + "AccountEnrollmentStatus": { + "base": "Describes the enrollment status of an organization's member accounts in Compute Optimizer.
", + "refs": { + "AccountEnrollmentStatuses$member": null + } + }, + "AccountEnrollmentStatuses": { + "base": null, + "refs": { + "GetEnrollmentStatusesForOrganizationResponse$accountEnrollmentStatuses": "An array of objects that describe the enrollment statuses of organization member accounts.
" + } + }, "AccountId": { "base": null, "refs": { + "AccountEnrollmentStatus$accountId": "The Amazon Web Services account ID.
", "AccountIds$member": null, - "AutoScalingGroupRecommendation$accountId": "The AWS account ID of the Auto Scaling group.
", - "InstanceRecommendation$accountId": "The AWS account ID of the instance.
", - "LambdaFunctionRecommendation$accountId": "The AWS account ID of the function.
", - "RecommendationSummary$accountId": "The AWS account ID of the recommendation summary.
", - "VolumeRecommendation$accountId": "The AWS account ID of the volume.
" + "AutoScalingGroupRecommendation$accountId": "The Amazon Web Services account ID of the Auto Scaling group.
", + "InstanceRecommendation$accountId": "The Amazon Web Services account ID of the instance.
", + "LambdaFunctionRecommendation$accountId": "The Amazon Web Services account ID of the function.
", + "RecommendationSummary$accountId": "The Amazon Web Services account ID of the recommendation summary.
", + "VolumeRecommendation$accountId": "The Amazon Web Services account ID of the volume.
" } }, "AccountIds": { "base": null, "refs": { - "ExportAutoScalingGroupRecommendationsRequest$accountIds": "The IDs of the AWS accounts for which to export Auto Scaling group recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
", - "ExportEBSVolumeRecommendationsRequest$accountIds": "The IDs of the AWS accounts for which to export Amazon EBS volume recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
", - "ExportEC2InstanceRecommendationsRequest$accountIds": "The IDs of the AWS accounts for which to export instance recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
", - "ExportLambdaFunctionRecommendationsRequest$accountIds": "The IDs of the AWS accounts for which to export Lambda function recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
", - "GetAutoScalingGroupRecommendationsRequest$accountIds": "The ID of the AWS account for which to return Auto Scaling group recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return Auto Scaling group recommendations.
Only one account ID can be specified per request.
", - "GetEBSVolumeRecommendationsRequest$accountIds": "The ID of the AWS account for which to return volume recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return volume recommendations.
Only one account ID can be specified per request.
", - "GetEC2InstanceRecommendationsRequest$accountIds": "The ID of the AWS account for which to return instance recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.
Only one account ID can be specified per request.
", - "GetLambdaFunctionRecommendationsRequest$accountIds": "The ID of the AWS account for which to return function recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return function recommendations.
Only one account ID can be specified per request.
", - "GetRecommendationSummariesRequest$accountIds": "The ID of the AWS account for which to return recommendation summaries.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return recommendation summaries.
Only one account ID can be specified per request.
" + "ExportAutoScalingGroupRecommendationsRequest$accountIds": "The IDs of the Amazon Web Services accounts for which to export Auto Scaling group recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
", + "ExportEBSVolumeRecommendationsRequest$accountIds": "The IDs of the Amazon Web Services accounts for which to export Amazon EBS volume recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
", + "ExportEC2InstanceRecommendationsRequest$accountIds": "The IDs of the Amazon Web Services accounts for which to export instance recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
", + "ExportLambdaFunctionRecommendationsRequest$accountIds": "The IDs of the Amazon Web Services accounts for which to export Lambda function recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.
This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.
You can specify multiple account IDs per request.
", + "GetAutoScalingGroupRecommendationsRequest$accountIds": "The ID of the Amazon Web Services account for which to return Auto Scaling group recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return Auto Scaling group recommendations.
Only one account ID can be specified per request.
", + "GetEBSVolumeRecommendationsRequest$accountIds": "The ID of the Amazon Web Services account for which to return volume recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return volume recommendations.
Only one account ID can be specified per request.
", + "GetEC2InstanceRecommendationsRequest$accountIds": "The ID of the Amazon Web Services account for which to return instance recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.
Only one account ID can be specified per request.
", + "GetLambdaFunctionRecommendationsRequest$accountIds": "The ID of the Amazon Web Services account for which to return function recommendations.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return function recommendations.
Only one account ID can be specified per request.
", + "GetRecommendationSummariesRequest$accountIds": "The ID of the Amazon Web Services account for which to return recommendation summaries.
If your account is the management account of an organization, use this parameter to specify the member account for which you want to return recommendation summaries.
Only one account ID can be specified per request.
" } }, "AutoScalingGroupArn": { @@ -103,6 +117,18 @@ "GetRecommendationError$code": "The error code.
" } }, + "CpuVendorArchitecture": { + "base": null, + "refs": { + "CpuVendorArchitectures$member": null + } + }, + "CpuVendorArchitectures": { + "base": null, + "refs": { + "RecommendationPreferences$cpuVendorArchitectures": "Specifies the CPU vendor and architecture for Amazon EC2 instance and Auto Scaling group recommendations.
For example, when you specify AWS_ARM64 with:
A GetEC2InstanceRecommendations or GetAutoScalingGroupRecommendations request, Compute Optimizer returns recommendations that consist of Graviton2 instance types only.
A GetEC2RecommendationProjectedMetrics request, Compute Optimizer returns projected utilization metrics for Graviton2 instance type recommendations only.
A ExportEC2InstanceRecommendations or ExportAutoScalingGroupRecommendations request, Compute Optimizer exports recommendations that consist of Graviton2 instance types only.
Describes a filter that returns a more specific list of Amazon Elastic Block Store (Amazon EBS) volume recommendations. Use this filter with the GetEBSVolumeRecommendations action.
You can use LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, JobFilter with the DescribeRecommendationExportJobs action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
Describes a filter that returns a more specific list of Amazon Elastic Block Store (Amazon EBS) volume recommendations. Use this filter with the GetEBSVolumeRecommendations action.
You can use LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, JobFilter with the DescribeRecommendationExportJobs action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
The name of the filter.
Specify Finding to return recommendations with a specific finding classification (e.g., NotOptimized).
The name of the filter.
Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized).
An array of objects that describe a filter to export a more specific set of Amazon EBS volume recommendations.
", - "GetEBSVolumeRecommendationsRequest$filters": "An array of objects that describe a filter that returns a more specific list of volume recommendations.
" + "ExportEBSVolumeRecommendationsRequest$filters": "An array of objects to specify a filter that exports a more specific set of Amazon EBS volume recommendations.
", + "GetEBSVolumeRecommendationsRequest$filters": "An array of objects to specify a filter that returns a more specific list of volume recommendations.
" } }, "EBSFinding": { "base": null, "refs": { - "VolumeRecommendation$finding": "The finding classification of the volume.
Findings for volumes include:
NotOptimized —A volume is considered not optimized when AWS Compute Optimizer identifies a recommendation that can provide better performance for your workload.
Optimized —An volume is considered optimized when Compute Optimizer determines that the volume is correctly provisioned to run your workload based on the chosen volume type. For optimized resources, Compute Optimizer might recommend a new generation volume type.
The finding classification of the volume.
Findings for volumes include:
NotOptimized —A volume is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload.
Optimized —An volume is considered optimized when Compute Optimizer determines that the volume is correctly provisioned to run your workload based on the chosen volume type. For optimized resources, Compute Optimizer might recommend a new generation volume type.
An array of objects that describe the utilization metrics of the volume.
" } }, + "EnrollmentFilter": { + "base": "Describes a filter that returns a more specific list of account enrollment statuses. Use this filter with the GetEnrollmentStatusesForOrganization action.
", + "refs": { + "EnrollmentFilters$member": null + } + }, + "EnrollmentFilterName": { + "base": null, + "refs": { + "EnrollmentFilter$name": "The name of the filter.
Specify Status to return accounts with a specific enrollment status (for example, Active).
An array of objects to specify a filter that returns a more specific list of account enrollment statuses.
" + } + }, "ErrorMessage": { "base": null, "refs": { @@ -317,7 +361,7 @@ } }, "Filter": { - "base": "Describes a filter that returns a more specific list of recommendations. Use this filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
You can use EBSFilter with the GetEBSVolumeRecommendations action, LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and JobFilter with the DescribeRecommendationExportJobs action.
Describes a filter that returns a more specific list of recommendations. Use this filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
You can use EBSFilter with the GetEBSVolumeRecommendations action, LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and JobFilter with the DescribeRecommendationExportJobs action.
The name of the filter.
Specify Finding to return recommendations with a specific finding classification (e.g., Underprovisioned).
Specify RecommendationSourceType to return recommendations of a specific resource type (e.g., Ec2Instance).
Specify FindingReasonCodes to return recommendations with a specific finding reason code (e.g., CPUUnderprovisioned).
The name of the filter.
Specify Finding to return recommendations with a specific finding classification (for example, Underprovisioned).
Specify RecommendationSourceType to return recommendations of a specific resource type (for example, Ec2Instance).
Specify FindingReasonCodes to return recommendations with a specific finding reason code (for example, CPUUnderprovisioned).
The value of the filter.
The valid values are Optimized, or NotOptimized.
The value of the filter.
The valid values are Active, Inactive, Pending, and Failed.
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name parameter and the resource type that you wish to filter results for:
Specify Optimized or NotOptimized if you specify the name parameter as Finding and you want to filter results for Auto Scaling groups.
Specify Underprovisioned, Overprovisioned, or Optimized if you specify the name parameter as Finding and you want to filter results for EC2 instances.
Specify Ec2Instance or AutoScalingGroup if you specify the name parameter as RecommendationSourceType.
Specify one of the following options if you specify the name parameter as FindingReasonCodes:
CPUOverprovisioned — The instance’s CPU configuration can be sized down while still meeting the performance requirements of your workload.
CPUUnderprovisioned — The instance’s CPU configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better CPU performance.
MemoryOverprovisioned — The instance’s memory configuration can be sized down while still meeting the performance requirements of your workload.
MemoryUnderprovisioned — The instance’s memory configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better memory performance.
EBSThroughputOverprovisioned — The instance’s EBS throughput configuration can be sized down while still meeting the performance requirements of your workload.
EBSThroughputUnderprovisioned — The instance’s EBS throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance.
EBSIOPSOverprovisioned — The instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload.
EBSIOPSUnderprovisioned — The instance’s EBS IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS performance.
NetworkBandwidthOverprovisioned — The instance’s network bandwidth configuration can be sized down while still meeting the performance requirements of your workload.
NetworkBandwidthUnderprovisioned — The instance’s network bandwidth configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network bandwidth performance. This finding reason happens when the NetworkIn or NetworkOut performance of an instance is impacted.
NetworkPPSOverprovisioned — The instance’s network PPS (packets per second) configuration can be sized down while still meeting the performance requirements of your workload.
NetworkPPSUnderprovisioned — The instance’s network PPS (packets per second) configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network PPS performance.
DiskIOPSOverprovisioned — The instance’s disk IOPS configuration can be sized down while still meeting the performance requirements of your workload.
DiskIOPSUnderprovisioned — The instance’s disk IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk IOPS performance.
DiskThroughputOverprovisioned — The instance’s disk throughput configuration can be sized down while still meeting the performance requirements of your workload.
DiskThroughputUnderprovisioned — The instance’s disk throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk throughput performance.
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name parameter:
Specify Ec2Instance or AutoScalingGroup if you specify the name parameter as ResourceType. There is no filter for EBS volumes because volume recommendations cannot be exported at this time.
Specify Queued, InProgress, Complete, or Failed if you specify the name parameter as JobStatus.
The value of the filter.
The valid values for this parameter are as follows, depending on what you specify for the name parameter:
Specify Optimized, NotOptimized, or Unavailable if you specify the name parameter as Finding.
Specify MemoryOverprovisioned, MemoryUnderprovisioned, InsufficientData, or Inconclusive if you specify the name parameter as FindingReasonCode.
An array of objects that describe a filter to export a more specific set of Auto Scaling group recommendations.
", - "ExportEC2InstanceRecommendationsRequest$filters": "An array of objects that describe a filter to export a more specific set of instance recommendations.
", - "GetAutoScalingGroupRecommendationsRequest$filters": "An array of objects that describe a filter that returns a more specific list of Auto Scaling group recommendations.
", - "GetEC2InstanceRecommendationsRequest$filters": "An array of objects that describe a filter that returns a more specific list of instance recommendations.
" + "ExportAutoScalingGroupRecommendationsRequest$filters": "An array of objects to specify a filter that exports a more specific set of Auto Scaling group recommendations.
", + "ExportEC2InstanceRecommendationsRequest$filters": "An array of objects to specify a filter that exports a more specific set of instance recommendations.
", + "GetAutoScalingGroupRecommendationsRequest$filters": "An array of objects to specify a filter that returns a more specific list of Auto Scaling group recommendations.
", + "GetEC2InstanceRecommendationsRequest$filters": "An array of objects to specify a filter that returns a more specific list of instance recommendations.
" } }, "Finding": { "base": null, "refs": { - "AutoScalingGroupRecommendation$finding": "The finding classification of the Auto Scaling group.
Findings for Auto Scaling groups include:
NotOptimized —An Auto Scaling group is considered not optimized when AWS Compute Optimizer identifies a recommendation that can provide better performance for your workload.
Optimized —An Auto Scaling group is considered optimized when Compute Optimizer determines that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized resources, Compute Optimizer might recommend a new generation instance type.
The finding classification of the instance.
Findings for instances include:
Underprovisioned —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance.
Overprovisioned —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost.
Optimized —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. For optimized resources, AWS Compute Optimizer might recommend a new generation instance type.
The finding classification of the Auto Scaling group.
Findings for Auto Scaling groups include:
NotOptimized —An Auto Scaling group is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload.
Optimized —An Auto Scaling group is considered optimized when Compute Optimizer determines that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized resources, Compute Optimizer might recommend a new generation instance type.
The finding classification of the instance.
Findings for instances include:
Underprovisioned —An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance.
Overprovisioned —An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost.
Optimized —An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. For optimized resources, Compute Optimizer might recommend a new generation instance type.
The finding classification of the recommendation.
" } }, @@ -376,7 +421,7 @@ "FunctionArns": { "base": null, "refs": { - "GetLambdaFunctionRecommendationsRequest$functionArns": "The Amazon Resource Name (ARN) of the functions for which to return recommendations.
You can specify a qualified or unqualified ARN. If you specify an unqualified ARN without a function version suffix, Compute Optimizer will return recommendations for the latest ($LATEST) version of the function. If you specify a qualified ARN with a version suffix, Compute Optimizer will return recommendations for the specified function version. For more information about using function versions, see Using versions in the AWS Lambda Developer Guide.
The Amazon Resource Name (ARN) of the functions for which to return recommendations.
You can specify a qualified or unqualified ARN. If you specify an unqualified ARN without a function version suffix, Compute Optimizer will return recommendations for the latest ($LATEST) version of the function. If you specify a qualified ARN with a version suffix, Compute Optimizer will return recommendations for the specified function version. For more information about using function versions, see Using versions in the Lambda Developer Guide.
Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and AWS Organizations trusted access in the AWS Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
", - "ExportEBSVolumeRecommendationsRequest$includeMemberAccounts": "Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and AWS Organizations trusted access in the AWS Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
", - "ExportEC2InstanceRecommendationsRequest$includeMemberAccounts": "Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and AWS Organizations trusted access in the AWS Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
", - "ExportLambdaFunctionRecommendationsRequest$includeMemberAccounts": "Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and AWS Organizations trusted access in the AWS Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
", + "ExportAutoScalingGroupRecommendationsRequest$includeMemberAccounts": "Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
", + "ExportEBSVolumeRecommendationsRequest$includeMemberAccounts": "Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
", + "ExportEC2InstanceRecommendationsRequest$includeMemberAccounts": "Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
", + "ExportLambdaFunctionRecommendationsRequest$includeMemberAccounts": "Indicates whether to include recommendations for resources in all member accounts of the organization if your account is the management account of an organization.
The member accounts must also be opted in to Compute Optimizer, and trusted access for Compute Optimizer must be enabled in the organization account. For more information, see Compute Optimizer and Amazon Web Services Organizations trusted access in the Compute Optimizer User Guide.
Recommendations for member accounts of the organization are not included in the export file if this parameter is omitted.
This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.
Recommendations for member accounts are not included in the export if this parameter, or the account IDs parameter, is omitted.
", "UpdateEnrollmentStatusRequest$includeMemberAccounts": "Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.
" } }, @@ -520,7 +575,7 @@ "InstanceRecommendationFindingReasonCodes": { "base": null, "refs": { - "InstanceRecommendation$findingReasonCodes": "The reason for the finding classification of the instance.
Finding reason codes for instances include:
CPUOverprovisioned — The instance’s CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the CPUUtilization metric of the current instance during the look-back period.
CPUUnderprovisioned — The instance’s CPU configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better CPU performance. This is identified by analyzing the CPUUtilization metric of the current instance during the look-back period.
MemoryOverprovisioned — The instance’s memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the memory utilization metric of the current instance during the look-back period.
MemoryUnderprovisioned — The instance’s memory configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better memory performance. This is identified by analyzing the memory utilization metric of the current instance during the look-back period.
Memory utilization is analyzed only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling memory utilization with the Amazon CloudWatch Agent in the AWS Compute Optimizer User Guide. On Linux instances, Compute Optimizer analyses the mem_used_percent metric in the CWAgent namespace, or the legacy MemoryUtilization metric in the System/Linux namespace. On Windows instances, Compute Optimizer analyses the Memory % Committed Bytes In Use metric in the CWAgent namespace.
EBSThroughputOverprovisioned — The instance’s EBS throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadOps and VolumeWriteOps metrics of EBS volumes attached to the current instance during the look-back period.
EBSThroughputUnderprovisioned — The instance’s EBS throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance. This is identified by analyzing the VolumeReadOps and VolumeWriteOps metrics of EBS volumes attached to the current instance during the look-back period.
EBSIOPSOverprovisioned — The instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metric of EBS volumes attached to the current instance during the look-back period.
EBSIOPSUnderprovisioned — The instance’s EBS IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS performance. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metric of EBS volumes attached to the current instance during the look-back period.
NetworkBandwidthOverprovisioned — The instance’s network bandwidth configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkIn and NetworkOut metrics of the current instance during the look-back period.
NetworkBandwidthUnderprovisioned — The instance’s network bandwidth configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network bandwidth performance. This is identified by analyzing the NetworkIn and NetworkOut metrics of the current instance during the look-back period. This finding reason happens when the NetworkIn or NetworkOut performance of an instance is impacted.
NetworkPPSOverprovisioned — The instance’s network PPS (packets per second) configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkPacketsIn and NetworkPacketsIn metrics of the current instance during the look-back period.
NetworkPPSUnderprovisioned — The instance’s network PPS (packets per second) configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network PPS performance. This is identified by analyzing the NetworkPacketsIn and NetworkPacketsIn metrics of the current instance during the look-back period.
DiskIOPSOverprovisioned — The instance’s disk IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the current instance during the look-back period.
DiskIOPSUnderprovisioned — The instance’s disk IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk IOPS performance. This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the current instance during the look-back period.
DiskThroughputOverprovisioned — The instance’s disk throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back period.
DiskThroughputUnderprovisioned — The instance’s disk throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk throughput performance. This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back period.
For more information about instance metrics, see List the available CloudWatch metrics for your instances in the Amazon Elastic Compute Cloud User Guide. For more information about EBS volume metrics, see Amazon CloudWatch metrics for Amazon EBS in the Amazon Elastic Compute Cloud User Guide.
The reason for the finding classification of the instance.
Finding reason codes for instances include:
CPUOverprovisioned — The instance’s CPU configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the CPUUtilization metric of the current instance during the look-back period.
CPUUnderprovisioned — The instance’s CPU configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better CPU performance. This is identified by analyzing the CPUUtilization metric of the current instance during the look-back period.
MemoryOverprovisioned — The instance’s memory configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the memory utilization metric of the current instance during the look-back period.
MemoryUnderprovisioned — The instance’s memory configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better memory performance. This is identified by analyzing the memory utilization metric of the current instance during the look-back period.
Memory utilization is analyzed only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling memory utilization with the Amazon CloudWatch Agent in the Compute Optimizer User Guide. On Linux instances, Compute Optimizer analyses the mem_used_percent metric in the CWAgent namespace, or the legacy MemoryUtilization metric in the System/Linux namespace. On Windows instances, Compute Optimizer analyses the Memory % Committed Bytes In Use metric in the CWAgent namespace.
EBSThroughputOverprovisioned — The instance’s EBS throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadOps and VolumeWriteOps metrics of EBS volumes attached to the current instance during the look-back period.
EBSThroughputUnderprovisioned — The instance’s EBS throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS throughput performance. This is identified by analyzing the VolumeReadOps and VolumeWriteOps metrics of EBS volumes attached to the current instance during the look-back period.
EBSIOPSOverprovisioned — The instance’s EBS IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metric of EBS volumes attached to the current instance during the look-back period.
EBSIOPSUnderprovisioned — The instance’s EBS IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better EBS IOPS performance. This is identified by analyzing the VolumeReadBytes and VolumeWriteBytes metric of EBS volumes attached to the current instance during the look-back period.
NetworkBandwidthOverprovisioned — The instance’s network bandwidth configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkIn and NetworkOut metrics of the current instance during the look-back period.
NetworkBandwidthUnderprovisioned — The instance’s network bandwidth configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network bandwidth performance. This is identified by analyzing the NetworkIn and NetworkOut metrics of the current instance during the look-back period. This finding reason happens when the NetworkIn or NetworkOut performance of an instance is impacted.
NetworkPPSOverprovisioned — The instance’s network PPS (packets per second) configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the NetworkPacketsIn and NetworkPacketsIn metrics of the current instance during the look-back period.
NetworkPPSUnderprovisioned — The instance’s network PPS (packets per second) configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better network PPS performance. This is identified by analyzing the NetworkPacketsIn and NetworkPacketsIn metrics of the current instance during the look-back period.
DiskIOPSOverprovisioned — The instance’s disk IOPS configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the current instance during the look-back period.
DiskIOPSUnderprovisioned — The instance’s disk IOPS configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk IOPS performance. This is identified by analyzing the DiskReadOps and DiskWriteOps metrics of the current instance during the look-back period.
DiskThroughputOverprovisioned — The instance’s disk throughput configuration can be sized down while still meeting the performance requirements of your workload. This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back period.
DiskThroughputUnderprovisioned — The instance’s disk throughput configuration doesn't meet the performance requirements of your workload and there is an alternative instance type that provides better disk throughput performance. This is identified by analyzing the DiskReadBytes and DiskWriteBytes metrics of the current instance during the look-back period.
For more information about instance metrics, see List the available CloudWatch metrics for your instances in the Amazon Elastic Compute Cloud User Guide. For more information about EBS volume metrics, see Amazon CloudWatch metrics for Amazon EBS in the Amazon Elastic Compute Cloud User Guide.
An invalid or out-of-range value was supplied for the input parameter.
", + "base": "The value supplied for the input parameter is out of range or not valid.
", "refs": { } }, "JobFilter": { - "base": "Describes a filter that returns a more specific list of recommendation export jobs. Use this filter with the DescribeRecommendationExportJobs action.
You can use EBSFilter with the GetEBSVolumeRecommendations action, LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
Describes a filter that returns a more specific list of recommendation export jobs. Use this filter with the DescribeRecommendationExportJobs action.
You can use EBSFilter with the GetEBSVolumeRecommendations action, LambdaFunctionRecommendationFilter with the GetLambdaFunctionRecommendations action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
The name of the filter.
Specify ResourceType to return export jobs of a specific resource type (e.g., Ec2Instance).
Specify JobStatus to return export jobs with a specific status (e.g, Complete).
The name of the filter.
Specify ResourceType to return export jobs of a specific resource type (for example, Ec2Instance).
Specify JobStatus to return export jobs with a specific status (e.g, Complete).
An array of objects that describe a filter to return a more specific list of export jobs.
" + "DescribeRecommendationExportJobsRequest$filters": "An array of objects to specify a filter that returns a more specific list of export jobs.
" } }, "JobId": { "base": null, "refs": { - "ExportAutoScalingGroupRecommendationsResponse$jobId": "The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
", + "ExportEBSVolumeRecommendationsResponse$jobId": "The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
", + "ExportEC2InstanceRecommendationsResponse$jobId": "The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
", + "ExportLambdaFunctionRecommendationsResponse$jobId": "The identification number of the export job.
Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.
", "JobIds$member": null, "RecommendationExportJob$jobId": "The identification number of the export job.
" } @@ -584,7 +639,7 @@ "JobIds": { "base": null, "refs": { - "DescribeRecommendationExportJobsRequest$jobIds": "The identification numbers of the export jobs to return.
An export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions.
All export jobs created in the last seven days are returned if this parameter is omitted.
" + "DescribeRecommendationExportJobsRequest$jobIds": "The identification numbers of the export jobs to return.
An export job ID is returned when you create an export using the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions.
All export jobs created in the last seven days are returned if this parameter is omitted.
" } }, "JobStatus": { @@ -606,7 +661,7 @@ } }, "LambdaFunctionMemoryProjectedMetric": { - "base": "Describes a projected utilization metric of an AWS Lambda function recommendation option.
", + "base": "Describes a projected utilization metric of an Lambda function recommendation option.
", "refs": { "LambdaFunctionMemoryProjectedMetrics$member": null } @@ -618,7 +673,7 @@ } }, "LambdaFunctionMemoryRecommendationOption": { - "base": "Describes a recommendation option for an AWS Lambda function.
", + "base": "Describes a recommendation option for an Lambda function.
", "refs": { "LambdaFunctionMemoryRecommendationOptions$member": null } @@ -638,17 +693,17 @@ "LambdaFunctionMetricStatistic": { "base": null, "refs": { - "LambdaFunctionUtilizationMetric$statistic": "The statistic of the utilization metric.
The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the AWS Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.
The statistic of the utilization metric.
The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.
Describes an AWS Lambda function recommendation.
", + "base": "Describes an Lambda function recommendation.
", "refs": { "LambdaFunctionRecommendations$member": null } }, "LambdaFunctionRecommendationFilter": { - "base": "Describes a filter that returns a more specific list of AWS Lambda function recommendations. Use this filter with the GetLambdaFunctionRecommendations action.
You can use EBSFilter with the GetEBSVolumeRecommendations action, JobFilter with the DescribeRecommendationExportJobs action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
Describes a filter that returns a more specific list of Lambda function recommendations. Use this filter with the GetLambdaFunctionRecommendations action.
You can use EBSFilter with the GetEBSVolumeRecommendations action, JobFilter with the DescribeRecommendationExportJobs action, and Filter with the GetAutoScalingGroupRecommendations and GetEC2InstanceRecommendations actions.
The name of the filter.
Specify Finding to return recommendations with a specific finding classification (e.g., NotOptimized).
Specify FindingReasonCode to return recommendations with a specific finding reason code (e.g., MemoryUnderprovisioned).
The name of the filter.
Specify Finding to return recommendations with a specific finding classification (for example, NotOptimized).
Specify FindingReasonCode to return recommendations with a specific finding reason code (for example, MemoryUnderprovisioned).
An array of objects that describe a filter to export a more specific set of Lambda function recommendations.
", - "GetLambdaFunctionRecommendationsRequest$filters": "An array of objects that describe a filter that returns a more specific list of function recommendations.
" + "ExportLambdaFunctionRecommendationsRequest$filters": "An array of objects to specify a filter that exports a more specific set of Lambda function recommendations.
", + "GetLambdaFunctionRecommendationsRequest$filters": "An array of objects to specify a filter that returns a more specific list of function recommendations.
" } }, "LambdaFunctionRecommendationFinding": { @@ -681,7 +736,7 @@ "LambdaFunctionRecommendationFindingReasonCodes": { "base": null, "refs": { - "LambdaFunctionRecommendation$findingReasonCodes": "The reason for the finding classification of the function.
Functions that have a finding classification of Optimized don't have a finding reason code.
Finding reason codes for functions include:
MemoryOverprovisioned — The function is over-provisioned when its memory configuration can be sized down while still meeting the performance requirements of your workload. An over-provisioned function might lead to unnecessary infrastructure cost. This finding reason code is part of the NotOptimized finding classification.
MemoryUnderprovisioned — The function is under-provisioned when its memory configuration doesn't meet the performance requirements of the workload. An under-provisioned function might lead to poor application performance. This finding reason code is part of the NotOptimized finding classification.
InsufficientData — The function does not have sufficient metric data for Compute Optimizer to generate a recommendation. For more information, see the Supported resources and requirements in the AWS Compute Optimizer User Guide. This finding reason code is part of the Unavailable finding classification.
Inconclusive — The function does not qualify for a recommendation because Compute Optimizer cannot generate a recommendation with a high degree of confidence. This finding reason code is part of the Unavailable finding classification.
The reason for the finding classification of the function.
Functions that have a finding classification of Optimized don't have a finding reason code.
Finding reason codes for functions include:
MemoryOverprovisioned — The function is over-provisioned when its memory configuration can be sized down while still meeting the performance requirements of your workload. An over-provisioned function might lead to unnecessary infrastructure cost. This finding reason code is part of the NotOptimized finding classification.
MemoryUnderprovisioned — The function is under-provisioned when its memory configuration doesn't meet the performance requirements of the workload. An under-provisioned function might lead to poor application performance. This finding reason code is part of the NotOptimized finding classification.
InsufficientData — The function does not have sufficient metric data for Compute Optimizer to generate a recommendation. For more information, see the Supported resources and requirements in the Compute Optimizer User Guide. This finding reason code is part of the Unavailable finding classification.
Inconclusive — The function does not qualify for a recommendation because Compute Optimizer cannot generate a recommendation with a high degree of confidence. This finding reason code is part of the Unavailable finding classification.
Describes a utilization metric of an AWS Lambda function.
", + "base": "Describes a utilization metric of an Lambda function.
", "refs": { "LambdaFunctionUtilizationMetrics$member": null } @@ -705,15 +760,17 @@ "LastRefreshTimestamp": { "base": null, "refs": { - "AutoScalingGroupRecommendation$lastRefreshTimestamp": "The time stamp of when the Auto Scaling group recommendation was last refreshed.
", - "InstanceRecommendation$lastRefreshTimestamp": "The time stamp of when the instance recommendation was last refreshed.
", - "LambdaFunctionRecommendation$lastRefreshTimestamp": "The time stamp of when the function recommendation was last refreshed.
", - "VolumeRecommendation$lastRefreshTimestamp": "The time stamp of when the volume recommendation was last refreshed.
" + "AutoScalingGroupRecommendation$lastRefreshTimestamp": "The timestamp of when the Auto Scaling group recommendation was last refreshed.
", + "InstanceRecommendation$lastRefreshTimestamp": "The timestamp of when the instance recommendation was last refreshed.
", + "LambdaFunctionRecommendation$lastRefreshTimestamp": "The timestamp of when the function recommendation was last refreshed.
", + "VolumeRecommendation$lastRefreshTimestamp": "The timestamp of when the volume recommendation was last refreshed.
" } }, "LastUpdatedTimestamp": { "base": null, "refs": { + "AccountEnrollmentStatus$lastUpdatedTimestamp": "The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.
", + "GetEnrollmentStatusResponse$lastUpdatedTimestamp": "The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.
", "RecommendationExportJob$lastUpdatedTimestamp": "The timestamp of when the export job was last updated.
" } }, @@ -734,12 +791,13 @@ "MaxResults": { "base": null, "refs": { - "DescribeRecommendationExportJobsRequest$maxResults": "The maximum number of export jobs to return with a single request.
To retrieve the remaining results, make another request with the returned NextToken value.
The maximum number of Auto Scaling group recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned NextToken value.
The maximum number of volume recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned NextToken value.
The maximum number of instance recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned NextToken value.
The maximum number of function recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned NextToken value.
The maximum number of recommendation summaries to return with a single request.
To retrieve the remaining results, make another request with the returned NextToken value.
The maximum number of export jobs to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
The maximum number of Auto Scaling group recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
The maximum number of volume recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
The maximum number of instance recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
The maximum number of account enrollment statuses to return with a single request. You can specify up to 100 statuses to return with each request.
To retrieve the remaining results, make another request with the returned nextToken value.
The maximum number of function recommendations to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
The maximum number of recommendation summaries to return with a single request.
To retrieve the remaining results, make another request with the returned nextToken value.
Confirms the enrollment status of member accounts within the organization, if the account is a management account of an organization.
" + "GetEnrollmentStatusResponse$memberAccountsEnrolled": "Confirms the enrollment status of member accounts of the organization, if the account is a management account of an organization.
" } }, "MemorySize": { @@ -783,9 +841,9 @@ "MetricStatistic": { "base": null, "refs": { - "EBSUtilizationMetric$statistic": "The statistic of the utilization metric.
The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the AWS Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.
The statistic of the utilization metric.
The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.
The statistic of the projected metrics.
", - "UtilizationMetric$statistic": "The statistic of the utilization metric.
The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the AWS Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.
The statistic of the utilization metric.
The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.
The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.
The request must contain either a valid (registered) AWS access key ID or X.509 certificate.
", + "base": "The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.
", "refs": { } }, @@ -826,6 +884,8 @@ "GetEBSVolumeRecommendationsResponse$nextToken": "The token to use to advance to the next page of volume recommendations.
This value is null when there are no more pages of volume recommendations to return.
", "GetEC2InstanceRecommendationsRequest$nextToken": "The token to advance to the next page of instance recommendations.
", "GetEC2InstanceRecommendationsResponse$nextToken": "The token to use to advance to the next page of instance recommendations.
This value is null when there are no more pages of instance recommendations to return.
", + "GetEnrollmentStatusesForOrganizationRequest$nextToken": "The token to advance to the next page of account enrollment statuses.
", + "GetEnrollmentStatusesForOrganizationResponse$nextToken": "The token to use to advance to the next page of account enrollment statuses.
This value is null when there are no more pages of account enrollment statuses to return.
", "GetLambdaFunctionRecommendationsRequest$nextToken": "The token to advance to the next page of function recommendations.
", "GetLambdaFunctionRecommendationsResponse$nextToken": "The token to use to advance to the next page of function recommendations.
This value is null when there are no more pages of function recommendations to return.
", "GetRecommendationSummariesRequest$nextToken": "The token to advance to the next page of recommendation summaries.
", @@ -835,11 +895,17 @@ "NumberOfInvocations": { "base": null, "refs": { - "LambdaFunctionRecommendation$numberOfInvocations": "The number of times your function code was executed during the look-back period.
" + "LambdaFunctionRecommendation$numberOfInvocations": "The number of times your function code was applied during the look-back period.
" + } + }, + "NumberOfMemberAccountsOptedIn": { + "base": null, + "refs": { + "GetEnrollmentStatusResponse$numberOfMemberAccountsOptedIn": "The count of organization member accounts that are opted in to the service, if your account is an organization management account.
" } }, "OptInRequiredException": { - "base": "The account is not opted in to AWS Compute Optimizer.
", + "base": "The account is not opted in to Compute Optimizer.
", "refs": { } }, @@ -866,11 +932,11 @@ "PlatformDifferences": { "base": null, "refs": { - "InstanceRecommendationOption$platformDifferences": "Describes the configuration differences between the current instance and the recommended instance type. You should consider the configuration differences before migrating your workloads from the current instance to the recommended instance type. The Change the instance type guide for Linux and Change the instance type guide for Windows provide general guidance for getting started with an instance migration.
Platform differences include:
Hypervisor — The hypervisor of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses a Nitro hypervisor and the current instance uses a Xen hypervisor. The differences that you should consider between these hypervisors are covered in the Nitro Hypervisor section of the Amazon EC2 frequently asked questions. For more information, see Instances built on the Nitro System in the Amazon EC2 User Guide for Linux, or Instances built on the Nitro System in the Amazon EC2 User Guide for Windows.
NetworkInterface — The network interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type supports enhanced networking and the current instance might not. To enable enhanced networking for the recommended instance type, you will need to install the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual Function driver. For more information, see Networking and storage features and Enhanced networking on Linux in the Amazon EC2 User Guide for Linux, or Networking and storage features and Enhanced networking on Windows in the Amazon EC2 User Guide for Windows.
StorageInterface — The storage interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses an NVMe storage interface and the current instance does not. To access NVMe volumes for the recommended instance type, you will need to install or upgrade the NVMe driver. For more information, see Networking and storage features and Amazon EBS and NVMe on Linux instances in the Amazon EC2 User Guide for Linux, or Networking and storage features and Amazon EBS and NVMe on Windows instances in the Amazon EC2 User Guide for Windows.
InstanceStoreAvailability — The recommended instance type does not support instance store volumes and the current instance does. Before migrating, you might need to back up the data on your instance 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 Amazon EBS? in the AWS Premium Support Knowledge Base. For more information, see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Linux, or see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Windows.
VirtualizationType — The recommended instance type uses the hardware virtual machine (HVM) virtualization type and the current instance uses the paravirtual (PV) virtualization type. For more information about the differences between these virtualization types, see Linux AMI virtualization types in the Amazon EC2 User Guide for Linux, or Windows AMI virtualization types in the Amazon EC2 User Guide for Windows.
Describes the configuration differences between the current instance and the recommended instance type. You should consider the configuration differences before migrating your workloads from the current instance to the recommended instance type. The Change the instance type guide for Linux and Change the instance type guide for Windows provide general guidance for getting started with an instance migration.
Platform differences include:
Hypervisor — The hypervisor of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses a Nitro hypervisor and the current instance uses a Xen hypervisor. The differences that you should consider between these hypervisors are covered in the Nitro Hypervisor section of the Amazon EC2 frequently asked questions. For more information, see Instances built on the Nitro System in the Amazon EC2 User Guide for Linux, or Instances built on the Nitro System in the Amazon EC2 User Guide for Windows.
NetworkInterface — The network interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type supports enhanced networking and the current instance might not. To enable enhanced networking for the recommended instance type, you must install the Elastic Network Adapter (ENA) driver or the Intel 82599 Virtual Function driver. For more information, see Networking and storage features and Enhanced networking on Linux in the Amazon EC2 User Guide for Linux, or Networking and storage features and Enhanced networking on Windows in the Amazon EC2 User Guide for Windows.
StorageInterface — The storage interface of the recommended instance type is different than that of the current instance. For example, the recommended instance type uses an NVMe storage interface and the current instance does not. To access NVMe volumes for the recommended instance type, you will need to install or upgrade the NVMe driver. For more information, see Networking and storage features and Amazon EBS and NVMe on Linux instances in the Amazon EC2 User Guide for Linux, or Networking and storage features and Amazon EBS and NVMe on Windows instances in the Amazon EC2 User Guide for Windows.
InstanceStoreAvailability — The recommended instance type does not support instance store volumes and the current instance does. Before migrating, you might need to back up the data on your instance 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 Amazon EBS? in the Amazon Web Services Premium Support Knowledge Base. For more information, see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Linux, or see Networking and storage features and Amazon EC2 instance store in the Amazon EC2 User Guide for Windows.
VirtualizationType — The recommended instance type uses the hardware virtual machine (HVM) virtualization type and the current instance uses the paravirtual (PV) virtualization type. For more information about the differences between these virtualization types, see Linux AMI virtualization types in the Amazon EC2 User Guide for Linux, or Windows AMI virtualization types in the Amazon EC2 User Guide for Windows.
Architecture — The CPU architecture between the recommended instance type and the current instance is different. For example, the recommended instance type might use an x86 CPU architecture and the current instance type might use a different one, such as ARM. Before migrating, you should consider recompiling the software on your instance for the new architecture. Alternatively, you might switch to an Amazon Machine Image (AMI) that supports the new architecture. For more information about the CPU architecture for each instance type, see Amazon EC2 Instance Types.
Describes a projected utilization metric of a recommendation option, such as an Amazon EC2 instance. This represents the projected utilization of a recommendation option had you used that resource during the analyzed period.
Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.
The Cpu and Memory metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
Describes a projected utilization metric of a recommendation option, such as an Amazon EC2 instance. This represents the projected utilization of a recommendation option had you used that resource during the analyzed period.
Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.
The Cpu and Memory metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
Describes a recommendation export job.
Use the DescribeRecommendationExportJobs action to view your recommendation export jobs.
Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations.
Describes a recommendation export job.
Use the DescribeRecommendationExportJobs action to view your recommendation export jobs.
Use the ExportAutoScalingGroupRecommendations or ExportEC2InstanceRecommendations actions to request an export of your recommendations.
", "refs": { "RecommendationExportJobs$member": null } @@ -928,6 +994,16 @@ "InstanceRecommendation$recommendationOptions": "An array of objects that describe the recommendation options for the instance.
" } }, + "RecommendationPreferences": { + "base": "Describes preferences for recommendations.
", + "refs": { + "ExportAutoScalingGroupRecommendationsRequest$recommendationPreferences": "An object to specify the preferences for the Auto Scaling group recommendations to export.
", + "ExportEC2InstanceRecommendationsRequest$recommendationPreferences": "An object to specify the preferences for the Amazon EC2 instance recommendations to export.
", + "GetAutoScalingGroupRecommendationsRequest$recommendationPreferences": "An object to specify the preferences for the Auto Scaling group recommendations to return in the response.
", + "GetEC2InstanceRecommendationsRequest$recommendationPreferences": "An object to specify the preferences for the Amazon EC2 instance recommendations to return in the response.
", + "GetEC2RecommendationProjectedMetricsRequest$recommendationPreferences": "An object to specify the preferences for the Amazon EC2 recommendation projected metrics to return in the response.
" + } + }, "RecommendationSource": { "base": "Describes the source of a recommendation, such as an Amazon EC2 instance or Auto Scaling group.
", "refs": { @@ -972,7 +1048,7 @@ } }, "RecommendedOptionProjectedMetric": { - "base": "Describes a projected utilization metric of a recommendation option.
The Cpu and Memory metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
Describes a projected utilization metric of a recommendation option.
The Cpu and Memory metrics are the only projected utilization metrics returned when you run the GetEC2RecommendationProjectedMetrics action. Additionally, the Memory metric is returned only for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
An array of objects that describe a projected metrics.
" + "GetEC2RecommendationProjectedMetricsResponse$recommendedOptionProjectedMetrics": "An array of objects that describes projected metrics.
" } }, "ResourceNotFoundException": { @@ -1005,11 +1081,11 @@ } }, "S3DestinationConfig": { - "base": "Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user guide.
", + "base": "Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for a recommendations export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
", "refs": { - "ExportAutoScalingGroupRecommendationsRequest$s3DestinationConfig": "An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user guide.
", + "ExportAutoScalingGroupRecommendationsRequest$s3DestinationConfig": "An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permissions policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
", "ExportEBSVolumeRecommendationsRequest$s3DestinationConfig": null, - "ExportEC2InstanceRecommendationsRequest$s3DestinationConfig": "An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permission policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the policy that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer user guide.
", + "ExportEC2InstanceRecommendationsRequest$s3DestinationConfig": "An object to specify the destination Amazon Simple Storage Service (Amazon S3) bucket name and key prefix for the export job.
You must create the destination Amazon S3 bucket for your recommendations export before you create the export job. Compute Optimizer does not create the S3 bucket for you. After you create the S3 bucket, ensure that it has the required permissions policy policy to allow Compute Optimizer to write the export file to it. If you plan to specify an object prefix when you create the export job, you must include the object prefix in the that you add to the S3 bucket. For more information, see Amazon S3 Bucket Policy for Compute Optimizer in the Compute Optimizer User Guide.
", "ExportLambdaFunctionRecommendationsRequest$s3DestinationConfig": null } }, @@ -1021,14 +1097,16 @@ "Status": { "base": null, "refs": { + "AccountEnrollmentStatus$status": "The account enrollment status.
", "GetEnrollmentStatusResponse$status": "The enrollment status of the account.
", - "UpdateEnrollmentStatusRequest$status": "The new enrollment status of the account.
The following status options are available:
Active - Opts in your account to the Compute Optimizer service. Compute Optimizer begins analyzing the configuration and utilization metrics of your AWS resources after you opt in. For more information, see Metrics analyzed by AWS Compute Optimizer in the AWS Compute Optimizer User Guide.
Inactive - Opts out your account from the Compute Optimizer service. Your account's recommendations and related metrics data will be deleted from Compute Optimizer after you opt out.
The Pending and Failed options cannot be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account.
The new enrollment status of the account.
The following status options are available:
Active - Opts in your account to the Compute Optimizer service. Compute Optimizer begins analyzing the configuration and utilization metrics of your Amazon Web Services resources after you opt in. For more information, see Metrics analyzed by Compute Optimizer in the Compute Optimizer User Guide.
Inactive - Opts out your account from the Compute Optimizer service. Your account's recommendations and related metrics data will be deleted from Compute Optimizer after you opt out.
The Pending and Failed options cannot be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account.
The enrollment status of the account.
" } }, "StatusReason": { "base": null, "refs": { + "AccountEnrollmentStatus$statusReason": "The reason for the account enrollment status.
For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.
The reason for the enrollment status of the account.
For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.
The reason for the enrollment status of the account. For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.
The time stamp of the first projected metrics data point to return.
", - "GetEC2RecommendationProjectedMetricsRequest$endTime": "The time stamp of the last projected metrics data point to return.
", + "GetEC2RecommendationProjectedMetricsRequest$startTime": "The timestamp of the first projected metrics data point to return.
", + "GetEC2RecommendationProjectedMetricsRequest$endTime": "The timestamp of the last projected metrics data point to return.
", "Timestamps$member": null } }, "Timestamps": { "base": null, "refs": { - "ProjectedMetric$timestamps": "The time stamps of the projected utilization metric.
" + "ProjectedMetric$timestamps": "The timestamps of the projected utilization metric.
" } }, "UpdateEnrollmentStatusRequest": { diff --git a/models/apis/ec2/2016-11-15/api-2.json b/models/apis/ec2/2016-11-15/api-2.json index f35b185e7ff..80a68690994 100755 --- a/models/apis/ec2/2016-11-15/api-2.json +++ b/models/apis/ec2/2016-11-15/api-2.json @@ -24024,7 +24024,8 @@ "RemoveEntries":{ "shape":"RemovePrefixListEntries", "locationName":"RemoveEntry" - } + }, + "MaxEntries":{"shape":"Integer"} } }, "ModifyManagedPrefixListResult":{ diff --git a/models/apis/ec2/2016-11-15/docs-2.json b/models/apis/ec2/2016-11-15/docs-2.json index 3a19c47feed..dcd38472563 100755 --- a/models/apis/ec2/2016-11-15/docs-2.json +++ b/models/apis/ec2/2016-11-15/docs-2.json @@ -94,10 +94,10 @@ "CreateTrafficMirrorSession": "Creates a Traffic Mirror session.
A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic.
The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway.
By default, no traffic is mirrored. Use CreateTrafficMirrorFilter to create filter rules that specify the traffic to mirror.
", "CreateTrafficMirrorTarget": "Creates a target for your Traffic Mirror session.
A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway.
A Traffic Mirror target can be a network interface, or a Network Load Balancer.
To use the target in a Traffic Mirror session, use CreateTrafficMirrorSession.
", "CreateTransitGateway": "Creates a transit gateway.
You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway.
To attach your VPCs, use CreateTransitGatewayVpcAttachment.
To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection.
When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.
", - "CreateTransitGatewayConnect": "Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.
A Connect attachment uses an existing VPC or AWS Direct Connect attachment as the underlying transport mechanism.
", + "CreateTransitGatewayConnect": "Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance.
A Connect attachment uses an existing VPC or Amazon Web Services Direct Connect attachment as the underlying transport mechanism.
", "CreateTransitGatewayConnectPeer": "Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.
The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
For more information, see Connect peers in the Transit Gateways Guide.
", "CreateTransitGatewayMulticastDomain": "Creates a multicast domain using the specified transit gateway.
The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
", - "CreateTransitGatewayPeeringAttachment": "Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different AWS account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
", + "CreateTransitGatewayPeeringAttachment": "Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different Amazon Web Services account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
", "CreateTransitGatewayPrefixListReference": "Creates a reference (route) to a prefix list in a specified transit gateway route table.
", "CreateTransitGatewayRoute": "Creates a static route for the specified transit gateway route table.
", "CreateTransitGatewayRouteTable": "Creates a route table for the specified transit gateway.
", @@ -7096,14 +7096,14 @@ "DescribeTrafficMirrorFiltersRequest$Filters": "One or more filters. The possible values are:
description: The Traffic Mirror filter description.
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
One or more filters. The possible values are:
description: The Traffic Mirror session description.
network-interface-id: The ID of the Traffic Mirror session network interface.
owner-id: The ID of the account that owns the Traffic Mirror session.
packet-length: The assigned number of packets to mirror.
session-number: The assigned session number.
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
traffic-mirror-session-id: The ID of the Traffic Mirror session.
traffic-mirror-target-id: The ID of the Traffic Mirror target.
virtual-network-id: The virtual network ID of the Traffic Mirror session.
One or more filters. The possible values are:
description: The Traffic Mirror target description.
network-interface-id: The ID of the Traffic Mirror session network interface.
network-load-balancer-arn: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session.
owner-id: The ID of the account that owns the Traffic Mirror session.
traffic-mirror-target-id: The ID of the Traffic Mirror target.
One or more filters. The possible values are:
association.state - The state of the association (associating | associated | disassociating).
association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
resource-id - The ID of the resource.
resource-owner-id - The ID of the AWS account that owns the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-owner-id - The ID of the AWS account that owns the transit gateway.
One or more filters. The possible values are:
association.state - The state of the association (associating | associated | disassociating).
association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
resource-id - The ID of the resource.
resource-owner-id - The ID of the Amazon Web Services account that owns the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
One or more filters. The possible values are:
state - The state of the Connect peer (pending | available | deleting | deleted).
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-connect-peer-id - The ID of the Connect peer.
One or more filters. The possible values are:
options.protocol - The tunnel protocol (gre).
state - The state of the attachment (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing).
transit-gateway-attachment-id - The ID of the Connect attachment.
transit-gateway-id - The ID of the transit gateway.
transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.
One or more filters. The possible values are:
state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.
One or more filters. The possible values are:
transit-gateway-attachment-id - The ID of the transit gateway attachment.
local-owner-id - The ID of your AWS account.
remote-owner-id - The ID of the AWS account in the remote Region that owns the transit gateway.
state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
transit-gateway-id - The ID of the transit gateway.
One or more filters. The possible values are:
transit-gateway-attachment-id - The ID of the transit gateway attachment.
local-owner-id - The ID of your Amazon Web Services account.
remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.
state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
transit-gateway-id - The ID of the transit gateway.
One or more filters. The possible values are:
default-association-route-table - Indicates whether this is the default association route table for the transit gateway (true | false).
default-propagation-route-table - Indicates whether this is the default propagation route table for the transit gateway (true | false).
state - The state of the route table (available | deleting | deleted | pending).
transit-gateway-id - The ID of the transit gateway.
transit-gateway-route-table-id - The ID of the transit gateway route table.
One or more filters. The possible values are:
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
vpc-id - The ID of the VPC.
One or more filters. The possible values are:
options.propagation-default-route-table-id - The ID of the default propagation route table.
options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id - The ID of the default association route table.
options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
options.dns-support - Indicates whether DNS support is enabled (enable | disable).
options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
owner-id - The ID of the AWS account that owns the transit gateway.
state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
transit-gateway-id - The ID of the transit gateway.
One or more filters. The possible values are:
options.propagation-default-route-table-id - The ID of the default propagation route table.
options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id - The ID of the default association route table.
options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
options.dns-support - Indicates whether DNS support is enabled (enable | disable).
options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
transit-gateway-id - The ID of the transit gateway.
One or more filters.
gre-key - The ID of a trunk interface association.
interface-protocol - The interface protocol. Valid values are VLAN and GRE.
The filters.
action.code - The action code for the event (for example, enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated with the action.
availability-zone - The Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time for the event.
volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).
volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).
The filters.
modification-state - The current modification state (modifying | optimizing | completed | failed).
original-iops - The original IOPS rate of the volume.
original-size - The original size of the volume, in GiB.
original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).
start-time - The modification start time.
target-iops - The target IOPS rate of the volume.
target-size - The target size of the volume, in GiB.
target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).
volume-id - The ID of the volume.
One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
One or more filters.
", - "SearchTransitGatewayMulticastGroupsRequest$Filters": "One or more filters. The possible values are:
group-ip-address - The IP address of the transit gateway multicast group.
is-group-member - The resource is a group member. Valid values are true | false.
is-group-source - The resource is a group source. Valid values are true | false.
member-type - The member type. Valid values are igmp | static.
resource-id - The ID of the resource.
resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering.
source-type - The source type. Valid values are igmp | static.
state - The state of the subnet association. Valid values are associated | associated | disassociated | disassociating.
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
One or more filters. The possible values are:
group-ip-address - The IP address of the transit gateway multicast group.
is-group-member - The resource is a group member. Valid values are true | false.
is-group-source - The resource is a group source. Valid values are true | false.
member-type - The member type. Valid values are igmp | static.
resource-id - The ID of the resource.
resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering.
source-type - The source type. Valid values are igmp | static.
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
One or more filters. The possible values are:
attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
prefix-list-id - The ID of the prefix list.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route (active | blackhole).
type - The type of route (propagated | static).
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
Possible values: Integers from 1 to 64
", "ModifyInstancePlacementRequest$PartitionNumber": "Reserved for future use.
", + "ModifyManagedPrefixListRequest$MaxEntries": "The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time.
", "ModifySpotFleetRequestRequest$TargetCapacity": "The size of the fleet.
", "ModifySpotFleetRequestRequest$OnDemandTargetCapacity": "The number of On-Demand Instances in the fleet.
", "ModifyTrafficMirrorFilterRuleRequest$RuleNumber": "The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.
", @@ -10910,7 +10911,7 @@ "ModifyTransitGatewayVpcAttachmentRequestOptions": { "base": "Describes the options for a VPC attachment.
", "refs": { - "ModifyTransitGatewayVpcAttachmentRequest$Options": "The new VPC attachment options.
You cannot modify the IPv6 options.
The new VPC attachment options.
" } }, "ModifyTransitGatewayVpcAttachmentResult": { @@ -14419,7 +14420,7 @@ "CreateTrafficMirrorTargetResult$ClientToken": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
", "CreateTransitGatewayConnectPeerRequest$TransitGatewayAddress": "The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.
", "CreateTransitGatewayConnectPeerRequest$PeerAddress": "The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.
", - "CreateTransitGatewayPeeringAttachmentRequest$PeerAccountId": "The AWS account ID of the owner of the peer transit gateway.
", + "CreateTransitGatewayPeeringAttachmentRequest$PeerAccountId": "The ID of the Amazon Web Services account that owns the peer transit gateway.
", "CreateTransitGatewayPeeringAttachmentRequest$PeerRegion": "The Region where the peer transit gateway is located.
", "CreateTransitGatewayRequest$Description": "A description of the transit gateway.
", "CreateTransitGatewayRouteRequest$DestinationCidrBlock": "The CIDR range used for destination matches. Routing decisions are based on the most specific match.
", @@ -15209,7 +15210,7 @@ "PeeringAttachmentStatus$Code": "The status code.
", "PeeringAttachmentStatus$Message": "The status message, if applicable.
", "PeeringTgwInfo$TransitGatewayId": "The ID of the transit gateway.
", - "PeeringTgwInfo$OwnerId": "The AWS account ID of the owner of the transit gateway.
", + "PeeringTgwInfo$OwnerId": "The ID of the Amazon Web Services account that owns the transit gateway.
", "PeeringTgwInfo$Region": "The Region of the transit gateway.
", "Phase1EncryptionAlgorithmsListValue$Value": "The value for the encryption algorithm.
", "Phase1EncryptionAlgorithmsRequestListValue$Value": "The value for the encryption algorithm.
", @@ -15594,13 +15595,13 @@ "TrafficMirrorTarget$OwnerId": "The ID of the account that owns the Traffic Mirror target.
", "TransitGateway$TransitGatewayId": "The ID of the transit gateway.
", "TransitGateway$TransitGatewayArn": "The Amazon Resource Name (ARN) of the transit gateway.
", - "TransitGateway$OwnerId": "The ID of the AWS account ID that owns the transit gateway.
", + "TransitGateway$OwnerId": "The ID of the Amazon Web Services account that owns the transit gateway.
", "TransitGateway$Description": "The description of the transit gateway.
", "TransitGatewayAssociation$ResourceId": "The ID of the resource.
", "TransitGatewayAttachment$TransitGatewayAttachmentId": "The ID of the attachment.
", "TransitGatewayAttachment$TransitGatewayId": "The ID of the transit gateway.
", - "TransitGatewayAttachment$TransitGatewayOwnerId": "The ID of the AWS account that owns the transit gateway.
", - "TransitGatewayAttachment$ResourceOwnerId": "The ID of the AWS account that owns the resource.
", + "TransitGatewayAttachment$TransitGatewayOwnerId": "The ID of the Amazon Web Services account that owns the transit gateway.
", + "TransitGatewayAttachment$ResourceOwnerId": "The ID of the Amazon Web Services account that owns the resource.
", "TransitGatewayAttachment$ResourceId": "The ID of the resource.
", "TransitGatewayAttachmentAssociation$TransitGatewayRouteTableId": "The ID of the route table for the transit gateway.
", "TransitGatewayAttachmentBgpConfiguration$TransitGatewayAddress": "The interior BGP peer IP address for the transit gateway.
", @@ -15616,19 +15617,19 @@ "TransitGatewayMulticastDomain$TransitGatewayMulticastDomainId": "The ID of the transit gateway multicast domain.
", "TransitGatewayMulticastDomain$TransitGatewayId": "The ID of the transit gateway.
", "TransitGatewayMulticastDomain$TransitGatewayMulticastDomainArn": "The Amazon Resource Name (ARN) of the transit gateway multicast domain.
", - "TransitGatewayMulticastDomain$OwnerId": "The ID of the AWS account that owns the transit gateway multiicast domain.
", + "TransitGatewayMulticastDomain$OwnerId": "The ID of the Amazon Web Services account that owns the transit gateway multicast domain.
", "TransitGatewayMulticastDomainAssociation$TransitGatewayAttachmentId": "The ID of the transit gateway attachment.
", "TransitGatewayMulticastDomainAssociation$ResourceId": "The ID of the resource.
", - "TransitGatewayMulticastDomainAssociation$ResourceOwnerId": "The ID of the AWS account that owns the transit gateway multicast domain association resource.
", + "TransitGatewayMulticastDomainAssociation$ResourceOwnerId": "The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.
", "TransitGatewayMulticastDomainAssociations$TransitGatewayMulticastDomainId": "The ID of the transit gateway multicast domain.
", "TransitGatewayMulticastDomainAssociations$TransitGatewayAttachmentId": "The ID of the transit gateway attachment.
", "TransitGatewayMulticastDomainAssociations$ResourceId": "The ID of the resource.
", - "TransitGatewayMulticastDomainAssociations$ResourceOwnerId": "The ID of the AWS account that owns the resource.
", + "TransitGatewayMulticastDomainAssociations$ResourceOwnerId": "The ID of the Amazon Web Services account that owns the resource.
", "TransitGatewayMulticastGroup$GroupIpAddress": "The IP address assigned to the transit gateway multicast group.
", "TransitGatewayMulticastGroup$TransitGatewayAttachmentId": "The ID of the transit gateway attachment.
", "TransitGatewayMulticastGroup$SubnetId": "The ID of the subnet.
", "TransitGatewayMulticastGroup$ResourceId": "The ID of the resource.
", - "TransitGatewayMulticastGroup$ResourceOwnerId": "The ID of the AWS account that owns the transit gateway multicast domain group resource.
", + "TransitGatewayMulticastGroup$ResourceOwnerId": "The ID of the Amazon Web Services account that owns the transit gateway multicast domain group resource.
", "TransitGatewayMulticastGroup$NetworkInterfaceId": "The ID of the transit gateway attachment.
", "TransitGatewayMulticastRegisteredGroupMembers$TransitGatewayMulticastDomainId": "The ID of the transit gateway multicast domain.
", "TransitGatewayMulticastRegisteredGroupMembers$GroupIpAddress": "The IP address assigned to the transit gateway multicast group.
", @@ -15653,7 +15654,7 @@ "TransitGatewayVpcAttachment$TransitGatewayAttachmentId": "The ID of the attachment.
", "TransitGatewayVpcAttachment$TransitGatewayId": "The ID of the transit gateway.
", "TransitGatewayVpcAttachment$VpcId": "The ID of the VPC.
", - "TransitGatewayVpcAttachment$VpcOwnerId": "The ID of the AWS account that owns the VPC.
", + "TransitGatewayVpcAttachment$VpcOwnerId": "The ID of the Amazon Web Services account that owns the VPC.
", "TrunkInterfaceAssociation$BranchInterfaceId": "The ID of the branch network interface.
", "TrunkInterfaceAssociation$TrunkInterfaceId": "The ID of the trunk network interface.
", "TunnelOption$OutsideIpAddress": "The external IP address of the VPN tunnel.
", @@ -16035,7 +16036,7 @@ "TransitGatewayPeeringAttachment$Tags": "The tags for the transit gateway peering attachment.
", "TransitGatewayRouteTable$Tags": "Any tags assigned to the route table.
", "TransitGatewayVpcAttachment$Tags": "The tags for the VPC attachment.
", - "TrunkInterfaceAssociation$Tags": "The tags for the trunk interface associaton.
", + "TrunkInterfaceAssociation$Tags": "The tags for the trunk interface association.
", "Volume$Tags": "Any tags assigned to the volume.
", "Vpc$Tags": "Any tags assigned to the VPC.
", "VpcClassicLink$Tags": "Any tags assigned to the VPC.
", @@ -16526,7 +16527,7 @@ "AssociateTransitGatewayMulticastDomainRequest$TransitGatewayAttachmentId": "The ID of the transit gateway attachment to associate with the transit gateway multicast domain.
", "AssociateTransitGatewayRouteTableRequest$TransitGatewayAttachmentId": "The ID of the attachment.
", "CreateTransitGatewayConnectPeerRequest$TransitGatewayAttachmentId": "The ID of the Connect attachment.
", - "CreateTransitGatewayConnectRequest$TransportTransitGatewayAttachmentId": "The ID of the transit gateway attachment. You can specify a VPC attachment or a AWS Direct Connect attachment.
", + "CreateTransitGatewayConnectRequest$TransportTransitGatewayAttachmentId": "The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment.
", "CreateTransitGatewayPrefixListReferenceRequest$TransitGatewayAttachmentId": "The ID of the attachment to which traffic is routed.
", "CreateTransitGatewayRouteRequest$TransitGatewayAttachmentId": "The ID of the attachment.
", "DeleteTransitGatewayConnectRequest$TransitGatewayAttachmentId": "The ID of the Connect attachment.
", @@ -17088,7 +17089,7 @@ "TrunkInterfaceAssociationId": { "base": null, "refs": { - "DisassociateTrunkInterfaceRequest$AssociationId": "The ID ofthe association
", + "DisassociateTrunkInterfaceRequest$AssociationId": "The ID of the association
", "TrunkInterfaceAssociation$AssociationId": "The ID of the association.
", "TrunkInterfaceAssociationIdList$member": null } diff --git a/models/apis/rekognition/2016-06-27/api-2.json b/models/apis/rekognition/2016-06-27/api-2.json index fca4057dcbb..beeb0ea147f 100644 --- a/models/apis/rekognition/2016-06-27/api-2.json +++ b/models/apis/rekognition/2016-06-27/api-2.json @@ -1070,7 +1070,8 @@ "Name":{"shape":"String"}, "Id":{"shape":"RekognitionUniqueId"}, "Face":{"shape":"ComparedFace"}, - "MatchConfidence":{"shape":"Percent"} + "MatchConfidence":{"shape":"Percent"}, + "KnownGender":{"shape":"KnownGender"} } }, "CelebrityDetail":{ @@ -1167,7 +1168,9 @@ "Confidence":{"shape":"Percent"}, "Landmarks":{"shape":"Landmarks"}, "Pose":{"shape":"Pose"}, - "Quality":{"shape":"ImageQuality"} + "Quality":{"shape":"ImageQuality"}, + "Emotions":{"shape":"Emotions"}, + "Smile":{"shape":"Smile"} } }, "ComparedFaceList":{ @@ -1777,7 +1780,8 @@ "type":"structure", "members":{ "Urls":{"shape":"Urls"}, - "Name":{"shape":"String"} + "Name":{"shape":"String"}, + "KnownGender":{"shape":"KnownGender"} } }, "GetCelebrityRecognitionRequest":{ @@ -2149,6 +2153,19 @@ "min":1, "pattern":"^[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,2048}$" }, + "KnownGender":{ + "type":"structure", + "members":{ + "Type":{"shape":"KnownGenderType"} + } + }, + "KnownGenderType":{ + "type":"string", + "enum":[ + "Male", + "Female" + ] + }, "Label":{ "type":"structure", "members":{ @@ -3287,7 +3304,9 @@ "Url":{"type":"string"}, "Urls":{ "type":"list", - "member":{"shape":"Url"} + "member":{"shape":"Url"}, + "max":255, + "min":0 }, "ValidationData":{ "type":"structure", diff --git a/models/apis/rekognition/2016-06-27/docs-2.json b/models/apis/rekognition/2016-06-27/docs-2.json index 6959ee81d40..7033a6ee0f5 100644 --- a/models/apis/rekognition/2016-06-27/docs-2.json +++ b/models/apis/rekognition/2016-06-27/docs-2.json @@ -16,13 +16,13 @@ "DescribeProjectVersions": "Lists and describes the models in an Amazon Rekognition Custom Labels project. You can specify up to 10 model versions in ProjectVersionArns. If you don't specify a value, descriptions for all models are returned.
This operation requires permissions to perform the rekognition:DescribeProjectVersions action.
Lists and gets information about your Amazon Rekognition Custom Labels projects.
This operation requires permissions to perform the rekognition:DescribeProjects action.
Provides information about a stream processor created by CreateStreamProcessor. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor.
", - "DetectCustomLabels": "Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.
You specify which version of a model version to use by using the ProjectVersionArn input parameter.
You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
For each object that the model version detects on an image, the API returns a (CustomLabel) object in an array (CustomLabels). Each CustomLabel object provides the label name (Name), the level of confidence that the image contains the object (Confidence), and object location information, if it exists, for the label on the image (Geometry).
During training model calculates a threshold value that determines if a prediction for a label is true. By default, DetectCustomLabels doesn't return labels whose confidence value is below the model's calculated threshold value. To filter labels that are returned, specify a value for MinConfidence that is higher than the model's calculated threshold. You can get the model's calculated threshold from the model's training results shown in the Amazon Rekognition Custom Labels console. To get all labels, regardless of confidence, specify a MinConfidence value of 0.
You can also add the MaxResults parameter to limit the number of labels returned.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectCustomLabels action.
Detects custom labels in a supplied image by using an Amazon Rekognition Custom Labels model.
You specify which version of a model version to use by using the ProjectVersionArn input parameter.
You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
For each object that the model version detects on an image, the API returns a (CustomLabel) object in an array (CustomLabels). Each CustomLabel object provides the label name (Name), the level of confidence that the image contains the object (Confidence), and object location information, if it exists, for the label on the image (Geometry).
To filter labels that are returned, specify a value for MinConfidence. DetectCustomLabelsLabels only returns labels with a confidence that's higher than the specified value. The value of MinConfidence maps to the assumed threshold values created during training. For more information, see Assumed threshold in the Amazon Rekognition Custom Labels Developer Guide. Amazon Rekognition Custom Labels metrics expresses an assumed threshold as a floating point value between 0-1. The range of MinConfidence normalizes the threshold value to a percentage value (0-100). Confidence responses from DetectCustomLabels are also returned as a percentage. You can use MinConfidence to change the precision and recall or your model. For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.
If you don't specify a value for MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each label.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectCustomLabels action.
For more information, see Analyzing an image in the Amazon Rekognition Custom Labels Developer Guide.
", "DetectFaces": "Detects faces within an image that is provided as input.
DetectFaces detects the 100 largest faces in the image. For each face detected, the operation returns face details. These details include a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), presence of beard, sunglasses, and so on.
The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence.
You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectFaces action.
Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature.
For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide.
DetectLabels does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide.
You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object.
{Name: lighthouse, Confidence: 98.4629}
{Name: rock,Confidence: 79.2097}
{Name: sea,Confidence: 75.061}
In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels.
{Name: flower,Confidence: 99.0562}
{Name: plant,Confidence: 99.0562}
{Name: tulip,Confidence: 99.0562}
In this example, the detection algorithm more precisely identifies the flower as a tulip.
In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify MinConfidence to control the confidence threshold for the labels returned. The default is 55%. You can also add the MaxLabels parameter to limit the number of labels returned.
If the object detected is a person, the operation doesn't provide the same facial details that the DetectFaces operation provides.
DetectLabels returns bounding boxes for instances of common object labels in an array of Instance objects. An Instance object contains a BoundingBox object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected.
DetectLabels also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label car. The label car has two parent labels: Vehicle (its parent) and Transportation (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, Car, Vehicle, and Transportation are returned as unique labels in the response.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectLabels action.
Detects unsafe content in a specified JPEG or PNG format image. Use DetectModerationLabels to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content.
To filter images, use the labels returned by DetectModerationLabels to determine which types of content are appropriate.
For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide.
You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.
", "DetectProtectiveEquipment": "Detects Personal Protective Equipment (PPE) worn by people detected in an image. Amazon Rekognition can detect the following types of PPE.
Face cover
Hand cover
Head cover
You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. The image must be either a PNG or JPG formatted file.
DetectProtectiveEquipment detects PPE worn by up to 15 persons detected in an image.
For each person detected in the image the API returns an array of body parts (face, head, left-hand, right-hand). For each body part, an array of detected items of PPE is returned, including an indicator of whether or not the PPE covers the body part. The API returns the confidence it has in each detection (person, PPE, body part and body part coverage). It also returns a bounding box (BoundingBox) for each detected person and each detected item of PPE.
You can optionally request a summary of detected PPE items with the SummarizationAttributes input parameter. The summary provides the following information.
The persons detected as wearing all of the types of PPE that you specify.
The persons detected as not wearing all of the types PPE that you specify.
The persons detected where PPE adornment could not be determined.
This is a stateless API operation. That is, the operation does not persist any data.
This operation requires permissions to perform the rekognition:DetectProtectiveEquipment action.
Detects text in the input image and converts it into machine-readable text.
Pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file.
The DetectText operation returns text in an array of TextDetection elements, TextDetections. Each TextDetection element provides information about a single word or line of text that was detected in the image.
A word is one or more ISO basic latin script characters that are not separated by spaces. DetectText can detect up to 100 words in an image.
A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when there is a large gap between words, relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't represent the end of a line. If a sentence spans multiple lines, the DetectText operation returns multiple lines.
To determine whether a TextDetection element is a line of text or a word, use the TextDetection object Type field.
To be detected, text must be within +/- 90 degrees orientation of the horizontal axis.
For more information, see DetectText in the Amazon Rekognition Developer Guide.
", - "GetCelebrityInfo": "Gets the name and additional information about a celebrity based on his or her Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty.
For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:GetCelebrityInfo action.
Gets the name and additional information about a celebrity based on their Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty.
For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:GetCelebrityInfo action.
Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition.
Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to StartCelebrityRecognition which returns a job identifier (JobId). When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartCelebrityRecognition. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetCelebrityDetection and pass the job identifier (JobId) from the initial call to StartCelebrityDetection.
For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide.
GetCelebrityRecognition returns detected celebrities and the time(s) they are detected in an array (Celebrities) of CelebrityRecognition objects. Each CelebrityRecognition contains information about the celebrity in a CelebrityDetail object and the time, Timestamp, the celebrity was detected.
GetCelebrityRecognition only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.
By default, the Celebrities array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value ID in the SortBy input parameter.
The CelebrityDetail object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling GetCelebrityInfo with the celebrity identifer.
No information is returned for faces not recognized as celebrities.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetCelebrityDetection and populate the NextToken request parameter with the token value returned from the previous call to GetCelebrityRecognition.
Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration. For a list of moderation labels in Amazon Rekognition, see Using the image and video moderation APIs.
Amazon Rekognition Video inappropriate or offensive content detection in a stored video is an asynchronous operation. You start analysis by calling StartContentModeration which returns a job identifier (JobId). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartContentModeration. To get the results of the content analysis, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetContentModeration and pass the job identifier (JobId) from the initial call to StartContentModeration.
For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide.
GetContentModeration returns detected inappropriate, unwanted, or offensive content moderation labels, and the time they are detected, in an array, ModerationLabels, of ContentModerationDetection objects.
By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying NAME for the SortBy input parameter.
Since video analysis can return a large number of results, use the MaxResults parameter to limit the number of labels returned in a single call to GetContentModeration. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetContentModeration and populate the NextToken request parameter with the value of NextToken returned from the previous call to GetContentModeration.
For more information, see Content moderation in the Amazon Rekognition Developer Guide.
", "GetFaceDetection": "Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.
Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling StartFaceDetection which returns a job identifier (JobId). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceDetection. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceDetection and pass the job identifier (JobId) from the initial call to StartFaceDetection.
GetFaceDetection returns an array of detected faces (Faces) sorted by the time the faces were detected.
Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in MaxResults, the value of NextToken in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetFaceDetection and populate the NextToken request parameter with the token value returned from the previous call to GetFaceDetection.
Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64 celebrities in an image.
" + "RecognizeCelebritiesResponse$CelebrityFaces": "Details about each celebrity found in the image. Amazon Rekognition can detect a maximum of 64 celebrities in an image. Each celebrity object includes the following attributes: Face, Confidence, Emotions, Landmarks, Pose, Quality, Smile, Id, KnownGender, MatchConfidence, Name, Urls.
The emotions that appear to be expressed on the face, and the confidence level in the determination. Valid values include \"Happy\", \"Sad\", \"Angry\", \"Confused\", \"Disgusted\", \"Surprised\", \"Calm\", \"Unknown\", and \"Fear\".
", "FaceDetail$Emotions": "The emotions that appear to be expressed on the face, and the confidence level in the determination. The API is only making a determination of the physical appearance of a person's face. It is not a determination of the person’s internal emotional state and should not be used in such a way. For example, a person pretending to have a sad face might not be sad emotionally.
" } }, @@ -1091,6 +1092,19 @@ "ProjectVersionDescription$KmsKeyId": "The identifer for the AWS Key Management Service (AWS KMS) customer master key that was used to encrypt the model during training.
" } }, + "KnownGender": { + "base": "The known gender identity for the celebrity that matches the provided ID.
", + "refs": { + "Celebrity$KnownGender": null, + "GetCelebrityInfoResponse$KnownGender": "Retrieves the known gender for the celebrity.
" + } + }, + "KnownGenderType": { + "base": "A list of enum string of possible gender values that Celebrity returns.
", + "refs": { + "KnownGender$Type": "A string value of the KnownGender info about the Celebrity.
" + } + }, "Label": { "base": "Structure containing details about the detected label, including the name, detected instances, parent labels, and level of confidence.
", "refs": { @@ -1271,7 +1285,7 @@ "DetectFacesResponse$OrientationCorrection": "
The value of OrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
", "DetectLabelsResponse$OrientationCorrection": "The value of OrientationCorrection is always null.
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction. The bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Amazon Rekognition doesn’t perform image correction for images in .png format and .jpeg images without orientation information in the image Exif metadata. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
", "IndexFacesResponse$OrientationCorrection": "If your collection is associated with a face detection model that's later than version 3.0, the value of OrientationCorrection is always null and no orientation information is returned.
If your collection is associated with a face detection model that's version 3.0 or earlier, the following applies:
If the input image is in .jpeg format, it might contain exchangeable image file format (Exif) metadata that includes the image's orientation. Amazon Rekognition uses this orientation information to perform image correction - the bounding box coordinates are translated to represent object locations after the orientation information in the Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata. The value of OrientationCorrection is null.
If the image doesn't contain orientation information in its Exif metadata, Amazon Rekognition returns an estimated orientation (ROTATE_0, ROTATE_90, ROTATE_180, ROTATE_270). Amazon Rekognition doesn’t perform image correction for images. The bounding box coordinates aren't translated and represent the object locations before the image is rotated.
Bounding box information is returned in the FaceRecords array. You can get the version of the face detection model by calling DescribeCollection.
The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in CelebrityFaces and UnrecognizedFaces represent face locations before the image orientation is corrected.
If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of OrientationCorrection is null. The CelebrityFaces and UnrecognizedFaces bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Support for estimating image orientation using the the OrientationCorrection field has ceased as of August 2021. Any returned values for this field included in an API response will always be NULL.
The orientation of the input image (counterclockwise direction). If your application displays the image, you can use this value to correct the orientation. The bounding box coordinates returned in CelebrityFaces and UnrecognizedFaces represent face locations before the image orientation is corrected.
If the input image is in .jpeg format, it might contain exchangeable image (Exif) metadata that includes the image's orientation. If so, and the Exif metadata for the input image populates the orientation field, the value of OrientationCorrection is null. The CelebrityFaces and UnrecognizedFaces bounding box coordinates represent face locations after Exif metadata is used to correct the image orientation. Images in .png format don't contain Exif metadata.
Confidence level that the selected bounding box contains a face.
", "CoversBodyPart$Confidence": "The confidence that Amazon Rekognition has in the value of Value.
The confidence that the model has in the detection of the custom label. The range is 0-100. A higher value indicates a higher confidence.
", - "DetectCustomLabelsRequest$MinConfidence": "Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence lower than this specified value. If you specify a value of 0, all labels are return, regardless of the default thresholds that the model version applies.
", + "DetectCustomLabelsRequest$MinConfidence": "Specifies the minimum confidence level for the labels to return. DetectCustomLabels doesn't return any labels with a confidence value that's lower than this specified value. If you specify a value of 0, DetectCustomLabels returns all labels, regardless of the assumed threshold applied to each label. If you don't specify a value for MinConfidence, DetectCustomLabels returns labels based on the assumed threshold of each label.
Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.
If MinConfidence is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.
Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value.
If you don't specify MinConfidence, the operation returns labels with confidence values greater than or equal to 50 percent.
Sets the confidence of word detection. Words with detection confidence below this will be excluded from the result. Values should be between 50 and 100 as Text in Video will not return any result below 50.
", @@ -1775,6 +1789,7 @@ "Smile": { "base": "Indicates whether or not the face is smiling, and the confidence level in the determination.
", "refs": { + "ComparedFace$Smile": "Indicates whether or not the face is smiling, and the confidence level in the determination.
", "FaceDetail$Smile": "Indicates whether or not the face is smiling, and the confidence level in the determination.
" } }, diff --git a/models/apis/transcribe/2017-10-26/api-2.json b/models/apis/transcribe/2017-10-26/api-2.json index d6d9ecbd640..2729cbc4449 100644 --- a/models/apis/transcribe/2017-10-26/api-2.json +++ b/models/apis/transcribe/2017-10-26/api-2.json @@ -1124,7 +1124,11 @@ "ta-IN", "te-IN", "tr-TR", - "zh-CN" + "zh-CN", + "zh-TW", + "th-TH", + "en-ZA", + "en-NZ" ] }, "LanguageModel":{ diff --git a/models/apis/transcribe/2017-10-26/docs-2.json b/models/apis/transcribe/2017-10-26/docs-2.json index b1147e738f7..119a6a11583 100644 --- a/models/apis/transcribe/2017-10-26/docs-2.json +++ b/models/apis/transcribe/2017-10-26/docs-2.json @@ -283,7 +283,7 @@ "MedicalTranscriptionJobSummary$CompletionTime": "A timestamp that shows when the job was completed.
", "TranscriptionJob$StartTime": "A timestamp that shows when the job started processing.
", "TranscriptionJob$CreationTime": "A timestamp that shows when the job was created.
", - "TranscriptionJob$CompletionTime": "A timestamp that shows when the job was completed.
", + "TranscriptionJob$CompletionTime": "A timestamp that shows when the job completed.
", "TranscriptionJobSummary$CreationTime": "A timestamp that shows when the job was created.
", "TranscriptionJobSummary$StartTime": "A timestamp that shows when the job started processing.
", "TranscriptionJobSummary$CompletionTime": "A timestamp that shows when the job was completed.
", @@ -769,7 +769,7 @@ "ListMedicalTranscriptionJobsResponse$NextToken": "The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on a page, Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the ListMedicalTranscriptionJobs operation to return in the next page of jobs.
If the result of your previous request to ListMedicalVocabularies was truncated, include the NextToken to fetch the next set of vocabularies.
The ListMedicalVocabularies operation returns a page of vocabularies at a time. You set the maximum number of vocabularies to return on a page with the MaxResults parameter. If there are more jobs in the list will fit on a page, Amazon Transcribe Medical returns the NextPage token. To return the next page of vocabularies, include the token in the next request to the ListMedicalVocabularies operation .
If the result of the previous request to ListTranscriptionJobs was truncated, include the NextToken to fetch the next set of jobs.
If the result of the previous request to ListTranscriptionJobs is truncated, include the NextToken to fetch the next set of jobs.
The ListTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the page is set by the MaxResults parameter. If there are more jobs in the list than the page size, Amazon Transcribe returns the NextPage token. Include the token in the next request to the ListTranscriptionJobs operation to return in the next page of jobs.
If the result of the previous request to ListVocabularies was truncated, include the NextToken to fetch the next set of jobs.
The ListVocabularies operation returns a page of vocabularies at a time. The maximum size of the page is set in the MaxResults parameter. If there are more jobs in the list than will fit on the page, Amazon Transcribe returns the NextPage token. To return in the next page of jobs, include the token in the next request to the ListVocabularies operation.