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        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("workmail", "ListGroups", input, runtime_plugins, stop_point).await
54    }
55
56    pub(crate) fn operation_runtime_plugins(
57        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
58        client_config: &crate::config::Config,
59        config_override: ::std::option::Option<crate::config::Builder>,
60    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
61        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
62        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
63            ::aws_runtime::auth::sigv4::SCHEME_ID,
64        ]));
65        if let ::std::option::Option::Some(config_override) = config_override {
66            for plugin in config_override.runtime_plugins.iter().cloned() {
67                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
68            }
69            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
70                config_override,
71                client_config.config.clone(),
72                &client_config.runtime_components,
73            ));
74        }
75        runtime_plugins
76    }
77}
78impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ListGroups {
79    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
80        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListGroups");
81
82        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
83            ListGroupsRequestSerializer,
84        ));
85        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
86            ListGroupsResponseDeserializer,
87        ));
88
89        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
90            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
91        ));
92
93        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("ListGroups", "workmail"));
94        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
95        signing_options.double_uri_encode = true;
96        signing_options.content_sha256_header = false;
97        signing_options.normalize_uri_path = true;
98        signing_options.payload_override = None;
99
100        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
101            signing_options,
102            ..::std::default::Default::default()
103        });
104
105        ::std::option::Option::Some(cfg.freeze())
106    }
107
108    fn runtime_components(
109        &self,
110        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
111    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
112        #[allow(unused_mut)]
113        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListGroups")
114            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
115            .with_interceptor(ListGroupsEndpointParamsInterceptor)
116            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
117                crate::operation::list_groups::ListGroupsError,
118            >::new())
119            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
120                crate::operation::list_groups::ListGroupsError,
121            >::new())
122            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
123                crate::operation::list_groups::ListGroupsError,
124            >::new());
125
126        ::std::borrow::Cow::Owned(rcb)
127    }
128}
129
130#[derive(Debug)]
131struct ListGroupsResponseDeserializer;
132impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListGroupsResponseDeserializer {
133    fn deserialize_nonstreaming(
134        &self,
135        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
136    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
137        let (success, status) = (response.status().is_success(), response.status().as_u16());
138        let headers = response.headers();
139        let body = response.body().bytes().expect("body loaded");
140        #[allow(unused_mut)]
141        let mut force_error = false;
142        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
143        let parse_result = if !success && status != 200 || force_error {
144            crate::protocol_serde::shape_list_groups::de_list_groups_http_error(status, headers, body)
145        } else {
146            crate::protocol_serde::shape_list_groups::de_list_groups_http_response(status, headers, body)
147        };
148        crate::protocol_serde::type_erase_result(parse_result)
149    }
150}
151#[derive(Debug)]
152struct ListGroupsRequestSerializer;
153impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListGroupsRequestSerializer {
154    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
155    fn serialize_input(
156        &self,
157        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
158        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
159    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
160        let input = input.downcast::<crate::operation::list_groups::ListGroupsInput>().expect("correct type");
161        let _header_serialization_settings = _cfg
162            .load::<crate::serialization_settings::HeaderSerializationSettings>()
163            .cloned()
164            .unwrap_or_default();
165        let mut request_builder = {
166            fn uri_base(
167                _input: &crate::operation::list_groups::ListGroupsInput,
168                output: &mut ::std::string::String,
169            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
170                use ::std::fmt::Write as _;
171                ::std::write!(output, "/").expect("formatting should succeed");
172                ::std::result::Result::Ok(())
173            }
174            #[allow(clippy::unnecessary_wraps)]
175            fn update_http_builder(
176                input: &crate::operation::list_groups::ListGroupsInput,
177                builder: ::http::request::Builder,
178            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
179                let mut uri = ::std::string::String::new();
180                uri_base(input, &mut uri)?;
181                ::std::result::Result::Ok(builder.method("POST").uri(uri))
182            }
183            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
184            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.1");
185            builder = _header_serialization_settings.set_default_header(
186                builder,
187                ::http::header::HeaderName::from_static("x-amz-target"),
188                "WorkMailService.ListGroups",
189            );
190            builder
191        };
192        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_list_groups::ser_list_groups_input(&input)?);
193        if let Some(content_length) = body.content_length() {
194            let content_length = content_length.to_string();
195            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
196        }
197        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
198    }
199}
200#[derive(Debug)]
201struct ListGroupsEndpointParamsInterceptor;
202
203impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListGroupsEndpointParamsInterceptor {
204    fn name(&self) -> &'static str {
205        "ListGroupsEndpointParamsInterceptor"
206    }
207
208    fn read_before_execution(
209        &self,
210        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
211            '_,
212            ::aws_smithy_runtime_api::client::interceptors::context::Input,
213            ::aws_smithy_runtime_api::client::interceptors::context::Output,
214            ::aws_smithy_runtime_api::client::interceptors::context::Error,
215        >,
216        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
217    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
218        let _input = context
219            .input()
220            .downcast_ref::<ListGroupsInput>()
221            .ok_or("failed to downcast to ListGroupsInput")?;
222
223        let params = crate::config::endpoint::Params::builder()
224            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
225            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
226            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
227            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
228            .build()
229            .map_err(|err| {
230                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
231            })?;
232        cfg.interceptor_state()
233            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
234        ::std::result::Result::Ok(())
235    }
236}
237
238// The get_* functions below are generated from JMESPath expressions in the
239// operationContextParams trait. They target the operation's input shape.
240
241/// Error type for the `ListGroupsError` operation.
242#[non_exhaustive]
243#[derive(::std::fmt::Debug)]
244pub enum ListGroupsError {
245    /// <p>The identifier supplied for the user, group, or resource does not exist in your organization.</p>
246    EntityNotFoundException(crate::types::error::EntityNotFoundException),
247    /// <p>One or more of the input parameters don't match the service's restrictions.</p>
248    InvalidParameterException(crate::types::error::InvalidParameterException),
249    /// <p>An operation received a valid organization identifier that either doesn't belong or exist in the system.</p>
250    OrganizationNotFoundException(crate::types::error::OrganizationNotFoundException),
251    /// <p>The organization must have a valid state to perform certain operations on the organization or its members.</p>
252    OrganizationStateException(crate::types::error::OrganizationStateException),
253    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
254    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
255    variable wildcard pattern and check `.code()`:
256     \
257    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
258     \
259    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListGroupsError) for what information is available for the error.")]
260    Unhandled(crate::error::sealed_unhandled::Unhandled),
261}
262impl ListGroupsError {
263    /// Creates the `ListGroupsError::Unhandled` variant from any error type.
264    pub fn unhandled(
265        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
266    ) -> Self {
267        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
268            source: err.into(),
269            meta: ::std::default::Default::default(),
270        })
271    }
272
273    /// Creates the `ListGroupsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
274    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
275        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
276            source: err.clone().into(),
277            meta: err,
278        })
279    }
280    ///
281    /// Returns error metadata, which includes the error code, message,
282    /// request ID, and potentially additional information.
283    ///
284    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
285        match self {
286            Self::EntityNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
287            Self::InvalidParameterException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
288            Self::OrganizationNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
289            Self::OrganizationStateException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
290            Self::Unhandled(e) => &e.meta,
291        }
292    }
293    /// Returns `true` if the error kind is `ListGroupsError::EntityNotFoundException`.
294    pub fn is_entity_not_found_exception(&self) -> bool {
295        matches!(self, Self::EntityNotFoundException(_))
296    }
297    /// Returns `true` if the error kind is `ListGroupsError::InvalidParameterException`.
298    pub fn is_invalid_parameter_exception(&self) -> bool {
299        matches!(self, Self::InvalidParameterException(_))
300    }
301    /// Returns `true` if the error kind is `ListGroupsError::OrganizationNotFoundException`.
302    pub fn is_organization_not_found_exception(&self) -> bool {
303        matches!(self, Self::OrganizationNotFoundException(_))
304    }
305    /// Returns `true` if the error kind is `ListGroupsError::OrganizationStateException`.
306    pub fn is_organization_state_exception(&self) -> bool {
307        matches!(self, Self::OrganizationStateException(_))
308    }
309}
310impl ::std::error::Error for ListGroupsError {
311    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
312        match self {
313            Self::EntityNotFoundException(_inner) => ::std::option::Option::Some(_inner),
314            Self::InvalidParameterException(_inner) => ::std::option::Option::Some(_inner),
315            Self::OrganizationNotFoundException(_inner) => ::std::option::Option::Some(_inner),
316            Self::OrganizationStateException(_inner) => ::std::option::Option::Some(_inner),
317            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
318        }
319    }
320}
321impl ::std::fmt::Display for ListGroupsError {
322    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
323        match self {
324            Self::EntityNotFoundException(_inner) => _inner.fmt(f),
325            Self::InvalidParameterException(_inner) => _inner.fmt(f),
326            Self::OrganizationNotFoundException(_inner) => _inner.fmt(f),
327            Self::OrganizationStateException(_inner) => _inner.fmt(f),
328            Self::Unhandled(_inner) => {
329                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
330                    write!(f, "unhandled error ({code})")
331                } else {
332                    f.write_str("unhandled error")
333                }
334            }
335        }
336    }
337}
338impl ::aws_smithy_types::retry::ProvideErrorKind for ListGroupsError {
339    fn code(&self) -> ::std::option::Option<&str> {
340        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
341    }
342    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
343        ::std::option::Option::None
344    }
345}
346impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListGroupsError {
347    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
348        match self {
349            Self::EntityNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
350            Self::InvalidParameterException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
351            Self::OrganizationNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
352            Self::OrganizationStateException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
353            Self::Unhandled(_inner) => &_inner.meta,
354        }
355    }
356}
357impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListGroupsError {
358    fn create_unhandled_error(
359        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
360        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
361    ) -> Self {
362        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
363            source,
364            meta: meta.unwrap_or_default(),
365        })
366    }
367}
368impl ::aws_types::request_id::RequestId for crate::operation::list_groups::ListGroupsError {
369    fn request_id(&self) -> Option<&str> {
370        self.meta().request_id()
371    }
372}
373
374pub use crate::operation::list_groups::_list_groups_output::ListGroupsOutput;
375
376pub use crate::operation::list_groups::_list_groups_input::ListGroupsInput;
377
378mod _list_groups_input;
379
380mod _list_groups_output;
381
382/// Builders
383pub mod builders;
384
385/// Paginator for this operation
386pub mod paginator;
aws_sdk_workmail/operation/list_groups.rs

aws_sdk_workmail/operation/
list_groups.rs
