ExportAutoScalingGroupRecommendations - Amazon Compute Optimizer
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


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 Region.

Request Syntax

{ "accountIds": [ "string" ], "fieldsToExport": [ "string" ], "fileFormat": "string", "filters": [ { "name": "string", "values": [ "string" ] } ], "includeMemberAccounts": boolean, "recommendationPreferences": { "cpuVendorArchitectures": [ "string" ] }, "s3DestinationConfig": { "bucket": "string", "keyPrefix": "string" } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


The IDs of the Amazon 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.

Type: Array of strings

Required: No


The recommendations data to include in the export file. For more information about the fields that can be exported, see Exported files in the Compute Optimizer User Guide.

Type: Array of strings

Valid Values: AccountId | AutoScalingGroupArn | AutoScalingGroupName | Finding | UtilizationMetricsCpuMaximum | UtilizationMetricsMemoryMaximum | UtilizationMetricsEbsReadOpsPerSecondMaximum | UtilizationMetricsEbsWriteOpsPerSecondMaximum | UtilizationMetricsEbsReadBytesPerSecondMaximum | UtilizationMetricsEbsWriteBytesPerSecondMaximum | UtilizationMetricsDiskReadOpsPerSecondMaximum | UtilizationMetricsDiskWriteOpsPerSecondMaximum | UtilizationMetricsDiskReadBytesPerSecondMaximum | UtilizationMetricsDiskWriteBytesPerSecondMaximum | UtilizationMetricsNetworkInBytesPerSecondMaximum | UtilizationMetricsNetworkOutBytesPerSecondMaximum | UtilizationMetricsNetworkPacketsInPerSecondMaximum | UtilizationMetricsNetworkPacketsOutPerSecondMaximum | LookbackPeriodInDays | CurrentConfigurationInstanceType | CurrentConfigurationDesiredCapacity | CurrentConfigurationMinSize | CurrentConfigurationMaxSize | CurrentOnDemandPrice | CurrentStandardOneYearNoUpfrontReservedPrice | CurrentStandardThreeYearNoUpfrontReservedPrice | CurrentVCpus | CurrentMemory | CurrentStorage | CurrentNetwork | RecommendationOptionsConfigurationInstanceType | RecommendationOptionsConfigurationDesiredCapacity | RecommendationOptionsConfigurationMinSize | RecommendationOptionsConfigurationMaxSize | RecommendationOptionsProjectedUtilizationMetricsCpuMaximum | RecommendationOptionsProjectedUtilizationMetricsMemoryMaximum | RecommendationOptionsPerformanceRisk | RecommendationOptionsOnDemandPrice | RecommendationOptionsStandardOneYearNoUpfrontReservedPrice | RecommendationOptionsStandardThreeYearNoUpfrontReservedPrice | RecommendationOptionsVcpus | RecommendationOptionsMemory | RecommendationOptionsStorage | RecommendationOptionsNetwork | LastRefreshTimestamp | CurrentPerformanceRisk | RecommendationOptionsSavingsOpportunityPercentage | RecommendationOptionsEstimatedMonthlySavingsCurrency | RecommendationOptionsEstimatedMonthlySavingsValue | EffectiveRecommendationPreferencesCpuVendorArchitectures | EffectiveRecommendationPreferencesEnhancedInfrastructureMetrics | EffectiveRecommendationPreferencesInferredWorkloadTypes | EffectiveRecommendationPreferencesPreferredResources | EffectiveRecommendationPreferencesLookBackPeriod | InferredWorkloadTypes | RecommendationOptionsMigrationEffort | CurrentInstanceGpuInfo | RecommendationOptionsInstanceGpuInfo | UtilizationMetricsGpuPercentageMaximum | UtilizationMetricsGpuMemoryPercentageMaximum | RecommendationOptionsProjectedUtilizationMetricsGpuPercentageMaximum | RecommendationOptionsProjectedUtilizationMetricsGpuMemoryPercentageMaximum | EffectiveRecommendationPreferencesSavingsEstimationMode | RecommendationOptionsSavingsOpportunityAfterDiscountsPercentage | RecommendationOptionsEstimatedMonthlySavingsCurrencyAfterDiscounts | RecommendationOptionsEstimatedMonthlySavingsValueAfterDiscounts

Required: No


The format of the export file.

The only export file format currently supported is Csv.

Type: String

Valid Values: Csv

Required: No


An array of objects to specify a filter that exports a more specific set of Auto Scaling group recommendations.

Type: Array of Filter objects

Required: No


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 Organizations trusted access in the Amazon 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.

Type: Boolean

Required: No


An object to specify the preferences for the Auto Scaling group recommendations to export.

Type: RecommendationPreferences object

Required: No


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.

Type: S3DestinationConfig object

Required: Yes

Response Syntax

{ "jobId": "string", "s3Destination": { "bucket": "string", "key": "string", "metadataKey": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The identification number of the export job.

Use the DescribeRecommendationExportJobs action, and specify the job ID to view the status of an export job.

Type: String


An object that describes the destination Amazon S3 bucket of a recommendations export file.

Type: S3Destination object


For information about the errors that are common to all actions, see Common Errors.


You do not have sufficient access to perform this action.

HTTP Status Code: 400


An internal error has occurred. Try your call again.

HTTP Status Code: 500


The value supplied for the input parameter is out of range or not valid.

HTTP Status Code: 400


The request exceeds a limit of the service.

HTTP Status Code: 400


The request must contain either a valid (registered) Amazon access key ID or X.509 certificate.

HTTP Status Code: 400


The account is not opted in to Amazon Compute Optimizer.

HTTP Status Code: 400


The request has failed due to a temporary failure of the server.

HTTP Status Code: 500


The request was denied due to request throttling.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: