aws_sdk_xray/operation/
get_groups.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `GetGroups`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetGroups;
6impl GetGroups {
7    /// Creates a new `GetGroups`
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::get_groups::GetGroupsInput,
14    ) -> ::std::result::Result<
15        crate::operation::get_groups::GetGroupsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::get_groups::GetGroupsError,
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::get_groups::GetGroupsError>()
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                "xray.GetGroups",
36                "rpc.service" = "xray",
37                "rpc.method" = "GetGroups",
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::get_groups::GetGroupsOutput>()
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::get_groups::GetGroupsInput,
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("xray", "GetGroups", 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 GetGroups {
89    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
90        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetGroups");
91
92        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
93            GetGroupsRequestSerializer,
94        ));
95        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
96            GetGroupsResponseDeserializer,
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("GetGroups", "xray"));
104        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
105        signing_options.double_uri_encode = true;
106        signing_options.content_sha256_header = false;
107        signing_options.normalize_uri_path = true;
108        signing_options.payload_override = None;
109
110        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
111            signing_options,
112            ..::std::default::Default::default()
113        });
114
115        ::std::option::Option::Some(cfg.freeze())
116    }
117
118    fn runtime_components(
119        &self,
120        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
121    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
122        #[allow(unused_mut)]
123        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("GetGroups")
124            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
125            .with_interceptor(GetGroupsEndpointParamsInterceptor)
126            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
127                crate::operation::get_groups::GetGroupsError,
128            >::new())
129            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
130                crate::operation::get_groups::GetGroupsError,
131            >::new())
132            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
133                crate::operation::get_groups::GetGroupsError,
134            >::new());
135
136        ::std::borrow::Cow::Owned(rcb)
137    }
138}
139
140#[derive(Debug)]
141struct GetGroupsResponseDeserializer;
142impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetGroupsResponseDeserializer {
143    fn deserialize_nonstreaming(
144        &self,
145        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
146    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
147        let (success, status) = (response.status().is_success(), response.status().as_u16());
148        let headers = response.headers();
149        let body = response.body().bytes().expect("body loaded");
150        #[allow(unused_mut)]
151        let mut force_error = false;
152        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
153        let parse_result = if !success && status != 200 || force_error {
154            crate::protocol_serde::shape_get_groups::de_get_groups_http_error(status, headers, body)
155        } else {
156            crate::protocol_serde::shape_get_groups::de_get_groups_http_response(status, headers, body)
157        };
158        crate::protocol_serde::type_erase_result(parse_result)
159    }
160}
161#[derive(Debug)]
162struct GetGroupsRequestSerializer;
163impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetGroupsRequestSerializer {
164    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
165    fn serialize_input(
166        &self,
167        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
168        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
169    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
170        let input = input.downcast::<crate::operation::get_groups::GetGroupsInput>().expect("correct type");
171        let _header_serialization_settings = _cfg
172            .load::<crate::serialization_settings::HeaderSerializationSettings>()
173            .cloned()
174            .unwrap_or_default();
175        let mut request_builder = {
176            fn uri_base(
177                _input: &crate::operation::get_groups::GetGroupsInput,
178                output: &mut ::std::string::String,
179            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
180                use ::std::fmt::Write as _;
181                ::std::write!(output, "/Groups").expect("formatting should succeed");
182                ::std::result::Result::Ok(())
183            }
184            #[allow(clippy::unnecessary_wraps)]
185            fn update_http_builder(
186                input: &crate::operation::get_groups::GetGroupsInput,
187                builder: ::http::request::Builder,
188            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
189                let mut uri = ::std::string::String::new();
190                uri_base(input, &mut uri)?;
191                ::std::result::Result::Ok(builder.method("POST").uri(uri))
192            }
193            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
194            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/json");
195            builder
196        };
197        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_get_groups::ser_get_groups_input(&input)?);
198        if let Some(content_length) = body.content_length() {
199            let content_length = content_length.to_string();
200            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
201        }
202        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
203    }
204}
205#[derive(Debug)]
206struct GetGroupsEndpointParamsInterceptor;
207
208impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetGroupsEndpointParamsInterceptor {
209    fn name(&self) -> &'static str {
210        "GetGroupsEndpointParamsInterceptor"
211    }
212
213    fn read_before_execution(
214        &self,
215        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
216            '_,
217            ::aws_smithy_runtime_api::client::interceptors::context::Input,
218            ::aws_smithy_runtime_api::client::interceptors::context::Output,
219            ::aws_smithy_runtime_api::client::interceptors::context::Error,
220        >,
221        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
222    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
223        let _input = context
224            .input()
225            .downcast_ref::<GetGroupsInput>()
226            .ok_or("failed to downcast to GetGroupsInput")?;
227
228        let params = crate::config::endpoint::Params::builder()
229            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
230            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
231            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
232            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
233            .build()
234            .map_err(|err| {
235                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
236            })?;
237        cfg.interceptor_state()
238            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
239        ::std::result::Result::Ok(())
240    }
241}
242
243// The get_* functions below are generated from JMESPath expressions in the
244// operationContextParams trait. They target the operation's input shape.
245
246/// Error type for the `GetGroupsError` operation.
247#[non_exhaustive]
248#[derive(::std::fmt::Debug)]
249pub enum GetGroupsError {
250    /// <p>The request is missing required parameters or has invalid parameters.</p>
251    InvalidRequestException(crate::types::error::InvalidRequestException),
252    /// <p>The request exceeds the maximum number of requests per second.</p>
253    ThrottledException(crate::types::error::ThrottledException),
254    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
255    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
256    variable wildcard pattern and check `.code()`:
257     \
258    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
259     \
260    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetGroupsError) for what information is available for the error.")]
261    Unhandled(crate::error::sealed_unhandled::Unhandled),
262}
263impl GetGroupsError {
264    /// Creates the `GetGroupsError::Unhandled` variant from any error type.
265    pub fn unhandled(
266        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
267    ) -> Self {
268        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
269            source: err.into(),
270            meta: ::std::default::Default::default(),
271        })
272    }
273
274    /// Creates the `GetGroupsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
275    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
276        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
277            source: err.clone().into(),
278            meta: err,
279        })
280    }
281    ///
282    /// Returns error metadata, which includes the error code, message,
283    /// request ID, and potentially additional information.
284    ///
285    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
286        match self {
287            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
288            Self::ThrottledException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
289            Self::Unhandled(e) => &e.meta,
290        }
291    }
292    /// Returns `true` if the error kind is `GetGroupsError::InvalidRequestException`.
293    pub fn is_invalid_request_exception(&self) -> bool {
294        matches!(self, Self::InvalidRequestException(_))
295    }
296    /// Returns `true` if the error kind is `GetGroupsError::ThrottledException`.
297    pub fn is_throttled_exception(&self) -> bool {
298        matches!(self, Self::ThrottledException(_))
299    }
300}
301impl ::std::error::Error for GetGroupsError {
302    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
303        match self {
304            Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
305            Self::ThrottledException(_inner) => ::std::option::Option::Some(_inner),
306            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
307        }
308    }
309}
310impl ::std::fmt::Display for GetGroupsError {
311    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
312        match self {
313            Self::InvalidRequestException(_inner) => _inner.fmt(f),
314            Self::ThrottledException(_inner) => _inner.fmt(f),
315            Self::Unhandled(_inner) => {
316                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
317                    write!(f, "unhandled error ({code})")
318                } else {
319                    f.write_str("unhandled error")
320                }
321            }
322        }
323    }
324}
325impl ::aws_smithy_types::retry::ProvideErrorKind for GetGroupsError {
326    fn code(&self) -> ::std::option::Option<&str> {
327        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
328    }
329    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
330        ::std::option::Option::None
331    }
332}
333impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetGroupsError {
334    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
335        match self {
336            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
337            Self::ThrottledException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
338            Self::Unhandled(_inner) => &_inner.meta,
339        }
340    }
341}
342impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetGroupsError {
343    fn create_unhandled_error(
344        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
345        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
346    ) -> Self {
347        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
348            source,
349            meta: meta.unwrap_or_default(),
350        })
351    }
352}
353impl ::aws_types::request_id::RequestId for crate::operation::get_groups::GetGroupsError {
354    fn request_id(&self) -> Option<&str> {
355        self.meta().request_id()
356    }
357}
358
359pub use crate::operation::get_groups::_get_groups_output::GetGroupsOutput;
360
361pub use crate::operation::get_groups::_get_groups_input::GetGroupsInput;
362
363mod _get_groups_input;
364
365mod _get_groups_output;
366
367/// Builders
368pub mod builders;
369
370/// Paginator for this operation
371pub mod paginator;