aws_sdk_qbusiness/operation/
get_group.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `GetGroup`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetGroup;
6impl GetGroup {
7    /// Creates a new `GetGroup`
8    pub fn new() -> Self {
9        Self
10    }
11    pub(crate) async fn orchestrate(
12        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
13        input: crate::operation::get_group::GetGroupInput,
14    ) -> ::std::result::Result<
15        crate::operation::get_group::GetGroupOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::get_group::GetGroupError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err =
22            |err: ::aws_smithy_runtime_api::client::result::SdkError<
23                ::aws_smithy_runtime_api::client::interceptors::context::Error,
24                ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
25            >| { err.map_service_error(|err| err.downcast::<crate::operation::get_group::GetGroupError>().expect("correct error type")) };
26        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
27            .await
28            .map_err(map_err)?;
29        let output = context.finalize().map_err(map_err)?;
30        ::std::result::Result::Ok(
31            output
32                .downcast::<crate::operation::get_group::GetGroupOutput>()
33                .expect("correct output type"),
34        )
35    }
36
37    pub(crate) async fn orchestrate_with_stop_point(
38        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
39        input: crate::operation::get_group::GetGroupInput,
40        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
41    ) -> ::std::result::Result<
42        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
43        ::aws_smithy_runtime_api::client::result::SdkError<
44            ::aws_smithy_runtime_api::client::interceptors::context::Error,
45            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
46        >,
47    > {
48        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
49        use ::tracing::Instrument;
50        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("QBusiness", "GetGroup", input, runtime_plugins, stop_point)
51            // Create a parent span for the entire operation. Includes a random, internal-only,
52            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
53            .instrument(::tracing::debug_span!(
54                "QBusiness.GetGroup",
55                "rpc.service" = "QBusiness",
56                "rpc.method" = "GetGroup",
57                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
58                "rpc.system" = "aws-api",
59            ))
60            .await
61    }
62
63    pub(crate) fn operation_runtime_plugins(
64        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
65        client_config: &crate::config::Config,
66        config_override: ::std::option::Option<crate::config::Builder>,
67    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
68        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
69
70        if let ::std::option::Option::Some(config_override) = config_override {
71            for plugin in config_override.runtime_plugins.iter().cloned() {
72                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
73            }
74            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
75                config_override,
76                client_config.config.clone(),
77                &client_config.runtime_components,
78            ));
79        }
80        runtime_plugins
81    }
82}
83impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for GetGroup {
84    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
85        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetGroup");
86
87        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
88            GetGroupRequestSerializer,
89        ));
90        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
91            GetGroupResponseDeserializer,
92        ));
93
94        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
95            crate::config::auth::Params::builder()
96                .operation_name("GetGroup")
97                .build()
98                .expect("required fields set"),
99        ));
100
101        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("GetGroup", "QBusiness"));
102        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
103        signing_options.double_uri_encode = true;
104        signing_options.content_sha256_header = false;
105        signing_options.normalize_uri_path = true;
106        signing_options.payload_override = None;
107
108        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
109            signing_options,
110            ..::std::default::Default::default()
111        });
112
113        ::std::option::Option::Some(cfg.freeze())
114    }
115
116    fn runtime_components(
117        &self,
118        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
119    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
120        #[allow(unused_mut)]
121        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("GetGroup")
122            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
123            .with_interceptor(GetGroupEndpointParamsInterceptor)
124            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
125                crate::operation::get_group::GetGroupError,
126            >::new())
127            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
128                crate::operation::get_group::GetGroupError,
129            >::new())
130            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
131                crate::operation::get_group::GetGroupError,
132            >::new());
133
134        ::std::borrow::Cow::Owned(rcb)
135    }
136}
137
138#[derive(Debug)]
139struct GetGroupResponseDeserializer;
140impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetGroupResponseDeserializer {
141    fn deserialize_nonstreaming(
142        &self,
143        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
144    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
145        let (success, status) = (response.status().is_success(), response.status().as_u16());
146        let headers = response.headers();
147        let body = response.body().bytes().expect("body loaded");
148        #[allow(unused_mut)]
149        let mut force_error = false;
150        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
151        let parse_result = if !success && status != 200 || force_error {
152            crate::protocol_serde::shape_get_group::de_get_group_http_error(status, headers, body)
153        } else {
154            crate::protocol_serde::shape_get_group::de_get_group_http_response(status, headers, body)
155        };
156        crate::protocol_serde::type_erase_result(parse_result)
157    }
158}
159#[derive(Debug)]
160struct GetGroupRequestSerializer;
161impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetGroupRequestSerializer {
162    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
163    fn serialize_input(
164        &self,
165        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
166        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
167    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
168        let input = input.downcast::<crate::operation::get_group::GetGroupInput>().expect("correct type");
169        let _header_serialization_settings = _cfg
170            .load::<crate::serialization_settings::HeaderSerializationSettings>()
171            .cloned()
172            .unwrap_or_default();
173        let mut request_builder = {
174            #[allow(clippy::uninlined_format_args)]
175            fn uri_base(
176                _input: &crate::operation::get_group::GetGroupInput,
177                output: &mut ::std::string::String,
178            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
179                use ::std::fmt::Write as _;
180                let input_1 = &_input.application_id;
181                let input_1 = input_1
182                    .as_ref()
183                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("application_id", "cannot be empty or unset"))?;
184                let application_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
185                if application_id.is_empty() {
186                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
187                        "application_id",
188                        "cannot be empty or unset",
189                    ));
190                }
191                let input_2 = &_input.index_id;
192                let input_2 = input_2
193                    .as_ref()
194                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("index_id", "cannot be empty or unset"))?;
195                let index_id = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
196                if index_id.is_empty() {
197                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
198                        "index_id",
199                        "cannot be empty or unset",
200                    ));
201                }
202                let input_3 = &_input.group_name;
203                let input_3 = input_3
204                    .as_ref()
205                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("group_name", "cannot be empty or unset"))?;
206                let group_name = ::aws_smithy_http::label::fmt_string(input_3, ::aws_smithy_http::label::EncodingStrategy::Default);
207                if group_name.is_empty() {
208                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
209                        "group_name",
210                        "cannot be empty or unset",
211                    ));
212                }
213                ::std::write!(
214                    output,
215                    "/applications/{applicationId}/indices/{indexId}/groups/{groupName}",
216                    applicationId = application_id,
217                    indexId = index_id,
218                    groupName = group_name
219                )
220                .expect("formatting should succeed");
221                ::std::result::Result::Ok(())
222            }
223            fn uri_query(
224                _input: &crate::operation::get_group::GetGroupInput,
225                mut output: &mut ::std::string::String,
226            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
227                let mut query = ::aws_smithy_http::query::Writer::new(output);
228                if let ::std::option::Option::Some(inner_4) = &_input.data_source_id {
229                    {
230                        query.push_kv("dataSourceId", &::aws_smithy_http::query::fmt_string(inner_4));
231                    }
232                }
233                ::std::result::Result::Ok(())
234            }
235            #[allow(clippy::unnecessary_wraps)]
236            fn update_http_builder(
237                input: &crate::operation::get_group::GetGroupInput,
238                builder: ::http::request::Builder,
239            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
240                let mut uri = ::std::string::String::new();
241                uri_base(input, &mut uri)?;
242                uri_query(input, &mut uri)?;
243                ::std::result::Result::Ok(builder.method("GET").uri(uri))
244            }
245            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
246            builder
247        };
248        let body = ::aws_smithy_types::body::SdkBody::from("");
249
250        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
251    }
252}
253#[derive(Debug)]
254struct GetGroupEndpointParamsInterceptor;
255
256impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetGroupEndpointParamsInterceptor {
257    fn name(&self) -> &'static str {
258        "GetGroupEndpointParamsInterceptor"
259    }
260
261    fn read_before_execution(
262        &self,
263        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
264            '_,
265            ::aws_smithy_runtime_api::client::interceptors::context::Input,
266            ::aws_smithy_runtime_api::client::interceptors::context::Output,
267            ::aws_smithy_runtime_api::client::interceptors::context::Error,
268        >,
269        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
270    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
271        let _input = context
272            .input()
273            .downcast_ref::<GetGroupInput>()
274            .ok_or("failed to downcast to GetGroupInput")?;
275
276        let params = crate::config::endpoint::Params::builder()
277            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
278            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
279            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
280            .build()
281            .map_err(|err| {
282                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
283            })?;
284        cfg.interceptor_state()
285            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
286        ::std::result::Result::Ok(())
287    }
288}
289
290// The get_* functions below are generated from JMESPath expressions in the
291// operationContextParams trait. They target the operation's input shape.
292
293/// Error type for the `GetGroupError` operation.
294#[non_exhaustive]
295#[derive(::std::fmt::Debug)]
296pub enum GetGroupError {
297    /// <p>You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
298    AccessDeniedException(crate::types::error::AccessDeniedException),
299    /// <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
300    ConflictException(crate::types::error::ConflictException),
301    /// <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
302    InternalServerException(crate::types::error::InternalServerException),
303    /// <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
304    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
305    /// <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
306    ThrottlingException(crate::types::error::ThrottlingException),
307    /// <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
308    ValidationException(crate::types::error::ValidationException),
309    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
310    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
311    variable wildcard pattern and check `.code()`:
312     \
313    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
314     \
315    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetGroupError) for what information is available for the error.")]
316    Unhandled(crate::error::sealed_unhandled::Unhandled),
317}
318impl GetGroupError {
319    /// Creates the `GetGroupError::Unhandled` variant from any error type.
320    pub fn unhandled(
321        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
322    ) -> Self {
323        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
324            source: err.into(),
325            meta: ::std::default::Default::default(),
326        })
327    }
328
329    /// Creates the `GetGroupError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
330    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
331        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
332            source: err.clone().into(),
333            meta: err,
334        })
335    }
336    ///
337    /// Returns error metadata, which includes the error code, message,
338    /// request ID, and potentially additional information.
339    ///
340    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
341        match self {
342            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
343            Self::ConflictException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
344            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
345            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
346            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
347            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
348            Self::Unhandled(e) => &e.meta,
349        }
350    }
351    /// Returns `true` if the error kind is `GetGroupError::AccessDeniedException`.
352    pub fn is_access_denied_exception(&self) -> bool {
353        matches!(self, Self::AccessDeniedException(_))
354    }
355    /// Returns `true` if the error kind is `GetGroupError::ConflictException`.
356    pub fn is_conflict_exception(&self) -> bool {
357        matches!(self, Self::ConflictException(_))
358    }
359    /// Returns `true` if the error kind is `GetGroupError::InternalServerException`.
360    pub fn is_internal_server_exception(&self) -> bool {
361        matches!(self, Self::InternalServerException(_))
362    }
363    /// Returns `true` if the error kind is `GetGroupError::ResourceNotFoundException`.
364    pub fn is_resource_not_found_exception(&self) -> bool {
365        matches!(self, Self::ResourceNotFoundException(_))
366    }
367    /// Returns `true` if the error kind is `GetGroupError::ThrottlingException`.
368    pub fn is_throttling_exception(&self) -> bool {
369        matches!(self, Self::ThrottlingException(_))
370    }
371    /// Returns `true` if the error kind is `GetGroupError::ValidationException`.
372    pub fn is_validation_exception(&self) -> bool {
373        matches!(self, Self::ValidationException(_))
374    }
375}
376impl ::std::error::Error for GetGroupError {
377    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
378        match self {
379            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
380            Self::ConflictException(_inner) => ::std::option::Option::Some(_inner),
381            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
382            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
383            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
384            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
385            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
386        }
387    }
388}
389impl ::std::fmt::Display for GetGroupError {
390    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
391        match self {
392            Self::AccessDeniedException(_inner) => _inner.fmt(f),
393            Self::ConflictException(_inner) => _inner.fmt(f),
394            Self::InternalServerException(_inner) => _inner.fmt(f),
395            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
396            Self::ThrottlingException(_inner) => _inner.fmt(f),
397            Self::ValidationException(_inner) => _inner.fmt(f),
398            Self::Unhandled(_inner) => {
399                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
400                    write!(f, "unhandled error ({code})")
401                } else {
402                    f.write_str("unhandled error")
403                }
404            }
405        }
406    }
407}
408impl ::aws_smithy_types::retry::ProvideErrorKind for GetGroupError {
409    fn code(&self) -> ::std::option::Option<&str> {
410        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
411    }
412    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
413        ::std::option::Option::None
414    }
415}
416impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetGroupError {
417    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
418        match self {
419            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
420            Self::ConflictException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
421            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
422            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
423            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
424            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
425            Self::Unhandled(_inner) => &_inner.meta,
426        }
427    }
428}
429impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetGroupError {
430    fn create_unhandled_error(
431        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
432        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
433    ) -> Self {
434        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
435            source,
436            meta: meta.unwrap_or_default(),
437        })
438    }
439}
440impl ::aws_types::request_id::RequestId for crate::operation::get_group::GetGroupError {
441    fn request_id(&self) -> Option<&str> {
442        self.meta().request_id()
443    }
444}
445
446pub use crate::operation::get_group::_get_group_output::GetGroupOutput;
447
448pub use crate::operation::get_group::_get_group_input::GetGroupInput;
449
450mod _get_group_input;
451
452mod _get_group_output;
453
454/// Builders
455pub mod builders;