aws_sdk_arcregionswitch/client/get_plan_evaluation_status.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`GetPlanEvaluationStatus`](crate::operation::get_plan_evaluation_status::builders::GetPlanEvaluationStatusFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::get_plan_evaluation_status::builders::GetPlanEvaluationStatusFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`plan_arn(impl Into<String>)`](crate::operation::get_plan_evaluation_status::builders::GetPlanEvaluationStatusFluentBuilder::plan_arn) / [`set_plan_arn(Option<String>)`](crate::operation::get_plan_evaluation_status::builders::GetPlanEvaluationStatusFluentBuilder::set_plan_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the Region switch plan to retrieve evaluation status for.</p><br>
8 /// - [`max_results(i32)`](crate::operation::get_plan_evaluation_status::builders::GetPlanEvaluationStatusFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::get_plan_evaluation_status::builders::GetPlanEvaluationStatusFluentBuilder::set_max_results):<br>required: **false**<br><p>The number of objects that you want to return with this call.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::get_plan_evaluation_status::builders::GetPlanEvaluationStatusFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::get_plan_evaluation_status::builders::GetPlanEvaluationStatusFluentBuilder::set_next_token):<br>required: **false**<br><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><br>
10 /// - On success, responds with [`GetPlanEvaluationStatusOutput`](crate::operation::get_plan_evaluation_status::GetPlanEvaluationStatusOutput) with field(s):
11 /// - [`plan_arn(String)`](crate::operation::get_plan_evaluation_status::GetPlanEvaluationStatusOutput::plan_arn): <p>The Amazon Resource Name (ARN) of the plan.</p>
12 /// - [`last_evaluation_time(Option<DateTime>)`](crate::operation::get_plan_evaluation_status::GetPlanEvaluationStatusOutput::last_evaluation_time): <p>The time of the last time that Region switch ran an evaluation of the plan.</p>
13 /// - [`last_evaluated_version(Option<String>)`](crate::operation::get_plan_evaluation_status::GetPlanEvaluationStatusOutput::last_evaluated_version): <p>The version of the last evaluation of the plan.</p>
14 /// - [`region(Option<String>)`](crate::operation::get_plan_evaluation_status::GetPlanEvaluationStatusOutput::region): <p>The Amazon Web Services Region for the plan.</p>
15 /// - [`evaluation_state(Option<EvaluationStatus>)`](crate::operation::get_plan_evaluation_status::GetPlanEvaluationStatusOutput::evaluation_state): <p>The evaluation state for the plan.</p>
16 /// - [`warnings(Option<Vec::<ResourceWarning>>)`](crate::operation::get_plan_evaluation_status::GetPlanEvaluationStatusOutput::warnings): <p>The current evaluation warnings for the plan.</p>
17 /// - [`next_token(Option<String>)`](crate::operation::get_plan_evaluation_status::GetPlanEvaluationStatusOutput::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>
18 /// - On failure, responds with [`SdkError<GetPlanEvaluationStatusError>`](crate::operation::get_plan_evaluation_status::GetPlanEvaluationStatusError)
19 pub fn get_plan_evaluation_status(&self) -> crate::operation::get_plan_evaluation_status::builders::GetPlanEvaluationStatusFluentBuilder {
20 crate::operation::get_plan_evaluation_status::builders::GetPlanEvaluationStatusFluentBuilder::new(self.handle.clone())
21 }
22}