aws_sdk_elasticbeanstalk/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 /// - [`application_name(impl Into<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::application_name) / [`set_application_name(Option<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_application_name):<br>required: **false**<br><p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those associated with this application.</p><br>
8 /// - [`version_label(impl Into<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::version_label) / [`set_version_label(Option<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_version_label):<br>required: **false**<br><p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this application version.</p><br>
9 /// - [`template_name(impl Into<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::template_name) / [`set_template_name(Option<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_template_name):<br>required: **false**<br><p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that are associated with this environment configuration.</p><br>
10 /// - [`environment_id(impl Into<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_environment_id):<br>required: **false**<br><p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.</p><br>
11 /// - [`environment_name(impl Into<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::environment_name) / [`set_environment_name(Option<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_environment_name):<br>required: **false**<br><p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this environment.</p><br>
12 /// - [`platform_arn(impl Into<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::platform_arn) / [`set_platform_arn(Option<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_platform_arn):<br>required: **false**<br><p>The ARN of a custom platform version. If specified, AWS Elastic Beanstalk restricts the returned descriptions to those associated with this custom platform version.</p><br>
13 /// - [`request_id(impl Into<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::request_id) / [`set_request_id(Option<String>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_request_id):<br>required: **false**<br><p>If specified, AWS Elastic Beanstalk restricts the described events to include only those associated with this request ID.</p><br>
14 /// - [`severity(EventSeverity)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::severity) / [`set_severity(Option<EventSeverity>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_severity):<br>required: **false**<br><p>If specified, limits the events returned from this call to include only those with the specified severity or higher.</p><br>
15 /// - [`start_time(DateTime)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_start_time):<br>required: **false**<br><p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur on or after this time.</p><br>
16 /// - [`end_time(DateTime)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_end_time):<br>required: **false**<br><p>If specified, AWS Elastic Beanstalk restricts the returned descriptions to those that occur up to, but not including, the <code>EndTime</code>.</p><br>
17 /// - [`max_records(i32)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_events::builders::DescribeEventsFluentBuilder::set_max_records):<br>required: **false**<br><p>Specifies the maximum number of events that can be returned, beginning with the most recent event.</p><br>
18 /// - [`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>Pagination token. If specified, the events return the next batch of results.</p><br>
19 /// - On success, responds with [`DescribeEventsOutput`](crate::operation::describe_events::DescribeEventsOutput) with field(s):
20 /// - [`events(Option<Vec::<EventDescription>>)`](crate::operation::describe_events::DescribeEventsOutput::events): <p>A list of <code>EventDescription</code>.</p>
21 /// - [`next_token(Option<String>)`](crate::operation::describe_events::DescribeEventsOutput::next_token): <p>If returned, this indicates that there are more results to obtain. Use this token in the next <code>DescribeEvents</code> call to get the next batch of events.</p>
22 /// - On failure, responds with [`SdkError<DescribeEventsError>`](crate::operation::describe_events::DescribeEventsError)
23 pub fn describe_events(&self) -> crate::operation::describe_events::builders::DescribeEventsFluentBuilder {
24 crate::operation::describe_events::builders::DescribeEventsFluentBuilder::new(self.handle.clone())
25 }
26}