aws_sdk_pcs/operation/
get_queue.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `GetQueue`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetQueue;
6impl GetQueue {
7    /// Creates a new `GetQueue`
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_queue::GetQueueInput,
14    ) -> ::std::result::Result<
15        crate::operation::get_queue::GetQueueOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::get_queue::GetQueueError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err =
22            |err: ::aws_smithy_runtime_api::client::result::SdkError<
23                ::aws_smithy_runtime_api::client::interceptors::context::Error,
24                ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
25            >| { err.map_service_error(|err| err.downcast::<crate::operation::get_queue::GetQueueError>().expect("correct error type")) };
26        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
27            .await
28            .map_err(map_err)?;
29        let output = context.finalize().map_err(map_err)?;
30        ::std::result::Result::Ok(
31            output
32                .downcast::<crate::operation::get_queue::GetQueueOutput>()
33                .expect("correct output type"),
34        )
35    }
36
37    pub(crate) async fn orchestrate_with_stop_point(
38        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
39        input: crate::operation::get_queue::GetQueueInput,
40        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
41    ) -> ::std::result::Result<
42        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
43        ::aws_smithy_runtime_api::client::result::SdkError<
44            ::aws_smithy_runtime_api::client::interceptors::context::Error,
45            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
46        >,
47    > {
48        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
49        use ::tracing::Instrument;
50        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("PCS", "GetQueue", input, runtime_plugins, stop_point)
51            // Create a parent span for the entire operation. Includes a random, internal-only,
52            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
53            .instrument(::tracing::debug_span!(
54                "PCS.GetQueue",
55                "rpc.service" = "PCS",
56                "rpc.method" = "GetQueue",
57                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
58                "rpc.system" = "aws-api",
59            ))
60            .await
61    }
62
63    pub(crate) fn operation_runtime_plugins(
64        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
65        client_config: &crate::config::Config,
66        config_override: ::std::option::Option<crate::config::Builder>,
67    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
68        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
69
70        if let ::std::option::Option::Some(config_override) = config_override {
71            for plugin in config_override.runtime_plugins.iter().cloned() {
72                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
73            }
74            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
75                config_override,
76                client_config.config.clone(),
77                &client_config.runtime_components,
78            ));
79        }
80        runtime_plugins
81    }
82}
83impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for GetQueue {
84    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
85        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetQueue");
86
87        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
88            GetQueueRequestSerializer,
89        ));
90        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
91            GetQueueResponseDeserializer,
92        ));
93
94        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
95            crate::config::auth::Params::builder()
96                .operation_name("GetQueue")
97                .build()
98                .expect("required fields set"),
99        ));
100
101        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("GetQueue", "PCS"));
102        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
103        signing_options.double_uri_encode = true;
104        signing_options.content_sha256_header = false;
105        signing_options.normalize_uri_path = true;
106        signing_options.payload_override = None;
107
108        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
109            signing_options,
110            ..::std::default::Default::default()
111        });
112
113        ::std::option::Option::Some(cfg.freeze())
114    }
115
116    fn runtime_components(
117        &self,
118        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
119    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
120        #[allow(unused_mut)]
121        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("GetQueue")
122            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
123                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
124            ))
125            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
126                GetQueueEndpointParamsInterceptor,
127            ))
128            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
129                crate::operation::get_queue::GetQueueError,
130            >::new())
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
132                crate::operation::get_queue::GetQueueError,
133            >::new())
134            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
135                crate::operation::get_queue::GetQueueError,
136            >::new());
137
138        ::std::borrow::Cow::Owned(rcb)
139    }
140}
141
142#[derive(Debug)]
143struct GetQueueResponseDeserializer;
144impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetQueueResponseDeserializer {
145    fn deserialize_nonstreaming_with_config(
146        &self,
147        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
148        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
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_get_queue::de_get_queue_http_error(status, headers, body)
158        } else {
159            crate::protocol_serde::shape_get_queue::de_get_queue_http_response(status, headers, body)
160        };
161        crate::protocol_serde::type_erase_result(parse_result)
162    }
163}
164#[derive(Debug)]
165struct GetQueueRequestSerializer;
166impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetQueueRequestSerializer {
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::get_queue::GetQueueInput>().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::get_queue::GetQueueInput,
182                output: &mut ::std::string::String,
183            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
184                use ::std::fmt::Write as _;
185                ::std::write!(output, "/").expect("formatting should succeed");
186                ::std::result::Result::Ok(())
187            }
188            #[allow(clippy::unnecessary_wraps)]
189            fn update_http_builder(
190                input: &crate::operation::get_queue::GetQueueInput,
191                builder: ::http_1x::request::Builder,
192            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
193                let mut uri = ::std::string::String::new();
194                uri_base(input, &mut uri)?;
195                ::std::result::Result::Ok(builder.method("POST").uri(uri))
196            }
197            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
198            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-amz-json-1.0");
199            builder = _header_serialization_settings.set_default_header(
200                builder,
201                ::http_1x::header::HeaderName::from_static("x-amz-target"),
202                "AWSParallelComputingService.GetQueue",
203            );
204            builder
205        };
206        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_get_queue::ser_get_queue_input(&input)?);
207        if let Some(content_length) = body.content_length() {
208            let content_length = content_length.to_string();
209            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
210        }
211        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
212    }
213}
214#[derive(Debug)]
215struct GetQueueEndpointParamsInterceptor;
216
217#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
218impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetQueueEndpointParamsInterceptor {
219    fn name(&self) -> &'static str {
220        "GetQueueEndpointParamsInterceptor"
221    }
222
223    fn read_before_execution(
224        &self,
225        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
226            '_,
227            ::aws_smithy_runtime_api::client::interceptors::context::Input,
228            ::aws_smithy_runtime_api::client::interceptors::context::Output,
229            ::aws_smithy_runtime_api::client::interceptors::context::Error,
230        >,
231        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
232    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
233        let _input = context
234            .input()
235            .downcast_ref::<GetQueueInput>()
236            .ok_or("failed to downcast to GetQueueInput")?;
237
238        let params = crate::config::endpoint::Params::builder()
239            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
240            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
241            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
242            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
243            .build()
244            .map_err(|err| {
245                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
246            })?;
247        cfg.interceptor_state()
248            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
249        ::std::result::Result::Ok(())
250    }
251}
252
253// The get_* functions below are generated from JMESPath expressions in the
254// operationContextParams trait. They target the operation's input shape.
255
256/// Error type for the `GetQueueError` operation.
257#[non_exhaustive]
258#[derive(::std::fmt::Debug)]
259pub enum GetQueueError {
260    /// <p>You don't have permission to perform the action.</p>
261    /// <p><u>Examples</u></p>
262    /// <ul>
263    /// <li>
264    /// <p>The launch template instance profile doesn't pass <code>iam:PassRole</code> verification.</p></li>
265    /// <li>
266    /// <p>There is a mismatch between the account ID and cluster ID.</p></li>
267    /// <li>
268    /// <p>The cluster ID doesn't exist.</p></li>
269    /// <li>
270    /// <p>The EC2 instance isn't present.</p></li>
271    /// </ul>
272    AccessDeniedException(crate::types::error::AccessDeniedException),
273    /// <p>Your request has conflicting operations. This can occur if you're trying to perform more than 1 operation on the same resource at the same time.</p>
274    /// <p><u>Examples</u></p>
275    /// <ul>
276    /// <li>
277    /// <p>A cluster with the same name already exists.</p></li>
278    /// <li>
279    /// <p>A cluster isn't in <code>ACTIVE</code> status.</p></li>
280    /// <li>
281    /// <p>A cluster to delete is in an unstable state. For example, because it still has <code>ACTIVE</code> node groups or queues.</p></li>
282    /// <li>
283    /// <p>A queue already exists in a cluster.</p></li>
284    /// </ul>
285    ConflictException(crate::types::error::ConflictException),
286    /// <p>PCS can't process your request right now. Try again later.</p>
287    InternalServerException(crate::types::error::InternalServerException),
288    /// <p>The requested resource can't be found. The cluster, node group, or queue you're attempting to get, update, list, or delete doesn't exist.</p>
289    /// <p><u>Examples</u></p>
290    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
291    /// <p>Your request exceeded a request rate quota. Check the resource's request rate quota and try again.</p>
292    ThrottlingException(crate::types::error::ThrottlingException),
293    /// <p>The request isn't valid.</p>
294    /// <p><u>Examples</u></p>
295    /// <ul>
296    /// <li>
297    /// <p>Your request contains malformed JSON or unsupported characters.</p></li>
298    /// <li>
299    /// <p>The scheduler version isn't supported.</p></li>
300    /// <li>
301    /// <p>There are networking related errors, such as network validation failure.</p></li>
302    /// <li>
303    /// <p>AMI type is <code>CUSTOM</code> and the launch template doesn't define the AMI ID, or the AMI type is AL2 and the launch template defines the AMI.</p></li>
304    /// </ul>
305    ValidationException(crate::types::error::ValidationException),
306    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
307    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
308    variable wildcard pattern and check `.code()`:
309     \
310    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
311     \
312    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetQueueError) for what information is available for the error.")]
313    Unhandled(crate::error::sealed_unhandled::Unhandled),
314}
315impl GetQueueError {
316    /// Creates the `GetQueueError::Unhandled` variant from any error type.
317    pub fn unhandled(
318        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
319    ) -> Self {
320        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
321            source: err.into(),
322            meta: ::std::default::Default::default(),
323        })
324    }
325
326    /// Creates the `GetQueueError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
327    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
328        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
329            source: err.clone().into(),
330            meta: err,
331        })
332    }
333    ///
334    /// Returns error metadata, which includes the error code, message,
335    /// request ID, and potentially additional information.
336    ///
337    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
338        match self {
339            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
340            Self::ConflictException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
341            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
342            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
343            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
344            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
345            Self::Unhandled(e) => &e.meta,
346        }
347    }
348    /// Returns `true` if the error kind is `GetQueueError::AccessDeniedException`.
349    pub fn is_access_denied_exception(&self) -> bool {
350        matches!(self, Self::AccessDeniedException(_))
351    }
352    /// Returns `true` if the error kind is `GetQueueError::ConflictException`.
353    pub fn is_conflict_exception(&self) -> bool {
354        matches!(self, Self::ConflictException(_))
355    }
356    /// Returns `true` if the error kind is `GetQueueError::InternalServerException`.
357    pub fn is_internal_server_exception(&self) -> bool {
358        matches!(self, Self::InternalServerException(_))
359    }
360    /// Returns `true` if the error kind is `GetQueueError::ResourceNotFoundException`.
361    pub fn is_resource_not_found_exception(&self) -> bool {
362        matches!(self, Self::ResourceNotFoundException(_))
363    }
364    /// Returns `true` if the error kind is `GetQueueError::ThrottlingException`.
365    pub fn is_throttling_exception(&self) -> bool {
366        matches!(self, Self::ThrottlingException(_))
367    }
368    /// Returns `true` if the error kind is `GetQueueError::ValidationException`.
369    pub fn is_validation_exception(&self) -> bool {
370        matches!(self, Self::ValidationException(_))
371    }
372}
373impl ::std::error::Error for GetQueueError {
374    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
375        match self {
376            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
377            Self::ConflictException(_inner) => ::std::option::Option::Some(_inner),
378            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
379            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
380            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
381            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
382            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
383        }
384    }
385}
386impl ::std::fmt::Display for GetQueueError {
387    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
388        match self {
389            Self::AccessDeniedException(_inner) => _inner.fmt(f),
390            Self::ConflictException(_inner) => _inner.fmt(f),
391            Self::InternalServerException(_inner) => _inner.fmt(f),
392            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
393            Self::ThrottlingException(_inner) => _inner.fmt(f),
394            Self::ValidationException(_inner) => _inner.fmt(f),
395            Self::Unhandled(_inner) => {
396                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
397                    write!(f, "unhandled error ({code})")
398                } else {
399                    f.write_str("unhandled error")
400                }
401            }
402        }
403    }
404}
405impl ::aws_smithy_types::retry::ProvideErrorKind for GetQueueError {
406    fn code(&self) -> ::std::option::Option<&str> {
407        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
408    }
409    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
410        match self {
411            Self::InternalServerException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
412            Self::ThrottlingException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
413            _ => ::std::option::Option::None,
414        }
415    }
416}
417impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetQueueError {
418    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
419        match self {
420            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
421            Self::ConflictException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
422            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
423            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
424            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
425            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
426            Self::Unhandled(_inner) => &_inner.meta,
427        }
428    }
429}
430impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetQueueError {
431    fn create_unhandled_error(
432        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
433        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
434    ) -> Self {
435        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
436            source,
437            meta: meta.unwrap_or_default(),
438        })
439    }
440}
441impl ::aws_types::request_id::RequestId for crate::operation::get_queue::GetQueueError {
442    fn request_id(&self) -> Option<&str> {
443        self.meta().request_id()
444    }
445}
446
447pub use crate::operation::get_queue::_get_queue_input::GetQueueInput;
448
449pub use crate::operation::get_queue::_get_queue_output::GetQueueOutput;
450
451mod _get_queue_input;
452
453mod _get_queue_output;
454
455/// Builders
456pub mod builders;
aws_sdk_pcs/operation/get_queue.rs

aws_sdk_pcs/operation/
get_queue.rs
