aws_sdk_resourcegroups/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("Resource Groups", "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                "Resource Groups.ListGroups",
59                "rpc.service" = "Resource Groups",
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(
106            "ListGroups",
107            "Resource Groups",
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("ListGroups")
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                ListGroupsEndpointParamsInterceptor,
134            ))
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
136                crate::operation::list_groups::ListGroupsError,
137            >::new())
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
139                crate::operation::list_groups::ListGroupsError,
140            >::new())
141            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
142                crate::operation::list_groups::ListGroupsError,
143            >::new());
144
145        ::std::borrow::Cow::Owned(rcb)
146    }
147}
148
149#[derive(Debug)]
150struct ListGroupsResponseDeserializer;
151impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListGroupsResponseDeserializer {
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_list_groups::de_list_groups_http_error(status, headers, body)
164        } else {
165            crate::protocol_serde::shape_list_groups::de_list_groups_http_response(status, headers, body)
166        };
167        crate::protocol_serde::type_erase_result(parse_result)
168    }
169}
170#[derive(Debug)]
171struct ListGroupsRequestSerializer;
172impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListGroupsRequestSerializer {
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.downcast::<crate::operation::list_groups::ListGroupsInput>().expect("correct type");
180        let _header_serialization_settings = _cfg
181            .load::<crate::serialization_settings::HeaderSerializationSettings>()
182            .cloned()
183            .unwrap_or_default();
184        let mut request_builder = {
185            #[allow(clippy::uninlined_format_args)]
186            fn uri_base(
187                _input: &crate::operation::list_groups::ListGroupsInput,
188                output: &mut ::std::string::String,
189            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
190                use ::std::fmt::Write as _;
191                ::std::write!(output, "/groups-list").expect("formatting should succeed");
192                ::std::result::Result::Ok(())
193            }
194            fn uri_query(
195                _input: &crate::operation::list_groups::ListGroupsInput,
196                mut output: &mut ::std::string::String,
197            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
198                let mut query = ::aws_smithy_http::query::Writer::new(output);
199                if let ::std::option::Option::Some(inner_1) = &_input.max_results {
200                    {
201                        query.push_kv("maxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_1).encode());
202                    }
203                }
204                if let ::std::option::Option::Some(inner_2) = &_input.next_token {
205                    {
206                        query.push_kv("nextToken", &::aws_smithy_http::query::fmt_string(inner_2));
207                    }
208                }
209                ::std::result::Result::Ok(())
210            }
211            #[allow(clippy::unnecessary_wraps)]
212            fn update_http_builder(
213                input: &crate::operation::list_groups::ListGroupsInput,
214                builder: ::http_1x::request::Builder,
215            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
216                let mut uri = ::std::string::String::new();
217                uri_base(input, &mut uri)?;
218                uri_query(input, &mut uri)?;
219                ::std::result::Result::Ok(builder.method("POST").uri(uri))
220            }
221            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
222            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/json");
223            builder
224        };
225        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_list_groups::ser_list_groups_input(&input)?);
226        if let Some(content_length) = body.content_length() {
227            let content_length = content_length.to_string();
228            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
229        }
230        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
231    }
232}
233#[derive(Debug)]
234struct ListGroupsEndpointParamsInterceptor;
235
236#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
237impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListGroupsEndpointParamsInterceptor {
238    fn name(&self) -> &'static str {
239        "ListGroupsEndpointParamsInterceptor"
240    }
241
242    fn read_before_execution(
243        &self,
244        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
245            '_,
246            ::aws_smithy_runtime_api::client::interceptors::context::Input,
247            ::aws_smithy_runtime_api::client::interceptors::context::Output,
248            ::aws_smithy_runtime_api::client::interceptors::context::Error,
249        >,
250        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
251    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
252        let _input = context
253            .input()
254            .downcast_ref::<ListGroupsInput>()
255            .ok_or("failed to downcast to ListGroupsInput")?;
256
257        let params = crate::config::endpoint::Params::builder()
258            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
259            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
260            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
261            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
262            .build()
263            .map_err(|err| {
264                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
265            })?;
266        cfg.interceptor_state()
267            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
268        ::std::result::Result::Ok(())
269    }
270}
271
272// The get_* functions below are generated from JMESPath expressions in the
273// operationContextParams trait. They target the operation's input shape.
274
275/// Error type for the `ListGroupsError` operation.
276#[non_exhaustive]
277#[derive(::std::fmt::Debug)]
278pub enum ListGroupsError {
279    /// <p>The request includes one or more parameters that violate validation rules.</p>
280    BadRequestException(crate::types::error::BadRequestException),
281    /// <p>The caller isn't authorized to make the request. Check permissions.</p>
282    ForbiddenException(crate::types::error::ForbiddenException),
283    /// <p>An internal error occurred while processing the request. Try again later.</p>
284    InternalServerErrorException(crate::types::error::InternalServerErrorException),
285    /// <p>The request uses an HTTP method that isn't allowed for the specified resource.</p>
286    MethodNotAllowedException(crate::types::error::MethodNotAllowedException),
287    /// <p>You've exceeded throttling limits by making too many requests in a period of time.</p>
288    TooManyRequestsException(crate::types::error::TooManyRequestsException),
289    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
290    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
291    variable wildcard pattern and check `.code()`:
292     \
293    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
294     \
295    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListGroupsError) for what information is available for the error.")]
296    Unhandled(crate::error::sealed_unhandled::Unhandled),
297}
298impl ListGroupsError {
299    /// Creates the `ListGroupsError::Unhandled` variant from any error type.
300    pub fn unhandled(
301        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
302    ) -> Self {
303        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
304            source: err.into(),
305            meta: ::std::default::Default::default(),
306        })
307    }
308
309    /// Creates the `ListGroupsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
310    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
311        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
312            source: err.clone().into(),
313            meta: err,
314        })
315    }
316    ///
317    /// Returns error metadata, which includes the error code, message,
318    /// request ID, and potentially additional information.
319    ///
320    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
321        match self {
322            Self::BadRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
323            Self::ForbiddenException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
324            Self::InternalServerErrorException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
325            Self::MethodNotAllowedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
326            Self::TooManyRequestsException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
327            Self::Unhandled(e) => &e.meta,
328        }
329    }
330    /// Returns `true` if the error kind is `ListGroupsError::BadRequestException`.
331    pub fn is_bad_request_exception(&self) -> bool {
332        matches!(self, Self::BadRequestException(_))
333    }
334    /// Returns `true` if the error kind is `ListGroupsError::ForbiddenException`.
335    pub fn is_forbidden_exception(&self) -> bool {
336        matches!(self, Self::ForbiddenException(_))
337    }
338    /// Returns `true` if the error kind is `ListGroupsError::InternalServerErrorException`.
339    pub fn is_internal_server_error_exception(&self) -> bool {
340        matches!(self, Self::InternalServerErrorException(_))
341    }
342    /// Returns `true` if the error kind is `ListGroupsError::MethodNotAllowedException`.
343    pub fn is_method_not_allowed_exception(&self) -> bool {
344        matches!(self, Self::MethodNotAllowedException(_))
345    }
346    /// Returns `true` if the error kind is `ListGroupsError::TooManyRequestsException`.
347    pub fn is_too_many_requests_exception(&self) -> bool {
348        matches!(self, Self::TooManyRequestsException(_))
349    }
350}
351impl ::std::error::Error for ListGroupsError {
352    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
353        match self {
354            Self::BadRequestException(_inner) => ::std::option::Option::Some(_inner),
355            Self::ForbiddenException(_inner) => ::std::option::Option::Some(_inner),
356            Self::InternalServerErrorException(_inner) => ::std::option::Option::Some(_inner),
357            Self::MethodNotAllowedException(_inner) => ::std::option::Option::Some(_inner),
358            Self::TooManyRequestsException(_inner) => ::std::option::Option::Some(_inner),
359            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
360        }
361    }
362}
363impl ::std::fmt::Display for ListGroupsError {
364    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
365        match self {
366            Self::BadRequestException(_inner) => _inner.fmt(f),
367            Self::ForbiddenException(_inner) => _inner.fmt(f),
368            Self::InternalServerErrorException(_inner) => _inner.fmt(f),
369            Self::MethodNotAllowedException(_inner) => _inner.fmt(f),
370            Self::TooManyRequestsException(_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 ListGroupsError {
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 ListGroupsError {
390    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
391        match self {
392            Self::BadRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
393            Self::ForbiddenException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
394            Self::InternalServerErrorException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
395            Self::MethodNotAllowedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
396            Self::TooManyRequestsException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
397            Self::Unhandled(_inner) => &_inner.meta,
398        }
399    }
400}
401impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListGroupsError {
402    fn create_unhandled_error(
403        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
404        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
405    ) -> Self {
406        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
407            source,
408            meta: meta.unwrap_or_default(),
409        })
410    }
411}
412impl ::aws_types::request_id::RequestId for crate::operation::list_groups::ListGroupsError {
413    fn request_id(&self) -> Option<&str> {
414        self.meta().request_id()
415    }
416}
417
418pub use crate::operation::list_groups::_list_groups_input::ListGroupsInput;
419
420pub use crate::operation::list_groups::_list_groups_output::ListGroupsOutput;
421
422mod _list_groups_input;
423
424mod _list_groups_output;
425
426/// Builders
427pub mod builders;
428
429/// Paginator for this operation
430pub mod paginator;
aws_sdk_resourcegroups/operation/list_groups.rs

aws_sdk_resourcegroups/operation/
list_groups.rs
