DescribeRecommendationExportJobs - AWS Compute Optimizer

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.

Request Syntax

{ "filters": [ { "name": "string", "values": [ "string" ] } ], "jobIds": [ "string" ], "maxResults": number, "nextToken": "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.

filters

An array of objects that describe a filter to return a more specific list of export jobs.

Type: Array of JobFilter objects

Required: No

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.

Type: Array of strings

Required: No

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.

Type: Integer

Required: No

nextToken

The token to advance to the next page of export jobs.

Type: String

Required: No

Response Syntax

{ "nextToken": "string", "recommendationExportJobs": [ { "creationTimestamp": number, "destination": { "s3": { "bucket": "string", "key": "string", "metadataKey": "string" } }, "failureReason": "string", "jobId": "string", "lastUpdatedTimestamp": number, "resourceType": "string", "status": "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.

nextToken

The token to use to advance to the next page of export jobs.

This value is null when there are no more pages of export jobs to return.

Type: String

recommendationExportJobs

An array of objects that describe recommendation export jobs.

Type: Array of RecommendationExportJob objects

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 400

InternalServerException

An internal error has occurred. Try your call again.

HTTP Status Code: 500

InvalidParameterValueException

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400

MissingAuthenticationToken

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

HTTP Status Code: 400

OptInRequiredException

The account is not opted in to AWS Compute Optimizer.

HTTP Status Code: 400

ResourceNotFoundException

A resource that is required for the action doesn't exist.

HTTP Status Code: 400

ServiceUnavailableException

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

HTTP Status Code: 500

ThrottlingException

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: