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.
Parameters:
-
job_ids
(Optional[JobIds], default:
None
)
–
-
filters
(Optional[JobFilters], default:
None
)
–
An array of objects to specify a filter that returns a more specific list of export jobs.
-
next_token
(Optional[NextToken], default:
None
)
–
The token to advance to the next page of export jobs.
-
max_results
(Optional[MaxResults], default:
None
)
–
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.
Raises:
Source code in docs_src/capo_compute_optimizer/_services/async_compute_optimizer.py
| async def describe_recommendation_export_jobs(
self,
*,
config_overrides: Optional[AsyncComputeOptimizerClientConfig] = None,
job_ids: Optional["capo_compute_optimizer.types.job_ids.JobIds"] = None,
filters: Optional["capo_compute_optimizer.types.job_filters.JobFilters"] = None,
next_token: Optional[
"capo_compute_optimizer.types.next_token.NextToken"
] = None,
max_results: Optional[
"capo_compute_optimizer.types.max_results.MaxResults"
] = None,
) -> "capo_compute_optimizer.types.describe_recommendation_export_jobs_response.DescribeRecommendationExportJobsResponse":
"""<p>Describes recommendation export jobs created in the last seven days.</p> <p>Use the <a>ExportAutoScalingGroupRecommendations</a> or <a>ExportEC2InstanceRecommendations</a> actions to request an export of your recommendations. Then use the <a>DescribeRecommendationExportJobs</a> action to view your export jobs.</p>
Args:
job_ids: <p>The identification numbers of the export jobs to return.</p> <p>An export job ID is returned when you create an export using the <a>ExportAutoScalingGroupRecommendations</a> or <a>ExportEC2InstanceRecommendations</a> actions.</p> <p>All export jobs created in the last seven days are returned if this parameter is omitted.</p>
filters: <p>An array of objects to specify a filter that returns a more specific list of export jobs.</p>
next_token: <p>The token to advance to the next page of export jobs.</p>
max_results: <p>The maximum number of export jobs to return with a single request.</p> <p>To retrieve the remaining results, make another request with the returned <code>nextToken</code> value.</p>
Raises:
capo_compute_optimizer.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
capo_compute_optimizer.errors.internal_server_exception.InternalServerException: <p>An internal error has occurred. Try your call again.</p>
capo_compute_optimizer.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>The value supplied for the input parameter is out of range or not valid.</p>
capo_compute_optimizer.errors.missing_authentication_token.MissingAuthenticationToken: <p>The request must contain either a valid (registered) Amazon Web Services access key ID or X.509 certificate.</p>
capo_compute_optimizer.errors.opt_in_required_exception.OptInRequiredException: <p>The account is not opted in to Compute Optimizer.</p>
capo_compute_optimizer.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action doesn't exist.</p>
capo_compute_optimizer.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request has failed due to a temporary failure of the server.</p>
capo_compute_optimizer.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
capo_compute_optimizer.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_compute_optimizer.types.describe_recommendation_export_jobs_request.DescribeRecommendationExportJobsRequest]",
) -> AsyncOperationResponse[
"capo_compute_optimizer.types.describe_recommendation_export_jobs_response.DescribeRecommendationExportJobsResponse"
]:
import capo_compute_optimizer._operations.compute_optimizer_service.describe_recommendation_export_jobs
(
output,
http_response,
) = await capo_compute_optimizer._operations.compute_optimizer_service.describe_recommendation_export_jobs.async_describe_recommendation_export_jobs(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeRecommendationExportJobs")
)
input_: capo_compute_optimizer.types.describe_recommendation_export_jobs_request.DescribeRecommendationExportJobsRequest = {}
if job_ids is not None:
input_["job_ids"] = job_ids
if filters is not None:
input_["filters"] = filters
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|