aws_sdk_qbusiness/operation/
list_conversations.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListConversations`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListConversations;
6impl ListConversations {
7    /// Creates a new `ListConversations`
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_conversations::ListConversationsInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_conversations::ListConversationsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_conversations::ListConversationsError,
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_conversations::ListConversationsError>()
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_conversations::ListConversationsOutput>()
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_conversations::ListConversationsInput,
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("QBusiness", "ListConversations", 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                "QBusiness.ListConversations",
59                "rpc.service" = "QBusiness",
60                "rpc.method" = "ListConversations",
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 ListConversations {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListConversations");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            ListConversationsRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            ListConversationsResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("ListConversations")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "ListConversations",
107            "QBusiness",
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("ListConversations")
129            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130            .with_interceptor(ListConversationsEndpointParamsInterceptor)
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::list_conversations::ListConversationsError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::list_conversations::ListConversationsError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::list_conversations::ListConversationsError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct ListConversationsResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListConversationsResponseDeserializer {
148    fn deserialize_nonstreaming(
149        &self,
150        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
151    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
152        let (success, status) = (response.status().is_success(), response.status().as_u16());
153        let headers = response.headers();
154        let body = response.body().bytes().expect("body loaded");
155        #[allow(unused_mut)]
156        let mut force_error = false;
157        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
158        let parse_result = if !success && status != 200 || force_error {
159            crate::protocol_serde::shape_list_conversations::de_list_conversations_http_error(status, headers, body)
160        } else {
161            crate::protocol_serde::shape_list_conversations::de_list_conversations_http_response(status, headers, body)
162        };
163        crate::protocol_serde::type_erase_result(parse_result)
164    }
165}
166#[derive(Debug)]
167struct ListConversationsRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListConversationsRequestSerializer {
169    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
170    fn serialize_input(
171        &self,
172        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
173        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
174    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
175        let input = input
176            .downcast::<crate::operation::list_conversations::ListConversationsInput>()
177            .expect("correct type");
178        let _header_serialization_settings = _cfg
179            .load::<crate::serialization_settings::HeaderSerializationSettings>()
180            .cloned()
181            .unwrap_or_default();
182        let mut request_builder = {
183            #[allow(clippy::uninlined_format_args)]
184            fn uri_base(
185                _input: &crate::operation::list_conversations::ListConversationsInput,
186                output: &mut ::std::string::String,
187            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
188                use ::std::fmt::Write as _;
189                let input_1 = &_input.application_id;
190                let input_1 = input_1
191                    .as_ref()
192                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("application_id", "cannot be empty or unset"))?;
193                let application_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
194                if application_id.is_empty() {
195                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
196                        "application_id",
197                        "cannot be empty or unset",
198                    ));
199                }
200                ::std::write!(output, "/applications/{applicationId}/conversations", applicationId = application_id)
201                    .expect("formatting should succeed");
202                ::std::result::Result::Ok(())
203            }
204            fn uri_query(
205                _input: &crate::operation::list_conversations::ListConversationsInput,
206                mut output: &mut ::std::string::String,
207            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
208                let mut query = ::aws_smithy_http::query::Writer::new(output);
209                if let ::std::option::Option::Some(inner_2) = &_input.user_id {
210                    {
211                        query.push_kv("userId", &::aws_smithy_http::query::fmt_string(inner_2));
212                    }
213                }
214                if let ::std::option::Option::Some(inner_3) = &_input.next_token {
215                    {
216                        query.push_kv("nextToken", &::aws_smithy_http::query::fmt_string(inner_3));
217                    }
218                }
219                if let ::std::option::Option::Some(inner_4) = &_input.max_results {
220                    {
221                        query.push_kv("maxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_4).encode());
222                    }
223                }
224                ::std::result::Result::Ok(())
225            }
226            #[allow(clippy::unnecessary_wraps)]
227            fn update_http_builder(
228                input: &crate::operation::list_conversations::ListConversationsInput,
229                builder: ::http::request::Builder,
230            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
231                let mut uri = ::std::string::String::new();
232                uri_base(input, &mut uri)?;
233                uri_query(input, &mut uri)?;
234                ::std::result::Result::Ok(builder.method("GET").uri(uri))
235            }
236            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
237            builder
238        };
239        let body = ::aws_smithy_types::body::SdkBody::from("");
240
241        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
242    }
243}
244#[derive(Debug)]
245struct ListConversationsEndpointParamsInterceptor;
246
247impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListConversationsEndpointParamsInterceptor {
248    fn name(&self) -> &'static str {
249        "ListConversationsEndpointParamsInterceptor"
250    }
251
252    fn read_before_execution(
253        &self,
254        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
255            '_,
256            ::aws_smithy_runtime_api::client::interceptors::context::Input,
257            ::aws_smithy_runtime_api::client::interceptors::context::Output,
258            ::aws_smithy_runtime_api::client::interceptors::context::Error,
259        >,
260        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
261    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
262        let _input = context
263            .input()
264            .downcast_ref::<ListConversationsInput>()
265            .ok_or("failed to downcast to ListConversationsInput")?;
266
267        let params = crate::config::endpoint::Params::builder()
268            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
269            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
270            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
271            .build()
272            .map_err(|err| {
273                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
274            })?;
275        cfg.interceptor_state()
276            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
277        ::std::result::Result::Ok(())
278    }
279}
280
281// The get_* functions below are generated from JMESPath expressions in the
282// operationContextParams trait. They target the operation's input shape.
283
284/// Error type for the `ListConversationsError` operation.
285#[non_exhaustive]
286#[derive(::std::fmt::Debug)]
287pub enum ListConversationsError {
288    /// <p>You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
289    AccessDeniedException(crate::types::error::AccessDeniedException),
290    /// <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
291    InternalServerException(crate::types::error::InternalServerException),
292    /// <p>You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.</p>
293    LicenseNotFoundException(crate::types::error::LicenseNotFoundException),
294    /// <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
295    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
296    /// <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
297    ThrottlingException(crate::types::error::ThrottlingException),
298    /// <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
299    ValidationException(crate::types::error::ValidationException),
300    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
301    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
302    variable wildcard pattern and check `.code()`:
303     \
304    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
305     \
306    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListConversationsError) for what information is available for the error.")]
307    Unhandled(crate::error::sealed_unhandled::Unhandled),
308}
309impl ListConversationsError {
310    /// Creates the `ListConversationsError::Unhandled` variant from any error type.
311    pub fn unhandled(
312        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
313    ) -> Self {
314        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
315            source: err.into(),
316            meta: ::std::default::Default::default(),
317        })
318    }
319
320    /// Creates the `ListConversationsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
321    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
322        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
323            source: err.clone().into(),
324            meta: err,
325        })
326    }
327    ///
328    /// Returns error metadata, which includes the error code, message,
329    /// request ID, and potentially additional information.
330    ///
331    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
332        match self {
333            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
334            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
335            Self::LicenseNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
336            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
337            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
338            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
339            Self::Unhandled(e) => &e.meta,
340        }
341    }
342    /// Returns `true` if the error kind is `ListConversationsError::AccessDeniedException`.
343    pub fn is_access_denied_exception(&self) -> bool {
344        matches!(self, Self::AccessDeniedException(_))
345    }
346    /// Returns `true` if the error kind is `ListConversationsError::InternalServerException`.
347    pub fn is_internal_server_exception(&self) -> bool {
348        matches!(self, Self::InternalServerException(_))
349    }
350    /// Returns `true` if the error kind is `ListConversationsError::LicenseNotFoundException`.
351    pub fn is_license_not_found_exception(&self) -> bool {
352        matches!(self, Self::LicenseNotFoundException(_))
353    }
354    /// Returns `true` if the error kind is `ListConversationsError::ResourceNotFoundException`.
355    pub fn is_resource_not_found_exception(&self) -> bool {
356        matches!(self, Self::ResourceNotFoundException(_))
357    }
358    /// Returns `true` if the error kind is `ListConversationsError::ThrottlingException`.
359    pub fn is_throttling_exception(&self) -> bool {
360        matches!(self, Self::ThrottlingException(_))
361    }
362    /// Returns `true` if the error kind is `ListConversationsError::ValidationException`.
363    pub fn is_validation_exception(&self) -> bool {
364        matches!(self, Self::ValidationException(_))
365    }
366}
367impl ::std::error::Error for ListConversationsError {
368    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
369        match self {
370            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
371            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
372            Self::LicenseNotFoundException(_inner) => ::std::option::Option::Some(_inner),
373            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
374            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
375            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
376            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
377        }
378    }
379}
380impl ::std::fmt::Display for ListConversationsError {
381    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
382        match self {
383            Self::AccessDeniedException(_inner) => _inner.fmt(f),
384            Self::InternalServerException(_inner) => _inner.fmt(f),
385            Self::LicenseNotFoundException(_inner) => _inner.fmt(f),
386            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
387            Self::ThrottlingException(_inner) => _inner.fmt(f),
388            Self::ValidationException(_inner) => _inner.fmt(f),
389            Self::Unhandled(_inner) => {
390                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
391                    write!(f, "unhandled error ({code})")
392                } else {
393                    f.write_str("unhandled error")
394                }
395            }
396        }
397    }
398}
399impl ::aws_smithy_types::retry::ProvideErrorKind for ListConversationsError {
400    fn code(&self) -> ::std::option::Option<&str> {
401        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
402    }
403    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
404        ::std::option::Option::None
405    }
406}
407impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListConversationsError {
408    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
409        match self {
410            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
411            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
412            Self::LicenseNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
413            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
414            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
415            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
416            Self::Unhandled(_inner) => &_inner.meta,
417        }
418    }
419}
420impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListConversationsError {
421    fn create_unhandled_error(
422        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
423        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
424    ) -> Self {
425        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
426            source,
427            meta: meta.unwrap_or_default(),
428        })
429    }
430}
431impl ::aws_types::request_id::RequestId for crate::operation::list_conversations::ListConversationsError {
432    fn request_id(&self) -> Option<&str> {
433        self.meta().request_id()
434    }
435}
436
437pub use crate::operation::list_conversations::_list_conversations_output::ListConversationsOutput;
438
439pub use crate::operation::list_conversations::_list_conversations_input::ListConversationsInput;
440
441mod _list_conversations_input;
442
443mod _list_conversations_output;
444
445/// Builders
446pub mod builders;
447
448/// Paginator for this operation
449pub mod paginator;
aws_sdk_qbusiness/operation/list_conversations.rs

aws_sdk_qbusiness/operation/
list_conversations.rs
