describeRecommendationExportJobs method

Future<DescribeRecommendationExportJobsResponse> describeRecommendationExportJobs({
  1. List<JobFilter>? filters,
  2. List<String>? jobIds,
  3. int? maxResults,
  4. String? nextToken,
})

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.

May throw OptInRequiredException. May throw InternalServerException. May throw ServiceUnavailableException. May throw AccessDeniedException. May throw InvalidParameterValueException. May throw ResourceNotFoundException. May throw MissingAuthenticationToken. May throw ThrottlingException.

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

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

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

Parameter nextToken : The token to advance to the next page of export jobs.

Implementation

Future<DescribeRecommendationExportJobsResponse>
    describeRecommendationExportJobs({
  List<JobFilter>? filters,
  List<String>? jobIds,
  int? maxResults,
  String? nextToken,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.0',
    'X-Amz-Target': 'ComputeOptimizerService.DescribeRecommendationExportJobs'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (filters != null) 'filters': filters,
      if (jobIds != null) 'jobIds': jobIds,
      if (maxResults != null) 'maxResults': maxResults,
      if (nextToken != null) 'nextToken': nextToken,
    },
  );

  return DescribeRecommendationExportJobsResponse.fromJson(jsonResponse.body);
}