Retrieves the evaluation status of a Region switch plan. The evaluation status provides information about the last time the plan was evaluated and any warnings or issues detected.
Parameters:
-
plan_arn
(PlanArn)
–
The Amazon Resource Name (ARN) of the Region switch plan to retrieve evaluation status for.
-
max_results
(Optional[MaxResults], default:
None
)
–
The number of objects that you want to return with this call.
-
next_token
(Optional[NextToken], default:
None
)
–
Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.
Raises:
Source code in docs_src/capo_arc_region_switch/_services/arc_regionswitch.py
| def get_plan_evaluation_status(
self,
plan_arn: "capo_arc_region_switch.types.plan_arn.PlanArn",
*,
config_overrides: Optional[ARCRegionswitchClientConfig] = None,
max_results: Optional[
"capo_arc_region_switch.types.max_results.MaxResults"
] = None,
next_token: Optional[
"capo_arc_region_switch.types.next_token.NextToken"
] = None,
) -> "capo_arc_region_switch.types.get_plan_evaluation_status_response.GetPlanEvaluationStatusResponse":
"""<p>Retrieves the evaluation status of a Region switch plan. The evaluation status provides information about the last time the plan was evaluated and any warnings or issues detected.</p>
Args:
plan_arn: <p>The Amazon Resource Name (ARN) of the Region switch plan to retrieve evaluation status for.</p>
max_results: <p>The number of objects that you want to return with this call.</p>
next_token: <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>nextToken</code> response to request the next page of results.</p>
Raises:
capo_arc_region_switch.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p> <p>HTTP Status Code: 403</p>
capo_arc_region_switch.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p> <p>HTTP Status Code: 404</p>
capo_arc_region_switch.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_arc_region_switch.types.get_plan_evaluation_status_request.GetPlanEvaluationStatusRequest]",
) -> OperationResponse[
"capo_arc_region_switch.types.get_plan_evaluation_status_response.GetPlanEvaluationStatusResponse"
]:
import capo_arc_region_switch._operations.arc_region_switch.get_plan_evaluation_status
output, http_response = (
capo_arc_region_switch._operations.arc_region_switch.get_plan_evaluation_status.get_plan_evaluation_status(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("GetPlanEvaluationStatus")
)
input_: capo_arc_region_switch.types.get_plan_evaluation_status_request.GetPlanEvaluationStatusRequest = {
"plan_arn": plan_arn
}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|