aws_sdk_qbusiness/client/
get_group.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 [`GetGroup`](crate::operation::get_group::builders::GetGroupFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`application_id(impl Into<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::application_id) / [`set_application_id(Option<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::set_application_id):<br>required: **true**<br><p>The identifier of the application id the group is attached to.</p><br>
7    ///   - [`index_id(impl Into<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::index_id) / [`set_index_id(Option<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::set_index_id):<br>required: **true**<br><p>The identifier of the index the group is attached to.</p><br>
8    ///   - [`group_name(impl Into<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::group_name) / [`set_group_name(Option<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::set_group_name):<br>required: **true**<br><p>The name of the group.</p><br>
9    ///   - [`data_source_id(impl Into<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::data_source_id) / [`set_data_source_id(Option<String>)`](crate::operation::get_group::builders::GetGroupFluentBuilder::set_data_source_id):<br>required: **false**<br><p>The identifier of the data source the group is attached to.</p><br>
10    /// - On success, responds with [`GetGroupOutput`](crate::operation::get_group::GetGroupOutput) with field(s):
11    ///   - [`status(Option<GroupStatusDetail>)`](crate::operation::get_group::GetGroupOutput::status): <p>The current status of the group.</p>
12    ///   - [`status_history(Option<Vec::<GroupStatusDetail>>)`](crate::operation::get_group::GetGroupOutput::status_history): <p>The status history of the group.</p>
13    /// - On failure, responds with [`SdkError<GetGroupError>`](crate::operation::get_group::GetGroupError)
14    pub fn get_group(&self) -> crate::operation::get_group::builders::GetGroupFluentBuilder {
15        crate::operation::get_group::builders::GetGroupFluentBuilder::new(self.handle.clone())
16    }
17}