Skip to main content

aws_sdk_ecs/operation/
start_task.rs

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