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

aws_sdk_workdocs/operation/
describe_groups.rs
