aws_sdk_qbusiness/operation/
list_groups.rs

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

aws_sdk_qbusiness/operation/
list_groups.rs
