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::Metadata::new("StopTask", "ECS"));
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("StopTask")
122            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
123            .with_interceptor(StopTaskEndpointParamsInterceptor)
124            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
125                crate::operation::stop_task::StopTaskError,
126            >::new())
127            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
128                crate::operation::stop_task::StopTaskError,
129            >::new())
130            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
131                crate::operation::stop_task::StopTaskError,
132            >::new());
133
134        ::std::borrow::Cow::Owned(rcb)
135    }
136}
137
138#[derive(Debug)]
139struct StopTaskResponseDeserializer;
140impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StopTaskResponseDeserializer {
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_stop_task::de_stop_task_http_error(status, headers, body)
153        } else {
154            crate::protocol_serde::shape_stop_task::de_stop_task_http_response(status, headers, body)
155        };
156        crate::protocol_serde::type_erase_result(parse_result)
157    }
158}
159#[derive(Debug)]
160struct StopTaskRequestSerializer;
161impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StopTaskRequestSerializer {
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::stop_task::StopTaskInput>().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            fn uri_base(
175                _input: &crate::operation::stop_task::StopTaskInput,
176                output: &mut ::std::string::String,
177            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
178                use ::std::fmt::Write as _;
179                ::std::write!(output, "/").expect("formatting should succeed");
180                ::std::result::Result::Ok(())
181            }
182            #[allow(clippy::unnecessary_wraps)]
183            fn update_http_builder(
184                input: &crate::operation::stop_task::StopTaskInput,
185                builder: ::http::request::Builder,
186            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
187                let mut uri = ::std::string::String::new();
188                uri_base(input, &mut uri)?;
189                ::std::result::Result::Ok(builder.method("POST").uri(uri))
190            }
191            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
192            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.1");
193            builder = _header_serialization_settings.set_default_header(
194                builder,
195                ::http::header::HeaderName::from_static("x-amz-target"),
196                "AmazonEC2ContainerServiceV20141113.StopTask",
197            );
198            builder
199        };
200        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_stop_task::ser_stop_task_input(&input)?);
201        if let Some(content_length) = body.content_length() {
202            let content_length = content_length.to_string();
203            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
204        }
205        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
206    }
207}
208#[derive(Debug)]
209struct StopTaskEndpointParamsInterceptor;
210
211impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StopTaskEndpointParamsInterceptor {
212    fn name(&self) -> &'static str {
213        "StopTaskEndpointParamsInterceptor"
214    }
215
216    fn read_before_execution(
217        &self,
218        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
219            '_,
220            ::aws_smithy_runtime_api::client::interceptors::context::Input,
221            ::aws_smithy_runtime_api::client::interceptors::context::Output,
222            ::aws_smithy_runtime_api::client::interceptors::context::Error,
223        >,
224        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
225    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
226        let _input = context
227            .input()
228            .downcast_ref::<StopTaskInput>()
229            .ok_or("failed to downcast to StopTaskInput")?;
230
231        let params = crate::config::endpoint::Params::builder()
232            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
233            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
234            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
235            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
236            .build()
237            .map_err(|err| {
238                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
239            })?;
240        cfg.interceptor_state()
241            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
242        ::std::result::Result::Ok(())
243    }
244}
245
246// The get_* functions below are generated from JMESPath expressions in the
247// operationContextParams trait. They target the operation's input shape.
248
249/// Error type for the `StopTaskError` operation.
250#[non_exhaustive]
251#[derive(::std::fmt::Debug)]
252pub enum StopTaskError {
253    /// <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>
254    ClientException(crate::types::error::ClientException),
255    /// <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>
256    ClusterNotFoundException(crate::types::error::ClusterNotFoundException),
257    /// <p>The specified parameter isn't valid. Review the available parameters for the API request.</p>
258    /// <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>
259    InvalidParameterException(crate::types::error::InvalidParameterException),
260    /// <p>These errors are usually caused by a server issue.</p>
261    ServerException(crate::types::error::ServerException),
262    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
263    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
264    variable wildcard pattern and check `.code()`:
265     \
266    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
267     \
268    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StopTaskError) for what information is available for the error.")]
269    Unhandled(crate::error::sealed_unhandled::Unhandled),
270}
271impl StopTaskError {
272    /// Creates the `StopTaskError::Unhandled` variant from any error type.
273    pub fn unhandled(
274        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
275    ) -> Self {
276        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
277            source: err.into(),
278            meta: ::std::default::Default::default(),
279        })
280    }
281
282    /// Creates the `StopTaskError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
283    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
284        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
285            source: err.clone().into(),
286            meta: err,
287        })
288    }
289    ///
290    /// Returns error metadata, which includes the error code, message,
291    /// request ID, and potentially additional information.
292    ///
293    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
294        match self {
295            Self::ClientException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
296            Self::ClusterNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
297            Self::InvalidParameterException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
298            Self::ServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
299            Self::Unhandled(e) => &e.meta,
300        }
301    }
302    /// Returns `true` if the error kind is `StopTaskError::ClientException`.
303    pub fn is_client_exception(&self) -> bool {
304        matches!(self, Self::ClientException(_))
305    }
306    /// Returns `true` if the error kind is `StopTaskError::ClusterNotFoundException`.
307    pub fn is_cluster_not_found_exception(&self) -> bool {
308        matches!(self, Self::ClusterNotFoundException(_))
309    }
310    /// Returns `true` if the error kind is `StopTaskError::InvalidParameterException`.
311    pub fn is_invalid_parameter_exception(&self) -> bool {
312        matches!(self, Self::InvalidParameterException(_))
313    }
314    /// Returns `true` if the error kind is `StopTaskError::ServerException`.
315    pub fn is_server_exception(&self) -> bool {
316        matches!(self, Self::ServerException(_))
317    }
318}
319impl ::std::error::Error for StopTaskError {
320    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
321        match self {
322            Self::ClientException(_inner) => ::std::option::Option::Some(_inner),
323            Self::ClusterNotFoundException(_inner) => ::std::option::Option::Some(_inner),
324            Self::InvalidParameterException(_inner) => ::std::option::Option::Some(_inner),
325            Self::ServerException(_inner) => ::std::option::Option::Some(_inner),
326            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
327        }
328    }
329}
330impl ::std::fmt::Display for StopTaskError {
331    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
332        match self {
333            Self::ClientException(_inner) => _inner.fmt(f),
334            Self::ClusterNotFoundException(_inner) => _inner.fmt(f),
335            Self::InvalidParameterException(_inner) => _inner.fmt(f),
336            Self::ServerException(_inner) => _inner.fmt(f),
337            Self::Unhandled(_inner) => {
338                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
339                    write!(f, "unhandled error ({code})")
340                } else {
341                    f.write_str("unhandled error")
342                }
343            }
344        }
345    }
346}
347impl ::aws_smithy_types::retry::ProvideErrorKind for StopTaskError {
348    fn code(&self) -> ::std::option::Option<&str> {
349        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
350    }
351    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
352        ::std::option::Option::None
353    }
354}
355impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StopTaskError {
356    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
357        match self {
358            Self::ClientException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
359            Self::ClusterNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
360            Self::InvalidParameterException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
361            Self::ServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
362            Self::Unhandled(_inner) => &_inner.meta,
363        }
364    }
365}
366impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StopTaskError {
367    fn create_unhandled_error(
368        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
369        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
370    ) -> Self {
371        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
372            source,
373            meta: meta.unwrap_or_default(),
374        })
375    }
376}
377impl ::aws_types::request_id::RequestId for crate::operation::stop_task::StopTaskError {
378    fn request_id(&self) -> Option<&str> {
379        self.meta().request_id()
380    }
381}
382
383pub use crate::operation::stop_task::_stop_task_output::StopTaskOutput;
384
385pub use crate::operation::stop_task::_stop_task_input::StopTaskInput;
386
387mod _stop_task_input;
388
389mod _stop_task_output;
390
391/// Builders
392pub mod builders;
aws_sdk_ecs/operation/stop_task.rs

aws_sdk_ecs/operation/
stop_task.rs
