aws_sdk_ecs/operation/
stop_task.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `StopTask`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct StopTask;
6impl StopTask {
7    /// Creates a new `StopTask`
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::stop_task::StopTaskInput,
14    ) -> ::std::result::Result<
15        crate::operation::stop_task::StopTaskOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::stop_task::StopTaskError,
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::stop_task::StopTaskError>().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::stop_task::StopTaskOutput>()
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::stop_task::StopTaskInput,
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("ECS", "StopTask", 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                "ECS.StopTask",
55                "rpc.service" = "ECS",
56                "rpc.method" = "StopTask",
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 StopTask {
84    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
85        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("StopTask");
86
87        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
88            StopTaskRequestSerializer,
89        ));
90        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
91            StopTaskResponseDeserializer,
92        ));
93
94        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
95            crate::config::auth::Params::builder()
96                .operation_name("StopTask")
97                .build()
98                .expect("required fields set"),
99        ));
100
101        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
102        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("StopTask", "ECS"));
103        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
104        signing_options.double_uri_encode = true;
105        signing_options.content_sha256_header = false;
106        signing_options.normalize_uri_path = true;
107        signing_options.payload_override = None;
108
109        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
110            signing_options,
111            ..::std::default::Default::default()
112        });
113
114        ::std::option::Option::Some(cfg.freeze())
115    }
116
117    fn runtime_components(
118        &self,
119        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
120    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
121        #[allow(unused_mut)]
122        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("StopTask")
123            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
124                StopTaskTelemetryInputCaptureInterceptor,
125            ))
126            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
127                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
128            ))
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                StopTaskEndpointParamsInterceptor,
131            ))
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
133                crate::operation::stop_task::StopTaskError,
134            >::new())
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
136                crate::operation::stop_task::StopTaskError,
137            >::new())
138            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
139                crate::operation::stop_task::StopTaskError,
140            >::new());
141
142        ::std::borrow::Cow::Owned(rcb)
143    }
144}
145
146#[derive(Debug)]
147struct StopTaskTelemetryInputCaptureInterceptor;
148
149#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
150impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StopTaskTelemetryInputCaptureInterceptor {
151    fn name(&self) -> &'static str {
152        "StopTaskTelemetryInputCaptureInterceptor"
153    }
154
155    fn read_before_execution(
156        &self,
157        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
158            '_,
159            ::aws_smithy_runtime_api::client::interceptors::context::Input,
160            ::aws_smithy_runtime_api::client::interceptors::context::Output,
161            ::aws_smithy_runtime_api::client::interceptors::context::Error,
162        >,
163        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
164    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
165        // Nothing to do unless the customer opted in by naming members to record.
166        let ::std::option::Option::Some(requested) = cfg
167            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
168            .filter(|r| !r.is_empty())
169        else {
170            return ::std::result::Result::Ok(());
171        };
172
173        let ::std::option::Option::Some(input) = context.input().downcast_ref::<StopTaskInput>() else {
174            // A mismatched input is not this interceptor's concern; skip quietly.
175            return ::std::result::Result::Ok(());
176        };
177
178        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
179        if requested.should_capture("cluster") {
180            if let ::std::option::Option::Some(value) = input.cluster.as_deref() {
181                captured.insert("cluster", value);
182            }
183        }
184        if requested.should_capture("task") {
185            if let ::std::option::Option::Some(value) = input.task.as_deref() {
186                captured.insert("task", value);
187            }
188        }
189        if requested.should_capture("reason") {
190            if let ::std::option::Option::Some(value) = input.reason.as_deref() {
191                captured.insert("reason", value);
192            }
193        }
194
195        cfg.interceptor_state().store_put(captured);
196        ::std::result::Result::Ok(())
197    }
198}
199#[derive(Debug)]
200struct StopTaskResponseDeserializer;
201impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StopTaskResponseDeserializer {
202    fn deserialize_nonstreaming_with_config(
203        &self,
204        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
205        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
206    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
207        let (success, status) = (response.status().is_success(), response.status().as_u16());
208        let headers = response.headers();
209        let body = response.body().bytes().expect("body loaded");
210        #[allow(unused_mut)]
211        let mut force_error = false;
212        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
213        let parse_result = if !success && status != 200 || force_error {
214            crate::protocol_serde::shape_stop_task::de_stop_task_http_error(status, headers, body)
215        } else {
216            crate::protocol_serde::shape_stop_task::de_stop_task_http_response(status, headers, body)
217        };
218        crate::protocol_serde::type_erase_result(parse_result)
219    }
220}
221#[derive(Debug)]
222struct StopTaskRequestSerializer;
223impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StopTaskRequestSerializer {
224    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
225    fn serialize_input(
226        &self,
227        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
228        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
229    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
230        let input = input.downcast::<crate::operation::stop_task::StopTaskInput>().expect("correct type");
231        let _header_serialization_settings = _cfg
232            .load::<crate::serialization_settings::HeaderSerializationSettings>()
233            .cloned()
234            .unwrap_or_default();
235        let mut request_builder = {
236            #[allow(clippy::uninlined_format_args)]
237            fn uri_base(
238                _input: &crate::operation::stop_task::StopTaskInput,
239                output: &mut ::std::string::String,
240            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
241                use ::std::fmt::Write as _;
242                ::std::write!(output, "/").expect("formatting should succeed");
243                ::std::result::Result::Ok(())
244            }
245            #[allow(clippy::unnecessary_wraps)]
246            fn update_http_builder(
247                input: &crate::operation::stop_task::StopTaskInput,
248                builder: ::http_1x::request::Builder,
249            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
250                let mut uri = ::std::string::String::new();
251                uri_base(input, &mut uri)?;
252                ::std::result::Result::Ok(builder.method("POST").uri(uri))
253            }
254            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
255            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-amz-json-1.1");
256            builder = _header_serialization_settings.set_default_header(
257                builder,
258                ::http_1x::header::HeaderName::from_static("x-amz-target"),
259                "AmazonEC2ContainerServiceV20141113.StopTask",
260            );
261            builder
262        };
263        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_stop_task::ser_stop_task_input(&input)?);
264        if let Some(content_length) = body.content_length() {
265            let content_length = content_length.to_string();
266            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
267        }
268        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
269    }
270}
271#[derive(Debug)]
272struct StopTaskEndpointParamsInterceptor;
273
274#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
275impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StopTaskEndpointParamsInterceptor {
276    fn name(&self) -> &'static str {
277        "StopTaskEndpointParamsInterceptor"
278    }
279
280    fn read_before_execution(
281        &self,
282        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
283            '_,
284            ::aws_smithy_runtime_api::client::interceptors::context::Input,
285            ::aws_smithy_runtime_api::client::interceptors::context::Output,
286            ::aws_smithy_runtime_api::client::interceptors::context::Error,
287        >,
288        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
289    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
290        let _input = context
291            .input()
292            .downcast_ref::<StopTaskInput>()
293            .ok_or("failed to downcast to StopTaskInput")?;
294
295        let params = crate::config::endpoint::Params::builder()
296            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
297            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
298            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
299            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
300            .build()
301            .map_err(|err| {
302                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
303            })?;
304        cfg.interceptor_state()
305            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
306        ::std::result::Result::Ok(())
307    }
308}
309
310// The get_* functions below are generated from JMESPath expressions in the
311// operationContextParams trait. They target the operation's input shape.
312
313/// Error type for the `StopTaskError` operation.
314#[non_exhaustive]
315#[derive(::std::fmt::Debug)]
316pub enum StopTaskError {
317    /// <p>You don't have authorization to perform the requested action.</p>
318    AccessDeniedException(crate::types::error::AccessDeniedException),
319    /// <p>These errors are usually caused by a client action. This client action might be using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Or, it might be specifying an identifier that isn't valid.</p>
320    ClientException(crate::types::error::ClientException),
321    /// <p>The specified cluster wasn't found. You can view your available clusters with <a href="https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ListClusters.html">ListClusters</a>. Amazon ECS clusters are Region specific.</p>
322    ClusterNotFoundException(crate::types::error::ClusterNotFoundException),
323    /// <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
324    /// <p>For more information about service event errors, see <a href="https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-event-messages-list.html">Amazon ECS service event messages</a>.</p>
325    InvalidParameterException(crate::types::error::InvalidParameterException),
326    /// <p>These errors are usually caused by a server issue.</p>
327    ServerException(crate::types::error::ServerException),
328    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
329    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
330    variable wildcard pattern and check `.code()`:
331     \
332    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
333     \
334    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StopTaskError) for what information is available for the error.")]
335    Unhandled(crate::error::sealed_unhandled::Unhandled),
336}
337impl StopTaskError {
338    /// Creates the `StopTaskError::Unhandled` variant from any error type.
339    pub fn unhandled(
340        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
341    ) -> Self {
342        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
343            source: err.into(),
344            meta: ::std::default::Default::default(),
345        })
346    }
347
348    /// Creates the `StopTaskError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
349    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
350        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
351            source: err.clone().into(),
352            meta: err,
353        })
354    }
355    ///
356    /// Returns error metadata, which includes the error code, message,
357    /// request ID, and potentially additional information.
358    ///
359    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
360        match self {
361            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
362            Self::ClientException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
363            Self::ClusterNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
364            Self::InvalidParameterException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
365            Self::ServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
366            Self::Unhandled(e) => &e.meta,
367        }
368    }
369    /// Returns `true` if the error kind is `StopTaskError::AccessDeniedException`.
370    pub fn is_access_denied_exception(&self) -> bool {
371        matches!(self, Self::AccessDeniedException(_))
372    }
373    /// Returns `true` if the error kind is `StopTaskError::ClientException`.
374    pub fn is_client_exception(&self) -> bool {
375        matches!(self, Self::ClientException(_))
376    }
377    /// Returns `true` if the error kind is `StopTaskError::ClusterNotFoundException`.
378    pub fn is_cluster_not_found_exception(&self) -> bool {
379        matches!(self, Self::ClusterNotFoundException(_))
380    }
381    /// Returns `true` if the error kind is `StopTaskError::InvalidParameterException`.
382    pub fn is_invalid_parameter_exception(&self) -> bool {
383        matches!(self, Self::InvalidParameterException(_))
384    }
385    /// Returns `true` if the error kind is `StopTaskError::ServerException`.
386    pub fn is_server_exception(&self) -> bool {
387        matches!(self, Self::ServerException(_))
388    }
389}
390impl ::std::error::Error for StopTaskError {
391    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
392        match self {
393            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
394            Self::ClientException(_inner) => ::std::option::Option::Some(_inner),
395            Self::ClusterNotFoundException(_inner) => ::std::option::Option::Some(_inner),
396            Self::InvalidParameterException(_inner) => ::std::option::Option::Some(_inner),
397            Self::ServerException(_inner) => ::std::option::Option::Some(_inner),
398            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
399        }
400    }
401}
402impl ::std::fmt::Display for StopTaskError {
403    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
404        match self {
405            Self::AccessDeniedException(_inner) => _inner.fmt(f),
406            Self::ClientException(_inner) => _inner.fmt(f),
407            Self::ClusterNotFoundException(_inner) => _inner.fmt(f),
408            Self::InvalidParameterException(_inner) => _inner.fmt(f),
409            Self::ServerException(_inner) => _inner.fmt(f),
410            Self::Unhandled(_inner) => {
411                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
412                    write!(f, "unhandled error ({code})")
413                } else {
414                    f.write_str("unhandled error")
415                }
416            }
417        }
418    }
419}
420impl ::aws_smithy_types::retry::ProvideErrorKind for StopTaskError {
421    fn code(&self) -> ::std::option::Option<&str> {
422        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
423    }
424    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
425        ::std::option::Option::None
426    }
427}
428impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StopTaskError {
429    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
430        match self {
431            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
432            Self::ClientException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
433            Self::ClusterNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
434            Self::InvalidParameterException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
435            Self::ServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
436            Self::Unhandled(_inner) => &_inner.meta,
437        }
438    }
439}
440impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StopTaskError {
441    fn create_unhandled_error(
442        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
443        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
444    ) -> Self {
445        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
446            source,
447            meta: meta.unwrap_or_default(),
448        })
449    }
450}
451impl ::aws_types::request_id::RequestId for crate::operation::stop_task::StopTaskError {
452    fn request_id(&self) -> Option<&str> {
453        self.meta().request_id()
454    }
455}
456
457pub use crate::operation::stop_task::_stop_task_input::StopTaskInput;
458
459pub use crate::operation::stop_task::_stop_task_output::StopTaskOutput;
460
461mod _stop_task_input;
462
463mod _stop_task_output;
464
465/// Builders
466pub mod builders;
aws_sdk_ecs/operation/stop_task.rs

aws_sdk_ecs/operation/
stop_task.rs
