aws-sdk-opensearch 1.121.0

AWS SDK for Amazon OpenSearch Service
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetCapability`](crate::operation::get_capability::builders::GetCapabilityFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`application_id(impl Into<String>)`](crate::operation::get_capability::builders::GetCapabilityFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::get_capability::builders::GetCapabilityFluentBuilder::set_application_id):<br>required: **true**<br><p>The unique identifier of the OpenSearch UI application.</p><br>
    ///   - [`capability_name(impl Into<String>)`](crate::operation::get_capability::builders::GetCapabilityFluentBuilder::capability_name) / [`set_capability_name(Option<String>)`](crate::operation::get_capability::builders::GetCapabilityFluentBuilder::set_capability_name):<br>required: **true**<br><p>The name of the capability to retrieve information about.</p><br>
    /// - On success, responds with [`GetCapabilityOutput`](crate::operation::get_capability::GetCapabilityOutput) with field(s):
    ///   - [`capability_name(Option<String>)`](crate::operation::get_capability::GetCapabilityOutput::capability_name): <p>The name of the capability.</p>
    ///   - [`application_id(Option<String>)`](crate::operation::get_capability::GetCapabilityOutput::application_id): <p>The unique identifier of the OpenSearch UI application.</p>
    ///   - [`status(Option<CapabilityStatus>)`](crate::operation::get_capability::GetCapabilityOutput::status): <p>The current status of the capability. Possible values: <code>creating</code>, <code>create_failed</code>, <code>active</code>, <code>updating</code>, <code>update_failed</code>, <code>deleting</code>, <code>delete_failed</code>.</p>
    ///   - [`capability_config(Option<CapabilityExtendedResponseConfig>)`](crate::operation::get_capability::GetCapabilityOutput::capability_config): <p>The configuration settings for the capability, including capability-specific settings such as AI configuration.</p>
    ///   - [`failures(Option<Vec::<CapabilityFailure>>)`](crate::operation::get_capability::GetCapabilityOutput::failures): <p>A list of failures associated with the capability, if any. Each failure includes a reason and details about what went wrong.</p>
    /// - On failure, responds with [`SdkError<GetCapabilityError>`](crate::operation::get_capability::GetCapabilityError)
    pub fn get_capability(&self) -> crate::operation::get_capability::builders::GetCapabilityFluentBuilder {
        crate::operation::get_capability::builders::GetCapabilityFluentBuilder::new(self.handle.clone())
    }
}