ExportLicenseRecommendations - AWS Compute Optimizer


Export optimization recommendations for your licenses.

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 license export job in progress per AWS Region.

Request Syntax

{ "accountIds": [ "string" ], "fieldsToExport": [ "string" ], "fileFormat": "string", "filters": [ { "name": "string", "values": [ "string" ] } ], "includeMemberAccounts": boolean, "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 AWS accounts for which to export license 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 can't be specified together with the include member accounts parameter. The parameters are mutually exclusive.

If this parameter is omitted, recommendations for member accounts aren't included in the export.

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 | ResourceArn | LookbackPeriodInDays | LastRefreshTimestamp | Finding | FindingReasonCodes | CurrentLicenseConfigurationNumberOfCores | CurrentLicenseConfigurationInstanceType | CurrentLicenseConfigurationOperatingSystem | CurrentLicenseConfigurationLicenseName | CurrentLicenseConfigurationLicenseEdition | CurrentLicenseConfigurationLicenseModel | CurrentLicenseConfigurationLicenseVersion | CurrentLicenseConfigurationMetricsSource | RecommendationOptionsOperatingSystem | RecommendationOptionsLicenseEdition | RecommendationOptionsLicenseModel | RecommendationOptionsSavingsOpportunityPercentage | RecommendationOptionsEstimatedMonthlySavingsCurrency | RecommendationOptionsEstimatedMonthlySavingsValue | Tags

Required: No


The format of the export file.

A CSV file is the only export format currently supported.

Type: String

Valid Values: Csv

Required: No


An array of objects to specify a filter that exports a more specific set of license recommendations.

Type: Array of LicenseRecommendationFilter 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 AWS Organizations trusted access in the AWS Compute Optimizer User Guide.

If this parameter is omitted, recommendations for member accounts of the organization aren't included in the export file .

This parameter cannot be specified together with the account IDs parameter. The parameters are mutually exclusive.

Type: Boolean

Required: No


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.

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.

To view the status of an export job, use the DescribeRecommendationExportJobs action and specify the job ID.

Type: String


Describes the destination Amazon Simple Storage Service (Amazon S3) bucket name and object keys of a recommendations export file, and its associated metadata 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) AWS access key ID or X.509 certificate.

HTTP Status Code: 400


The account is not opted in to AWS 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 AWS SDKs, see the following: