aws_sdk_connect/operation/
list_workspaces.rs

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

aws_sdk_connect/operation/
list_workspaces.rs
