aws_sdk_workdocs/operation/
describe_groups.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeGroups`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeGroups;
6impl DescribeGroups {
7    /// Creates a new `DescribeGroups`
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::describe_groups::DescribeGroupsInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_groups::DescribeGroupsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_groups::DescribeGroupsError,
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::describe_groups::DescribeGroupsError>()
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::describe_groups::DescribeGroupsOutput>()
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::describe_groups::DescribeGroupsInput,
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("WorkDocs", "DescribeGroups", 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                "WorkDocs.DescribeGroups",
59                "rpc.service" = "WorkDocs",
60                "rpc.method" = "DescribeGroups",
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 DescribeGroups {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeGroups");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            DescribeGroupsRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            DescribeGroupsResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("DescribeGroups")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "DescribeGroups",
107            "WorkDocs",
108        ));
109        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
110        signing_options.double_uri_encode = true;
111        signing_options.content_sha256_header = false;
112        signing_options.normalize_uri_path = true;
113        signing_options.payload_override = None;
114
115        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
116            signing_options,
117            ..::std::default::Default::default()
118        });
119
120        ::std::option::Option::Some(cfg.freeze())
121    }
122
123    fn runtime_components(
124        &self,
125        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
126    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
127        #[allow(unused_mut)]
128        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeGroups")
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
131            ))
132            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
133                DescribeGroupsEndpointParamsInterceptor,
134            ))
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
136                crate::operation::describe_groups::DescribeGroupsError,
137            >::new())
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
139                crate::operation::describe_groups::DescribeGroupsError,
140            >::new())
141            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
142                crate::operation::describe_groups::DescribeGroupsError,
143            >::new());
144
145        ::std::borrow::Cow::Owned(rcb)
146    }
147}
148
149#[derive(Debug)]
150struct DescribeGroupsResponseDeserializer;
151impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeGroupsResponseDeserializer {
152    fn deserialize_nonstreaming(
153        &self,
154        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
155    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
156        let (success, status) = (response.status().is_success(), response.status().as_u16());
157        let headers = response.headers();
158        let body = response.body().bytes().expect("body loaded");
159        #[allow(unused_mut)]
160        let mut force_error = false;
161        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
162        let parse_result = if !success && status != 200 || force_error {
163            crate::protocol_serde::shape_describe_groups::de_describe_groups_http_error(status, headers, body)
164        } else {
165            crate::protocol_serde::shape_describe_groups::de_describe_groups_http_response(status, headers, body)
166        };
167        crate::protocol_serde::type_erase_result(parse_result)
168    }
169}
170#[derive(Debug)]
171struct DescribeGroupsRequestSerializer;
172impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeGroupsRequestSerializer {
173    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
174    fn serialize_input(
175        &self,
176        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
177        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
178    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
179        let input = input
180            .downcast::<crate::operation::describe_groups::DescribeGroupsInput>()
181            .expect("correct type");
182        let _header_serialization_settings = _cfg
183            .load::<crate::serialization_settings::HeaderSerializationSettings>()
184            .cloned()
185            .unwrap_or_default();
186        let mut request_builder = {
187            #[allow(clippy::uninlined_format_args)]
188            fn uri_base(
189                _input: &crate::operation::describe_groups::DescribeGroupsInput,
190                output: &mut ::std::string::String,
191            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
192                use ::std::fmt::Write as _;
193                ::std::write!(output, "/api/v1/groups").expect("formatting should succeed");
194                ::std::result::Result::Ok(())
195            }
196            fn uri_query(
197                _input: &crate::operation::describe_groups::DescribeGroupsInput,
198                mut output: &mut ::std::string::String,
199            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
200                let mut query = ::aws_smithy_http::query::Writer::new(output);
201                let inner_1 = &_input.search_query;
202                let inner_1 = inner_1
203                    .as_ref()
204                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("search_query", "cannot be empty or unset"))?;
205                if inner_1.is_empty() {
206                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
207                        "search_query",
208                        "cannot be empty or unset",
209                    ));
210                }
211                query.push_kv("searchQuery", &::aws_smithy_http::query::fmt_string(inner_1));
212                if let ::std::option::Option::Some(inner_2) = &_input.organization_id {
213                    {
214                        query.push_kv("organizationId", &::aws_smithy_http::query::fmt_string(inner_2));
215                    }
216                }
217                if let ::std::option::Option::Some(inner_3) = &_input.marker {
218                    {
219                        query.push_kv("marker", &::aws_smithy_http::query::fmt_string(inner_3));
220                    }
221                }
222                if let ::std::option::Option::Some(inner_4) = &_input.limit {
223                    {
224                        query.push_kv("limit", ::aws_smithy_types::primitive::Encoder::from(*inner_4).encode());
225                    }
226                }
227                ::std::result::Result::Ok(())
228            }
229            #[allow(clippy::unnecessary_wraps)]
230            fn update_http_builder(
231                input: &crate::operation::describe_groups::DescribeGroupsInput,
232                builder: ::http_1x::request::Builder,
233            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
234                let mut uri = ::std::string::String::new();
235                uri_base(input, &mut uri)?;
236                uri_query(input, &mut uri)?;
237                let builder = crate::protocol_serde::shape_describe_groups::ser_describe_groups_headers(input, builder)?;
238                ::std::result::Result::Ok(builder.method("GET").uri(uri))
239            }
240            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
241            builder
242        };
243        let body = ::aws_smithy_types::body::SdkBody::from("");
244
245        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
246    }
247}
248#[derive(Debug)]
249struct DescribeGroupsEndpointParamsInterceptor;
250
251#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
252impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeGroupsEndpointParamsInterceptor {
253    fn name(&self) -> &'static str {
254        "DescribeGroupsEndpointParamsInterceptor"
255    }
256
257    fn read_before_execution(
258        &self,
259        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
260            '_,
261            ::aws_smithy_runtime_api::client::interceptors::context::Input,
262            ::aws_smithy_runtime_api::client::interceptors::context::Output,
263            ::aws_smithy_runtime_api::client::interceptors::context::Error,
264        >,
265        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
266    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
267        let _input = context
268            .input()
269            .downcast_ref::<DescribeGroupsInput>()
270            .ok_or("failed to downcast to DescribeGroupsInput")?;
271
272        let params = crate::config::endpoint::Params::builder()
273            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
274            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
275            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
276            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
277            .build()
278            .map_err(|err| {
279                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
280            })?;
281        cfg.interceptor_state()
282            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
283        ::std::result::Result::Ok(())
284    }
285}
286
287// The get_* functions below are generated from JMESPath expressions in the
288// operationContextParams trait. They target the operation's input shape.
289
290/// Error type for the `DescribeGroupsError` operation.
291#[non_exhaustive]
292#[derive(::std::fmt::Debug)]
293pub enum DescribeGroupsError {
294    /// <p>The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.</p>
295    FailedDependencyException(crate::types::error::FailedDependencyException),
296    /// <p>One or more of the dependencies is unavailable.</p>
297    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
298    /// <p>The operation is not permitted.</p>
299    UnauthorizedOperationException(crate::types::error::UnauthorizedOperationException),
300    /// <p>The caller does not have access to perform the action on the resource.</p>
301    UnauthorizedResourceAccessException(crate::types::error::UnauthorizedResourceAccessException),
302    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
303    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
304    variable wildcard pattern and check `.code()`:
305     \
306    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
307     \
308    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeGroupsError) for what information is available for the error.")]
309    Unhandled(crate::error::sealed_unhandled::Unhandled),
310}
311impl DescribeGroupsError {
312    /// Creates the `DescribeGroupsError::Unhandled` variant from any error type.
313    pub fn unhandled(
314        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
315    ) -> Self {
316        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
317            source: err.into(),
318            meta: ::std::default::Default::default(),
319        })
320    }
321
322    /// Creates the `DescribeGroupsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
323    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
324        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
325            source: err.clone().into(),
326            meta: err,
327        })
328    }
329    ///
330    /// Returns error metadata, which includes the error code, message,
331    /// request ID, and potentially additional information.
332    ///
333    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
334        match self {
335            Self::FailedDependencyException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
336            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
337            Self::UnauthorizedOperationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
338            Self::UnauthorizedResourceAccessException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
339            Self::Unhandled(e) => &e.meta,
340        }
341    }
342    /// Returns `true` if the error kind is `DescribeGroupsError::FailedDependencyException`.
343    pub fn is_failed_dependency_exception(&self) -> bool {
344        matches!(self, Self::FailedDependencyException(_))
345    }
346    /// Returns `true` if the error kind is `DescribeGroupsError::ServiceUnavailableException`.
347    pub fn is_service_unavailable_exception(&self) -> bool {
348        matches!(self, Self::ServiceUnavailableException(_))
349    }
350    /// Returns `true` if the error kind is `DescribeGroupsError::UnauthorizedOperationException`.
351    pub fn is_unauthorized_operation_exception(&self) -> bool {
352        matches!(self, Self::UnauthorizedOperationException(_))
353    }
354    /// Returns `true` if the error kind is `DescribeGroupsError::UnauthorizedResourceAccessException`.
355    pub fn is_unauthorized_resource_access_exception(&self) -> bool {
356        matches!(self, Self::UnauthorizedResourceAccessException(_))
357    }
358}
359impl ::std::error::Error for DescribeGroupsError {
360    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
361        match self {
362            Self::FailedDependencyException(_inner) => ::std::option::Option::Some(_inner),
363            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
364            Self::UnauthorizedOperationException(_inner) => ::std::option::Option::Some(_inner),
365            Self::UnauthorizedResourceAccessException(_inner) => ::std::option::Option::Some(_inner),
366            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
367        }
368    }
369}
370impl ::std::fmt::Display for DescribeGroupsError {
371    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
372        match self {
373            Self::FailedDependencyException(_inner) => _inner.fmt(f),
374            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
375            Self::UnauthorizedOperationException(_inner) => _inner.fmt(f),
376            Self::UnauthorizedResourceAccessException(_inner) => _inner.fmt(f),
377            Self::Unhandled(_inner) => {
378                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
379                    write!(f, "unhandled error ({code})")
380                } else {
381                    f.write_str("unhandled error")
382                }
383            }
384        }
385    }
386}
387impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeGroupsError {
388    fn code(&self) -> ::std::option::Option<&str> {
389        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
390    }
391    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
392        ::std::option::Option::None
393    }
394}
395impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeGroupsError {
396    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
397        match self {
398            Self::FailedDependencyException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
399            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
400            Self::UnauthorizedOperationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
401            Self::UnauthorizedResourceAccessException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
402            Self::Unhandled(_inner) => &_inner.meta,
403        }
404    }
405}
406impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeGroupsError {
407    fn create_unhandled_error(
408        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
409        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
410    ) -> Self {
411        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
412            source,
413            meta: meta.unwrap_or_default(),
414        })
415    }
416}
417impl ::aws_types::request_id::RequestId for crate::operation::describe_groups::DescribeGroupsError {
418    fn request_id(&self) -> Option<&str> {
419        self.meta().request_id()
420    }
421}
422
423pub use crate::operation::describe_groups::_describe_groups_input::DescribeGroupsInput;
424
425pub use crate::operation::describe_groups::_describe_groups_output::DescribeGroupsOutput;
426
427mod _describe_groups_input;
428
429mod _describe_groups_output;
430
431/// Builders
432pub mod builders;
433
434/// Paginator for this operation
435pub mod paginator;
aws_sdk_workdocs/operation/describe_groups.rs

aws_sdk_workdocs/operation/
describe_groups.rs
