aws_sdk_workmail/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("WorkMail", "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                "WorkMail.ListGroups",
59                "rpc.service" = "WorkMail",
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", "WorkMail"));
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            fn uri_base(
179                _input: &crate::operation::list_groups::ListGroupsInput,
180                output: &mut ::std::string::String,
181            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
182                use ::std::fmt::Write as _;
183                ::std::write!(output, "/").expect("formatting should succeed");
184                ::std::result::Result::Ok(())
185            }
186            #[allow(clippy::unnecessary_wraps)]
187            fn update_http_builder(
188                input: &crate::operation::list_groups::ListGroupsInput,
189                builder: ::http::request::Builder,
190            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
191                let mut uri = ::std::string::String::new();
192                uri_base(input, &mut uri)?;
193                ::std::result::Result::Ok(builder.method("POST").uri(uri))
194            }
195            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
196            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.1");
197            builder = _header_serialization_settings.set_default_header(
198                builder,
199                ::http::header::HeaderName::from_static("x-amz-target"),
200                "WorkMailService.ListGroups",
201            );
202            builder
203        };
204        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_list_groups::ser_list_groups_input(&input)?);
205        if let Some(content_length) = body.content_length() {
206            let content_length = content_length.to_string();
207            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
208        }
209        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
210    }
211}
212#[derive(Debug)]
213struct ListGroupsEndpointParamsInterceptor;
214
215impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListGroupsEndpointParamsInterceptor {
216    fn name(&self) -> &'static str {
217        "ListGroupsEndpointParamsInterceptor"
218    }
219
220    fn read_before_execution(
221        &self,
222        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
223            '_,
224            ::aws_smithy_runtime_api::client::interceptors::context::Input,
225            ::aws_smithy_runtime_api::client::interceptors::context::Output,
226            ::aws_smithy_runtime_api::client::interceptors::context::Error,
227        >,
228        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
229    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
230        let _input = context
231            .input()
232            .downcast_ref::<ListGroupsInput>()
233            .ok_or("failed to downcast to ListGroupsInput")?;
234
235        let params = crate::config::endpoint::Params::builder()
236            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
237            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
238            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
239            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
240            .build()
241            .map_err(|err| {
242                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
243            })?;
244        cfg.interceptor_state()
245            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
246        ::std::result::Result::Ok(())
247    }
248}
249
250// The get_* functions below are generated from JMESPath expressions in the
251// operationContextParams trait. They target the operation's input shape.
252
253/// Error type for the `ListGroupsError` operation.
254#[non_exhaustive]
255#[derive(::std::fmt::Debug)]
256pub enum ListGroupsError {
257    /// <p>The identifier supplied for the user, group, or resource does not exist in your organization.</p>
258    EntityNotFoundException(crate::types::error::EntityNotFoundException),
259    /// <p>One or more of the input parameters don't match the service's restrictions.</p>
260    InvalidParameterException(crate::types::error::InvalidParameterException),
261    /// <p>An operation received a valid organization identifier that either doesn't belong or exist in the system.</p>
262    OrganizationNotFoundException(crate::types::error::OrganizationNotFoundException),
263    /// <p>The organization must have a valid state to perform certain operations on the organization or its members.</p>
264    OrganizationStateException(crate::types::error::OrganizationStateException),
265    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
266    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
267    variable wildcard pattern and check `.code()`:
268     \
269    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
270     \
271    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListGroupsError) for what information is available for the error.")]
272    Unhandled(crate::error::sealed_unhandled::Unhandled),
273}
274impl ListGroupsError {
275    /// Creates the `ListGroupsError::Unhandled` variant from any error type.
276    pub fn unhandled(
277        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
278    ) -> Self {
279        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
280            source: err.into(),
281            meta: ::std::default::Default::default(),
282        })
283    }
284
285    /// Creates the `ListGroupsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
286    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
287        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
288            source: err.clone().into(),
289            meta: err,
290        })
291    }
292    ///
293    /// Returns error metadata, which includes the error code, message,
294    /// request ID, and potentially additional information.
295    ///
296    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
297        match self {
298            Self::EntityNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
299            Self::InvalidParameterException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
300            Self::OrganizationNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
301            Self::OrganizationStateException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
302            Self::Unhandled(e) => &e.meta,
303        }
304    }
305    /// Returns `true` if the error kind is `ListGroupsError::EntityNotFoundException`.
306    pub fn is_entity_not_found_exception(&self) -> bool {
307        matches!(self, Self::EntityNotFoundException(_))
308    }
309    /// Returns `true` if the error kind is `ListGroupsError::InvalidParameterException`.
310    pub fn is_invalid_parameter_exception(&self) -> bool {
311        matches!(self, Self::InvalidParameterException(_))
312    }
313    /// Returns `true` if the error kind is `ListGroupsError::OrganizationNotFoundException`.
314    pub fn is_organization_not_found_exception(&self) -> bool {
315        matches!(self, Self::OrganizationNotFoundException(_))
316    }
317    /// Returns `true` if the error kind is `ListGroupsError::OrganizationStateException`.
318    pub fn is_organization_state_exception(&self) -> bool {
319        matches!(self, Self::OrganizationStateException(_))
320    }
321}
322impl ::std::error::Error for ListGroupsError {
323    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
324        match self {
325            Self::EntityNotFoundException(_inner) => ::std::option::Option::Some(_inner),
326            Self::InvalidParameterException(_inner) => ::std::option::Option::Some(_inner),
327            Self::OrganizationNotFoundException(_inner) => ::std::option::Option::Some(_inner),
328            Self::OrganizationStateException(_inner) => ::std::option::Option::Some(_inner),
329            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
330        }
331    }
332}
333impl ::std::fmt::Display for ListGroupsError {
334    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
335        match self {
336            Self::EntityNotFoundException(_inner) => _inner.fmt(f),
337            Self::InvalidParameterException(_inner) => _inner.fmt(f),
338            Self::OrganizationNotFoundException(_inner) => _inner.fmt(f),
339            Self::OrganizationStateException(_inner) => _inner.fmt(f),
340            Self::Unhandled(_inner) => {
341                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
342                    write!(f, "unhandled error ({code})")
343                } else {
344                    f.write_str("unhandled error")
345                }
346            }
347        }
348    }
349}
350impl ::aws_smithy_types::retry::ProvideErrorKind for ListGroupsError {
351    fn code(&self) -> ::std::option::Option<&str> {
352        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
353    }
354    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
355        ::std::option::Option::None
356    }
357}
358impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListGroupsError {
359    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
360        match self {
361            Self::EntityNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
362            Self::InvalidParameterException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
363            Self::OrganizationNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
364            Self::OrganizationStateException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
365            Self::Unhandled(_inner) => &_inner.meta,
366        }
367    }
368}
369impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListGroupsError {
370    fn create_unhandled_error(
371        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
372        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
373    ) -> Self {
374        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
375            source,
376            meta: meta.unwrap_or_default(),
377        })
378    }
379}
380impl ::aws_types::request_id::RequestId for crate::operation::list_groups::ListGroupsError {
381    fn request_id(&self) -> Option<&str> {
382        self.meta().request_id()
383    }
384}
385
386pub use crate::operation::list_groups::_list_groups_output::ListGroupsOutput;
387
388pub use crate::operation::list_groups::_list_groups_input::ListGroupsInput;
389
390mod _list_groups_input;
391
392mod _list_groups_output;
393
394/// Builders
395pub mod builders;
396
397/// Paginator for this operation
398pub mod paginator;
aws_sdk_workmail/operation/list_groups.rs

aws_sdk_workmail/operation/
list_groups.rs
