aws_sdk_qconnect/operation/
list_spans.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListSpans`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListSpans;
6impl ListSpans {
7    /// Creates a new `ListSpans`
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_spans::ListSpansInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_spans::ListSpansOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_spans::ListSpansError,
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_spans::ListSpansError>()
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_spans::ListSpansOutput>()
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_spans::ListSpansInput,
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("QConnect", "ListSpans", 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                "QConnect.ListSpans",
59                "rpc.service" = "QConnect",
60                "rpc.method" = "ListSpans",
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 ListSpans {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListSpans");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            ListSpansRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            ListSpansResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("ListSpans")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
106        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("ListSpans", "QConnect"));
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("ListSpans")
127            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
128            .with_interceptor(ListSpansEndpointParamsInterceptor)
129            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
130                crate::operation::list_spans::ListSpansError,
131            >::new())
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
133                crate::operation::list_spans::ListSpansError,
134            >::new())
135            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
136                crate::operation::list_spans::ListSpansError,
137            >::new());
138
139        ::std::borrow::Cow::Owned(rcb)
140    }
141}
142
143#[derive(Debug)]
144struct ListSpansResponseDeserializer;
145impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListSpansResponseDeserializer {
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_list_spans::de_list_spans_http_error(status, headers, body)
158        } else {
159            crate::protocol_serde::shape_list_spans::de_list_spans_http_response(status, headers, body)
160        };
161        crate::protocol_serde::type_erase_result(parse_result)
162    }
163}
164#[derive(Debug)]
165struct ListSpansRequestSerializer;
166impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListSpansRequestSerializer {
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.downcast::<crate::operation::list_spans::ListSpansInput>().expect("correct type");
174        let _header_serialization_settings = _cfg
175            .load::<crate::serialization_settings::HeaderSerializationSettings>()
176            .cloned()
177            .unwrap_or_default();
178        let mut request_builder = {
179            #[allow(clippy::uninlined_format_args)]
180            fn uri_base(
181                _input: &crate::operation::list_spans::ListSpansInput,
182                output: &mut ::std::string::String,
183            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
184                use ::std::fmt::Write as _;
185                let input_1 = &_input.assistant_id;
186                let input_1 = input_1
187                    .as_ref()
188                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("assistant_id", "cannot be empty or unset"))?;
189                let assistant_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
190                if assistant_id.is_empty() {
191                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
192                        "assistant_id",
193                        "cannot be empty or unset",
194                    ));
195                }
196                let input_2 = &_input.session_id;
197                let input_2 = input_2
198                    .as_ref()
199                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("session_id", "cannot be empty or unset"))?;
200                let session_id = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
201                if session_id.is_empty() {
202                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
203                        "session_id",
204                        "cannot be empty or unset",
205                    ));
206                }
207                ::std::write!(
208                    output,
209                    "/assistants/{assistantId}/sessions/{sessionId}/spans",
210                    assistantId = assistant_id,
211                    sessionId = session_id
212                )
213                .expect("formatting should succeed");
214                ::std::result::Result::Ok(())
215            }
216            fn uri_query(
217                _input: &crate::operation::list_spans::ListSpansInput,
218                mut output: &mut ::std::string::String,
219            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
220                let mut query = ::aws_smithy_http::query::Writer::new(output);
221                if let ::std::option::Option::Some(inner_3) = &_input.next_token {
222                    {
223                        query.push_kv("nextToken", &::aws_smithy_http::query::fmt_string(inner_3));
224                    }
225                }
226                if let ::std::option::Option::Some(inner_4) = &_input.max_results {
227                    {
228                        query.push_kv("maxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_4).encode());
229                    }
230                }
231                ::std::result::Result::Ok(())
232            }
233            #[allow(clippy::unnecessary_wraps)]
234            fn update_http_builder(
235                input: &crate::operation::list_spans::ListSpansInput,
236                builder: ::http::request::Builder,
237            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
238                let mut uri = ::std::string::String::new();
239                uri_base(input, &mut uri)?;
240                uri_query(input, &mut uri)?;
241                ::std::result::Result::Ok(builder.method("GET").uri(uri))
242            }
243            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
244            builder
245        };
246        let body = ::aws_smithy_types::body::SdkBody::from("");
247
248        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
249    }
250}
251#[derive(Debug)]
252struct ListSpansEndpointParamsInterceptor;
253
254impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListSpansEndpointParamsInterceptor {
255    fn name(&self) -> &'static str {
256        "ListSpansEndpointParamsInterceptor"
257    }
258
259    fn read_before_execution(
260        &self,
261        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
262            '_,
263            ::aws_smithy_runtime_api::client::interceptors::context::Input,
264            ::aws_smithy_runtime_api::client::interceptors::context::Output,
265            ::aws_smithy_runtime_api::client::interceptors::context::Error,
266        >,
267        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
268    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
269        let _input = context
270            .input()
271            .downcast_ref::<ListSpansInput>()
272            .ok_or("failed to downcast to ListSpansInput")?;
273
274        let params = crate::config::endpoint::Params::builder()
275            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
276            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
277            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
278            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
279            .build()
280            .map_err(|err| {
281                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
282            })?;
283        cfg.interceptor_state()
284            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
285        ::std::result::Result::Ok(())
286    }
287}
288
289// The get_* functions below are generated from JMESPath expressions in the
290// operationContextParams trait. They target the operation's input shape.
291
292/// Error type for the `ListSpansError` operation.
293#[non_exhaustive]
294#[derive(::std::fmt::Debug)]
295pub enum ListSpansError {
296    /// <p>You do not have sufficient access to perform this action.</p>
297    AccessDeniedException(crate::types::error::AccessDeniedException),
298    /// <p>The specified resource does not exist.</p>
299    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
300    /// <p>The input fails to satisfy the constraints specified by a service.</p>
301    ValidationException(crate::types::error::ValidationException),
302    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
303    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
304    variable wildcard pattern and check `.code()`:
305     \
306    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
307     \
308    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListSpansError) for what information is available for the error.")]
309    Unhandled(crate::error::sealed_unhandled::Unhandled),
310}
311impl ListSpansError {
312    /// Creates the `ListSpansError::Unhandled` variant from any error type.
313    pub fn unhandled(
314        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
315    ) -> Self {
316        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
317            source: err.into(),
318            meta: ::std::default::Default::default(),
319        })
320    }
321
322    /// Creates the `ListSpansError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
323    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
324        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
325            source: err.clone().into(),
326            meta: err,
327        })
328    }
329    ///
330    /// Returns error metadata, which includes the error code, message,
331    /// request ID, and potentially additional information.
332    ///
333    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
334        match self {
335            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
336            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
337            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
338            Self::Unhandled(e) => &e.meta,
339        }
340    }
341    /// Returns `true` if the error kind is `ListSpansError::AccessDeniedException`.
342    pub fn is_access_denied_exception(&self) -> bool {
343        matches!(self, Self::AccessDeniedException(_))
344    }
345    /// Returns `true` if the error kind is `ListSpansError::ResourceNotFoundException`.
346    pub fn is_resource_not_found_exception(&self) -> bool {
347        matches!(self, Self::ResourceNotFoundException(_))
348    }
349    /// Returns `true` if the error kind is `ListSpansError::ValidationException`.
350    pub fn is_validation_exception(&self) -> bool {
351        matches!(self, Self::ValidationException(_))
352    }
353}
354impl ::std::error::Error for ListSpansError {
355    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
356        match self {
357            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
358            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
359            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
360            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
361        }
362    }
363}
364impl ::std::fmt::Display for ListSpansError {
365    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
366        match self {
367            Self::AccessDeniedException(_inner) => _inner.fmt(f),
368            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
369            Self::ValidationException(_inner) => _inner.fmt(f),
370            Self::Unhandled(_inner) => {
371                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
372                    write!(f, "unhandled error ({code})")
373                } else {
374                    f.write_str("unhandled error")
375                }
376            }
377        }
378    }
379}
380impl ::aws_smithy_types::retry::ProvideErrorKind for ListSpansError {
381    fn code(&self) -> ::std::option::Option<&str> {
382        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
383    }
384    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
385        ::std::option::Option::None
386    }
387}
388impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListSpansError {
389    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
390        match self {
391            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
392            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
393            Self::ValidationException(_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 ListSpansError {
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::list_spans::ListSpansError {
410    fn request_id(&self) -> Option<&str> {
411        self.meta().request_id()
412    }
413}
414
415pub use crate::operation::list_spans::_list_spans_output::ListSpansOutput;
416
417pub use crate::operation::list_spans::_list_spans_input::ListSpansInput;
418
419mod _list_spans_input;
420
421mod _list_spans_output;
422
423/// Builders
424pub mod builders;
425
426/// Paginator for this operation
427pub mod paginator;