aws_sdk_elasticbeanstalk/client/retrieve_environment_info.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 [`RetrieveEnvironmentInfo`](crate::operation::retrieve_environment_info::builders::RetrieveEnvironmentInfoFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`environment_id(impl Into<String>)`](crate::operation::retrieve_environment_info::builders::RetrieveEnvironmentInfoFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::retrieve_environment_info::builders::RetrieveEnvironmentInfoFluentBuilder::set_environment_id):<br>required: **false**<br><p>The ID of the data's environment.</p> <p>If no such environment is found, returns an <code>InvalidParameterValue</code> error.</p> <p>Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.</p><br>
7 /// - [`environment_name(impl Into<String>)`](crate::operation::retrieve_environment_info::builders::RetrieveEnvironmentInfoFluentBuilder::environment_name) / [`set_environment_name(Option<String>)`](crate::operation::retrieve_environment_info::builders::RetrieveEnvironmentInfoFluentBuilder::set_environment_name):<br>required: **false**<br><p>The name of the data's environment.</p> <p>If no such environment is found, returns an <code>InvalidParameterValue</code> error.</p> <p>Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns <code>MissingRequiredParameter</code> error.</p><br>
8 /// - [`info_type(EnvironmentInfoType)`](crate::operation::retrieve_environment_info::builders::RetrieveEnvironmentInfoFluentBuilder::info_type) / [`set_info_type(Option<EnvironmentInfoType>)`](crate::operation::retrieve_environment_info::builders::RetrieveEnvironmentInfoFluentBuilder::set_info_type):<br>required: **true**<br><p>The type of information to retrieve.</p><br>
9 /// - On success, responds with [`RetrieveEnvironmentInfoOutput`](crate::operation::retrieve_environment_info::RetrieveEnvironmentInfoOutput) with field(s):
10 /// - [`environment_info(Option<Vec::<EnvironmentInfoDescription>>)`](crate::operation::retrieve_environment_info::RetrieveEnvironmentInfoOutput::environment_info): <p>The <code>EnvironmentInfoDescription</code> of the environment.</p>
11 /// - On failure, responds with [`SdkError<RetrieveEnvironmentInfoError>`](crate::operation::retrieve_environment_info::RetrieveEnvironmentInfoError)
12 pub fn retrieve_environment_info(&self) -> crate::operation::retrieve_environment_info::builders::RetrieveEnvironmentInfoFluentBuilder {
13 crate::operation::retrieve_environment_info::builders::RetrieveEnvironmentInfoFluentBuilder::new(self.handle.clone())
14 }
15}