aws_sdk_arcregionswitch/client/
list_plan_execution_events.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 [`ListPlanExecutionEvents`](crate::operation::list_plan_execution_events::builders::ListPlanExecutionEventsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_plan_execution_events::builders::ListPlanExecutionEventsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`plan_arn(impl Into<String>)`](crate::operation::list_plan_execution_events::builders::ListPlanExecutionEventsFluentBuilder::plan_arn) / [`set_plan_arn(Option<String>)`](crate::operation::list_plan_execution_events::builders::ListPlanExecutionEventsFluentBuilder::set_plan_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of the plan.</p><br>
8    ///   - [`execution_id(impl Into<String>)`](crate::operation::list_plan_execution_events::builders::ListPlanExecutionEventsFluentBuilder::execution_id) / [`set_execution_id(Option<String>)`](crate::operation::list_plan_execution_events::builders::ListPlanExecutionEventsFluentBuilder::set_execution_id):<br>required: **true**<br><p>The execution identifier of a plan execution.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_plan_execution_events::builders::ListPlanExecutionEventsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_plan_execution_events::builders::ListPlanExecutionEventsFluentBuilder::set_max_results):<br>required: **false**<br><p>The number of objects that you want to return with this call.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_plan_execution_events::builders::ListPlanExecutionEventsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_plan_execution_events::builders::ListPlanExecutionEventsFluentBuilder::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>
11    ///   - [`name(impl Into<String>)`](crate::operation::list_plan_execution_events::builders::ListPlanExecutionEventsFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::list_plan_execution_events::builders::ListPlanExecutionEventsFluentBuilder::set_name):<br>required: **false**<br><p>The name of the plan execution event.</p><br>
12    /// - On success, responds with [`ListPlanExecutionEventsOutput`](crate::operation::list_plan_execution_events::ListPlanExecutionEventsOutput) with field(s):
13    ///   - [`items(Option<Vec::<ExecutionEvent>>)`](crate::operation::list_plan_execution_events::ListPlanExecutionEventsOutput::items): <p>The items in the plan execution event.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_plan_execution_events::ListPlanExecutionEventsOutput::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>
15    /// - On failure, responds with [`SdkError<ListPlanExecutionEventsError>`](crate::operation::list_plan_execution_events::ListPlanExecutionEventsError)
16    pub fn list_plan_execution_events(&self) -> crate::operation::list_plan_execution_events::builders::ListPlanExecutionEventsFluentBuilder {
17        crate::operation::list_plan_execution_events::builders::ListPlanExecutionEventsFluentBuilder::new(self.handle.clone())
18    }
19}