aws_sdk_cloudformation/client/
describe_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 [`DescribeEvents`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`stack_name(impl Into<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::stack_name) / [`set_stack_name(Option<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_stack_name):<br>required: **false**<br><p>The name or unique stack ID for which you want to retrieve events.</p><br>
8    ///   - [`change_set_name(impl Into<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::change_set_name) / [`set_change_set_name(Option<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_change_set_name):<br>required: **false**<br><p>The name or Amazon Resource Name (ARN) of the change set for which you want to retrieve events.</p><br>
9    ///   - [`operation_id(impl Into<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::operation_id) / [`set_operation_id(Option<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_operation_id):<br>required: **false**<br><p>The unique identifier of the operation for which you want to retrieve events.</p><br>
10    ///   - [`filters(EventFilter)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::filters) / [`set_filters(Option<EventFilter>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_filters):<br>required: **false**<br><p>Filters to apply when retrieving events.</p><br>
11    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of items to return. (You received this token from a previous call.)</p><br>
12    /// - On success, responds with [`DescribeEventsOutput`](crate::operation::describe_events::DescribeEventsOutput) with field(s):
13    ///   - [`operation_events(Option<Vec::<OperationEvent>>)`](crate::operation::describe_events::DescribeEventsOutput::operation_events): <p>A list of operation events that match the specified criteria.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::describe_events::DescribeEventsOutput::next_token): <p>If the request doesn't return all the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>DescribeEvents</code> again and assign that token to the request object's <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>
15    /// - On failure, responds with [`SdkError<DescribeEventsError>`](crate::operation::describe_events::DescribeEventsError)
16    pub fn describe_events(&self) -> crate::operation::describe_events::builders::DescribeEventsFluentBuilder {
17        crate::operation::describe_events::builders::DescribeEventsFluentBuilder::new(self.handle.clone())
18    }
19}