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

aws_sdk_workdocs/operation/
describe_groups.rs
