aws_sdk_opensearch/client/
get_application.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 [`GetApplication`](crate::operation::get_application::builders::GetApplicationFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`id(impl Into<String>)`](crate::operation::get_application::builders::GetApplicationFluentBuilder::id) / [`set_id(Option<String>)`](crate::operation::get_application::builders::GetApplicationFluentBuilder::set_id):<br>required: **true**<br><p>The unique identifier of the OpenSearch application to retrieve.</p><br>
7    /// - On success, responds with [`GetApplicationOutput`](crate::operation::get_application::GetApplicationOutput) with field(s):
8    ///   - [`id(Option<String>)`](crate::operation::get_application::GetApplicationOutput::id): <p>The unique identifier of the OpenSearch application.</p>
9    ///   - [`arn(Option<String>)`](crate::operation::get_application::GetApplicationOutput::arn): <p>The Amazon Resource Name (ARN) of the domain. See <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/index.html">Identifiers for IAM Entities </a> in <i>Using Amazon Web Services Identity and Access Management</i> for more information.</p>
10    ///   - [`name(Option<String>)`](crate::operation::get_application::GetApplicationOutput::name): <p>The name of the OpenSearch application.</p>
11    ///   - [`endpoint(Option<String>)`](crate::operation::get_application::GetApplicationOutput::endpoint): <p>The endpoint URL of the OpenSearch application.</p>
12    ///   - [`status(Option<ApplicationStatus>)`](crate::operation::get_application::GetApplicationOutput::status): <p>The current status of the OpenSearch application. Possible values: <code>CREATING</code>, <code>UPDATING</code>, <code>DELETING</code>, <code>FAILED</code>, <code>ACTIVE</code>, and <code>DELETED</code>.</p>
13    ///   - [`iam_identity_center_options(Option<IamIdentityCenterOptions>)`](crate::operation::get_application::GetApplicationOutput::iam_identity_center_options): <p>The IAM Identity Center settings configured for the OpenSearch application.</p>
14    ///   - [`data_sources(Option<Vec::<DataSource>>)`](crate::operation::get_application::GetApplicationOutput::data_sources): <p>The data sources associated with the OpenSearch application.</p>
15    ///   - [`app_configs(Option<Vec::<AppConfig>>)`](crate::operation::get_application::GetApplicationOutput::app_configs): <p>The configuration settings of the OpenSearch application.</p>
16    ///   - [`created_at(Option<DateTime>)`](crate::operation::get_application::GetApplicationOutput::created_at): <p>The timestamp when the OpenSearch application was created.</p>
17    ///   - [`last_updated_at(Option<DateTime>)`](crate::operation::get_application::GetApplicationOutput::last_updated_at): <p>The timestamp of the last update to the OpenSearch application.</p>
18    /// - On failure, responds with [`SdkError<GetApplicationError>`](crate::operation::get_application::GetApplicationError)
19    pub fn get_application(&self) -> crate::operation::get_application::builders::GetApplicationFluentBuilder {
20        crate::operation::get_application::builders::GetApplicationFluentBuilder::new(self.handle.clone())
21    }
22}