aws_sdk_sqs/operation/
purge_queue.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `PurgeQueue`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct PurgeQueue;
6impl PurgeQueue {
7    /// Creates a new `PurgeQueue`
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::purge_queue::PurgeQueueInput,
14    ) -> ::std::result::Result<
15        crate::operation::purge_queue::PurgeQueueOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::purge_queue::PurgeQueueError,
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::purge_queue::PurgeQueueError>()
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::purge_queue::PurgeQueueOutput>()
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::purge_queue::PurgeQueueInput,
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("SQS", "PurgeQueue", 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                "SQS.PurgeQueue",
59                "rpc.service" = "SQS",
60                "rpc.method" = "PurgeQueue",
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 PurgeQueue {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("PurgeQueue");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            PurgeQueueRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            PurgeQueueResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("PurgeQueue")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("PurgeQueue", "SQS"));
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("PurgeQueue")
126            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
127            .with_interceptor(PurgeQueueEndpointParamsInterceptor)
128            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
129                crate::operation::purge_queue::PurgeQueueError,
130            >::new())
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
132                crate::operation::purge_queue::PurgeQueueError,
133            >::new())
134            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
135                crate::operation::purge_queue::PurgeQueueError,
136            >::new());
137
138        ::std::borrow::Cow::Owned(rcb)
139    }
140}
141
142#[derive(Debug)]
143struct PurgeQueueResponseDeserializer;
144impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for PurgeQueueResponseDeserializer {
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_purge_queue::de_purge_queue_http_error(status, headers, body)
157        } else {
158            crate::protocol_serde::shape_purge_queue::de_purge_queue_http_response(status, headers, body)
159        };
160        crate::protocol_serde::type_erase_result(parse_result)
161    }
162}
163#[derive(Debug)]
164struct PurgeQueueRequestSerializer;
165impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for PurgeQueueRequestSerializer {
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.downcast::<crate::operation::purge_queue::PurgeQueueInput>().expect("correct type");
173        let _header_serialization_settings = _cfg
174            .load::<crate::serialization_settings::HeaderSerializationSettings>()
175            .cloned()
176            .unwrap_or_default();
177        let mut request_builder = {
178            fn uri_base(
179                _input: &crate::operation::purge_queue::PurgeQueueInput,
180                output: &mut ::std::string::String,
181            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
182                use ::std::fmt::Write as _;
183                ::std::write!(output, "/").expect("formatting should succeed");
184                ::std::result::Result::Ok(())
185            }
186            #[allow(clippy::unnecessary_wraps)]
187            fn update_http_builder(
188                input: &crate::operation::purge_queue::PurgeQueueInput,
189                builder: ::http::request::Builder,
190            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
191                let mut uri = ::std::string::String::new();
192                uri_base(input, &mut uri)?;
193                ::std::result::Result::Ok(builder.method("POST").uri(uri))
194            }
195            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
196            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.0");
197            builder = _header_serialization_settings.set_default_header(
198                builder,
199                ::http::header::HeaderName::from_static("x-amz-target"),
200                "AmazonSQS.PurgeQueue",
201            );
202            builder =
203                _header_serialization_settings.set_default_header(builder, ::http::header::HeaderName::from_static("x-amzn-query-mode"), "true");
204            builder
205        };
206        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_purge_queue::ser_purge_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::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 PurgeQueueEndpointParamsInterceptor;
216
217impl ::aws_smithy_runtime_api::client::interceptors::Intercept for PurgeQueueEndpointParamsInterceptor {
218    fn name(&self) -> &'static str {
219        "PurgeQueueEndpointParamsInterceptor"
220    }
221
222    fn read_before_execution(
223        &self,
224        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
225            '_,
226            ::aws_smithy_runtime_api::client::interceptors::context::Input,
227            ::aws_smithy_runtime_api::client::interceptors::context::Output,
228            ::aws_smithy_runtime_api::client::interceptors::context::Error,
229        >,
230        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
231    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
232        let _input = context
233            .input()
234            .downcast_ref::<PurgeQueueInput>()
235            .ok_or("failed to downcast to PurgeQueueInput")?;
236
237        let params = crate::config::endpoint::Params::builder()
238            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
239            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
240            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
241            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
242            .build()
243            .map_err(|err| {
244                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
245            })?;
246        cfg.interceptor_state()
247            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
248        ::std::result::Result::Ok(())
249    }
250}
251
252// The get_* functions below are generated from JMESPath expressions in the
253// operationContextParams trait. They target the operation's input shape.
254
255/// Error type for the `PurgeQueueError` operation.
256#[non_exhaustive]
257#[derive(::std::fmt::Debug)]
258pub enum PurgeQueueError {
259    /// <p>The specified ID is invalid.</p>
260    InvalidAddress(crate::types::error::InvalidAddress),
261    /// <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
262    InvalidSecurity(crate::types::error::InvalidSecurity),
263    /// <p>Indicates that the specified queue previously received a <code>PurgeQueue</code> request within the last 60 seconds (the time it can take to delete the messages in the queue).</p>
264    PurgeQueueInProgress(crate::types::error::PurgeQueueInProgress),
265    /// <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been deleted.</p>
266    QueueDoesNotExist(crate::types::error::QueueDoesNotExist),
267    /// <p>The request was denied due to request throttling.</p>
268    /// <ul>
269    /// <li>
270    /// <p>Exceeds the permitted request rate for the queue or for the recipient of the request.</p></li>
271    /// <li>
272    /// <p>Ensure that the request rate is within the Amazon SQS limits for sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS Developer Guide</i>.</p></li>
273    /// </ul>
274    RequestThrottled(crate::types::error::RequestThrottled),
275    /// <p>Error code 400. Unsupported operation.</p>
276    UnsupportedOperation(crate::types::error::UnsupportedOperation),
277    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
278    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
279    variable wildcard pattern and check `.code()`:
280     \
281    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
282     \
283    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-PurgeQueueError) for what information is available for the error.")]
284    Unhandled(crate::error::sealed_unhandled::Unhandled),
285}
286impl PurgeQueueError {
287    /// Creates the `PurgeQueueError::Unhandled` variant from any error type.
288    pub fn unhandled(
289        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
290    ) -> Self {
291        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
292            source: err.into(),
293            meta: ::std::default::Default::default(),
294        })
295    }
296
297    /// Creates the `PurgeQueueError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
298    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
299        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
300            source: err.clone().into(),
301            meta: err,
302        })
303    }
304    ///
305    /// Returns error metadata, which includes the error code, message,
306    /// request ID, and potentially additional information.
307    ///
308    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
309        match self {
310            Self::InvalidAddress(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
311            Self::InvalidSecurity(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
312            Self::PurgeQueueInProgress(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
313            Self::QueueDoesNotExist(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
314            Self::RequestThrottled(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
315            Self::UnsupportedOperation(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
316            Self::Unhandled(e) => &e.meta,
317        }
318    }
319    /// Returns `true` if the error kind is `PurgeQueueError::InvalidAddress`.
320    pub fn is_invalid_address(&self) -> bool {
321        matches!(self, Self::InvalidAddress(_))
322    }
323    /// Returns `true` if the error kind is `PurgeQueueError::InvalidSecurity`.
324    pub fn is_invalid_security(&self) -> bool {
325        matches!(self, Self::InvalidSecurity(_))
326    }
327    /// Returns `true` if the error kind is `PurgeQueueError::PurgeQueueInProgress`.
328    pub fn is_purge_queue_in_progress(&self) -> bool {
329        matches!(self, Self::PurgeQueueInProgress(_))
330    }
331    /// Returns `true` if the error kind is `PurgeQueueError::QueueDoesNotExist`.
332    pub fn is_queue_does_not_exist(&self) -> bool {
333        matches!(self, Self::QueueDoesNotExist(_))
334    }
335    /// Returns `true` if the error kind is `PurgeQueueError::RequestThrottled`.
336    pub fn is_request_throttled(&self) -> bool {
337        matches!(self, Self::RequestThrottled(_))
338    }
339    /// Returns `true` if the error kind is `PurgeQueueError::UnsupportedOperation`.
340    pub fn is_unsupported_operation(&self) -> bool {
341        matches!(self, Self::UnsupportedOperation(_))
342    }
343}
344impl ::std::error::Error for PurgeQueueError {
345    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
346        match self {
347            Self::InvalidAddress(_inner) => ::std::option::Option::Some(_inner),
348            Self::InvalidSecurity(_inner) => ::std::option::Option::Some(_inner),
349            Self::PurgeQueueInProgress(_inner) => ::std::option::Option::Some(_inner),
350            Self::QueueDoesNotExist(_inner) => ::std::option::Option::Some(_inner),
351            Self::RequestThrottled(_inner) => ::std::option::Option::Some(_inner),
352            Self::UnsupportedOperation(_inner) => ::std::option::Option::Some(_inner),
353            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
354        }
355    }
356}
357impl ::std::fmt::Display for PurgeQueueError {
358    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
359        match self {
360            Self::InvalidAddress(_inner) => _inner.fmt(f),
361            Self::InvalidSecurity(_inner) => _inner.fmt(f),
362            Self::PurgeQueueInProgress(_inner) => _inner.fmt(f),
363            Self::QueueDoesNotExist(_inner) => _inner.fmt(f),
364            Self::RequestThrottled(_inner) => _inner.fmt(f),
365            Self::UnsupportedOperation(_inner) => _inner.fmt(f),
366            Self::Unhandled(_inner) => {
367                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
368                    write!(f, "unhandled error ({code})")
369                } else {
370                    f.write_str("unhandled error")
371                }
372            }
373        }
374    }
375}
376impl ::aws_smithy_types::retry::ProvideErrorKind for PurgeQueueError {
377    fn code(&self) -> ::std::option::Option<&str> {
378        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
379    }
380    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
381        ::std::option::Option::None
382    }
383}
384impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for PurgeQueueError {
385    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
386        match self {
387            Self::InvalidAddress(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
388            Self::InvalidSecurity(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
389            Self::PurgeQueueInProgress(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
390            Self::QueueDoesNotExist(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
391            Self::RequestThrottled(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
392            Self::UnsupportedOperation(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
393            Self::Unhandled(_inner) => &_inner.meta,
394        }
395    }
396}
397impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for PurgeQueueError {
398    fn create_unhandled_error(
399        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
400        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
401    ) -> Self {
402        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
403            source,
404            meta: meta.unwrap_or_default(),
405        })
406    }
407}
408impl ::aws_types::request_id::RequestId for crate::operation::purge_queue::PurgeQueueError {
409    fn request_id(&self) -> Option<&str> {
410        self.meta().request_id()
411    }
412}
413
414pub use crate::operation::purge_queue::_purge_queue_output::PurgeQueueOutput;
415
416pub use crate::operation::purge_queue::_purge_queue_input::PurgeQueueInput;
417
418mod _purge_queue_input;
419
420mod _purge_queue_output;
421
422/// Builders
423pub mod builders;
aws_sdk_sqs/operation/purge_queue.rs

aws_sdk_sqs/operation/
purge_queue.rs
