aws_sdk_arcregionswitch/client/
list_plan_executions.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 [`ListPlanExecutions`](crate::operation::list_plan_executions::builders::ListPlanExecutionsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_plan_executions::builders::ListPlanExecutionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`plan_arn(impl Into<String>)`](crate::operation::list_plan_executions::builders::ListPlanExecutionsFluentBuilder::plan_arn) / [`set_plan_arn(Option<String>)`](crate::operation::list_plan_executions::builders::ListPlanExecutionsFluentBuilder::set_plan_arn):<br>required: **true**<br><p>The ARN for the plan.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_plan_executions::builders::ListPlanExecutionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_plan_executions::builders::ListPlanExecutionsFluentBuilder::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::list_plan_executions::builders::ListPlanExecutionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_plan_executions::builders::ListPlanExecutionsFluentBuilder::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    ///   - [`state(ExecutionState)`](crate::operation::list_plan_executions::builders::ListPlanExecutionsFluentBuilder::state) / [`set_state(Option<ExecutionState>)`](crate::operation::list_plan_executions::builders::ListPlanExecutionsFluentBuilder::set_state):<br>required: **false**<br><p>The state of the plan execution. For example, the plan execution might be In Progress.</p><br>
11    /// - On success, responds with [`ListPlanExecutionsOutput`](crate::operation::list_plan_executions::ListPlanExecutionsOutput) with field(s):
12    ///   - [`items(Option<Vec::<AbbreviatedExecution>>)`](crate::operation::list_plan_executions::ListPlanExecutionsOutput::items): <p>The items in the plan execution to return.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_plan_executions::ListPlanExecutionsOutput::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>
14    /// - On failure, responds with [`SdkError<ListPlanExecutionsError>`](crate::operation::list_plan_executions::ListPlanExecutionsError)
15    pub fn list_plan_executions(&self) -> crate::operation::list_plan_executions::builders::ListPlanExecutionsFluentBuilder {
16        crate::operation::list_plan_executions::builders::ListPlanExecutionsFluentBuilder::new(self.handle.clone())
17    }
18}