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::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
123            .with_interceptor(GetQueueEndpointParamsInterceptor)
124            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
125                crate::operation::get_queue::GetQueueError,
126            >::new())
127            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
128                crate::operation::get_queue::GetQueueError,
129            >::new())
130            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
131                crate::operation::get_queue::GetQueueError,
132            >::new());
133
134        ::std::borrow::Cow::Owned(rcb)
135    }
136}
137
138#[derive(Debug)]
139struct GetQueueResponseDeserializer;
140impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetQueueResponseDeserializer {
141    fn deserialize_nonstreaming(
142        &self,
143        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
144    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
145        let (success, status) = (response.status().is_success(), response.status().as_u16());
146        let headers = response.headers();
147        let body = response.body().bytes().expect("body loaded");
148        #[allow(unused_mut)]
149        let mut force_error = false;
150        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
151        let parse_result = if !success && status != 200 || force_error {
152            crate::protocol_serde::shape_get_queue::de_get_queue_http_error(status, headers, body)
153        } else {
154            crate::protocol_serde::shape_get_queue::de_get_queue_http_response(status, headers, body)
155        };
156        crate::protocol_serde::type_erase_result(parse_result)
157    }
158}
159#[derive(Debug)]
160struct GetQueueRequestSerializer;
161impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetQueueRequestSerializer {
162    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
163    fn serialize_input(
164        &self,
165        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
166        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
167    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
168        let input = input.downcast::<crate::operation::get_queue::GetQueueInput>().expect("correct type");
169        let _header_serialization_settings = _cfg
170            .load::<crate::serialization_settings::HeaderSerializationSettings>()
171            .cloned()
172            .unwrap_or_default();
173        let mut request_builder = {
174            #[allow(clippy::uninlined_format_args)]
175            fn uri_base(
176                _input: &crate::operation::get_queue::GetQueueInput,
177                output: &mut ::std::string::String,
178            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
179                use ::std::fmt::Write as _;
180                ::std::write!(output, "/").expect("formatting should succeed");
181                ::std::result::Result::Ok(())
182            }
183            #[allow(clippy::unnecessary_wraps)]
184            fn update_http_builder(
185                input: &crate::operation::get_queue::GetQueueInput,
186                builder: ::http::request::Builder,
187            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
188                let mut uri = ::std::string::String::new();
189                uri_base(input, &mut uri)?;
190                ::std::result::Result::Ok(builder.method("POST").uri(uri))
191            }
192            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
193            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.0");
194            builder = _header_serialization_settings.set_default_header(
195                builder,
196                ::http::header::HeaderName::from_static("x-amz-target"),
197                "AWSParallelComputingService.GetQueue",
198            );
199            builder
200        };
201        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_get_queue::ser_get_queue_input(&input)?);
202        if let Some(content_length) = body.content_length() {
203            let content_length = content_length.to_string();
204            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
205        }
206        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
207    }
208}
209#[derive(Debug)]
210struct GetQueueEndpointParamsInterceptor;
211
212impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetQueueEndpointParamsInterceptor {
213    fn name(&self) -> &'static str {
214        "GetQueueEndpointParamsInterceptor"
215    }
216
217    fn read_before_execution(
218        &self,
219        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
220            '_,
221            ::aws_smithy_runtime_api::client::interceptors::context::Input,
222            ::aws_smithy_runtime_api::client::interceptors::context::Output,
223            ::aws_smithy_runtime_api::client::interceptors::context::Error,
224        >,
225        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
226    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
227        let _input = context
228            .input()
229            .downcast_ref::<GetQueueInput>()
230            .ok_or("failed to downcast to GetQueueInput")?;
231
232        let params = crate::config::endpoint::Params::builder()
233            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
234            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
235            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
236            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
237            .build()
238            .map_err(|err| {
239                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
240            })?;
241        cfg.interceptor_state()
242            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
243        ::std::result::Result::Ok(())
244    }
245}
246
247// The get_* functions below are generated from JMESPath expressions in the
248// operationContextParams trait. They target the operation's input shape.
249
250/// Error type for the `GetQueueError` operation.
251#[non_exhaustive]
252#[derive(::std::fmt::Debug)]
253pub enum GetQueueError {
254    /// <p>You don't have permission to perform the action.</p>
255    /// <p><u>Examples</u></p>
256    /// <ul>
257    /// <li>
258    /// <p>The launch template instance profile doesn't pass <code>iam:PassRole</code> verification.</p></li>
259    /// <li>
260    /// <p>There is a mismatch between the account ID and cluster ID.</p></li>
261    /// <li>
262    /// <p>The cluster ID doesn't exist.</p></li>
263    /// <li>
264    /// <p>The EC2 instance isn't present.</p></li>
265    /// </ul>
266    AccessDeniedException(crate::types::error::AccessDeniedException),
267    /// <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>
268    /// <p><u>Examples</u></p>
269    /// <ul>
270    /// <li>
271    /// <p>A cluster with the same name already exists.</p></li>
272    /// <li>
273    /// <p>A cluster isn't in <code>ACTIVE</code> status.</p></li>
274    /// <li>
275    /// <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>
276    /// <li>
277    /// <p>A queue already exists in a cluster.</p></li>
278    /// </ul>
279    ConflictException(crate::types::error::ConflictException),
280    /// <p>PCS can't process your request right now. Try again later.</p>
281    InternalServerException(crate::types::error::InternalServerException),
282    /// <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>
283    /// <p><u>Examples</u></p>
284    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
285    /// <p>Your request exceeded a request rate quota. Check the resource's request rate quota and try again.</p>
286    ThrottlingException(crate::types::error::ThrottlingException),
287    /// <p>The request isn't valid.</p>
288    /// <p><u>Examples</u></p>
289    /// <ul>
290    /// <li>
291    /// <p>Your request contains malformed JSON or unsupported characters.</p></li>
292    /// <li>
293    /// <p>The scheduler version isn't supported.</p></li>
294    /// <li>
295    /// <p>There are networking related errors, such as network validation failure.</p></li>
296    /// <li>
297    /// <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>
298    /// </ul>
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-GetQueueError) for what information is available for the error.")]
307    Unhandled(crate::error::sealed_unhandled::Unhandled),
308}
309impl GetQueueError {
310    /// Creates the `GetQueueError::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 `GetQueueError::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::ConflictException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
335            Self::InternalServerException(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 `GetQueueError::AccessDeniedException`.
343    pub fn is_access_denied_exception(&self) -> bool {
344        matches!(self, Self::AccessDeniedException(_))
345    }
346    /// Returns `true` if the error kind is `GetQueueError::ConflictException`.
347    pub fn is_conflict_exception(&self) -> bool {
348        matches!(self, Self::ConflictException(_))
349    }
350    /// Returns `true` if the error kind is `GetQueueError::InternalServerException`.
351    pub fn is_internal_server_exception(&self) -> bool {
352        matches!(self, Self::InternalServerException(_))
353    }
354    /// Returns `true` if the error kind is `GetQueueError::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 `GetQueueError::ThrottlingException`.
359    pub fn is_throttling_exception(&self) -> bool {
360        matches!(self, Self::ThrottlingException(_))
361    }
362    /// Returns `true` if the error kind is `GetQueueError::ValidationException`.
363    pub fn is_validation_exception(&self) -> bool {
364        matches!(self, Self::ValidationException(_))
365    }
366}
367impl ::std::error::Error for GetQueueError {
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::ConflictException(_inner) => ::std::option::Option::Some(_inner),
372            Self::InternalServerException(_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 GetQueueError {
381    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
382        match self {
383            Self::AccessDeniedException(_inner) => _inner.fmt(f),
384            Self::ConflictException(_inner) => _inner.fmt(f),
385            Self::InternalServerException(_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 GetQueueError {
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        match self {
405            Self::InternalServerException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
406            Self::ThrottlingException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
407            _ => ::std::option::Option::None,
408        }
409    }
410}
411impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetQueueError {
412    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
413        match self {
414            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
415            Self::ConflictException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
416            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
417            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
418            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
419            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
420            Self::Unhandled(_inner) => &_inner.meta,
421        }
422    }
423}
424impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetQueueError {
425    fn create_unhandled_error(
426        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
427        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
428    ) -> Self {
429        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
430            source,
431            meta: meta.unwrap_or_default(),
432        })
433    }
434}
435impl ::aws_types::request_id::RequestId for crate::operation::get_queue::GetQueueError {
436    fn request_id(&self) -> Option<&str> {
437        self.meta().request_id()
438    }
439}
440
441pub use crate::operation::get_queue::_get_queue_output::GetQueueOutput;
442
443pub use crate::operation::get_queue::_get_queue_input::GetQueueInput;
444
445mod _get_queue_input;
446
447mod _get_queue_output;
448
449/// Builders
450pub mod builders;