aws_sdk_dataexchange/operation/
start_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `StartJob`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct StartJob;
6impl StartJob {
7    /// Creates a new `StartJob`
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_job::StartJobInput,
14    ) -> ::std::result::Result<
15        crate::operation::start_job::StartJobOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::start_job::StartJobError,
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::start_job::StartJobError>().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::start_job::StartJobOutput>()
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::start_job::StartJobInput,
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("DataExchange", "StartJob", 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                "DataExchange.StartJob",
55                "rpc.service" = "DataExchange",
56                "rpc.method" = "StartJob",
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 StartJob {
84    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
85        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("StartJob");
86
87        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
88            StartJobRequestSerializer,
89        ));
90        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
91            StartJobResponseDeserializer,
92        ));
93
94        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
95            crate::config::auth::Params::builder()
96                .operation_name("StartJob")
97                .build()
98                .expect("required fields set"),
99        ));
100
101        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("StartJob", "DataExchange"));
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("StartJob")
122            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
123                StartJobTelemetryInputCaptureInterceptor,
124            ))
125            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
126                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
127            ))
128            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
129                StartJobEndpointParamsInterceptor,
130            ))
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::start_job::StartJobError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::start_job::StartJobError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::start_job::StartJobError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct StartJobTelemetryInputCaptureInterceptor;
147
148#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
149impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartJobTelemetryInputCaptureInterceptor {
150    fn name(&self) -> &'static str {
151        "StartJobTelemetryInputCaptureInterceptor"
152    }
153
154    fn read_before_execution(
155        &self,
156        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
157            '_,
158            ::aws_smithy_runtime_api::client::interceptors::context::Input,
159            ::aws_smithy_runtime_api::client::interceptors::context::Output,
160            ::aws_smithy_runtime_api::client::interceptors::context::Error,
161        >,
162        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
163    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
164        // Nothing to do unless the customer opted in by naming members to record.
165        let ::std::option::Option::Some(requested) = cfg
166            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
167            .filter(|r| !r.is_empty())
168        else {
169            return ::std::result::Result::Ok(());
170        };
171
172        let ::std::option::Option::Some(input) = context.input().downcast_ref::<StartJobInput>() else {
173            // A mismatched input is not this interceptor's concern; skip quietly.
174            return ::std::result::Result::Ok(());
175        };
176
177        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
178        if requested.should_capture("JobId") {
179            if let ::std::option::Option::Some(value) = input.job_id.as_deref() {
180                captured.insert("JobId", value);
181            }
182        }
183
184        cfg.interceptor_state().store_put(captured);
185        ::std::result::Result::Ok(())
186    }
187}
188#[derive(Debug)]
189struct StartJobResponseDeserializer;
190impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StartJobResponseDeserializer {
191    fn deserialize_nonstreaming_with_config(
192        &self,
193        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
194        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
195    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
196        let (success, status) = (response.status().is_success(), response.status().as_u16());
197        let headers = response.headers();
198        let body = response.body().bytes().expect("body loaded");
199        #[allow(unused_mut)]
200        let mut force_error = false;
201        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
202        let parse_result = if !success && status != 202 || force_error {
203            crate::protocol_serde::shape_start_job::de_start_job_http_error(status, headers, body)
204        } else {
205            crate::protocol_serde::shape_start_job::de_start_job_http_response(status, headers, body)
206        };
207        crate::protocol_serde::type_erase_result(parse_result)
208    }
209}
210#[derive(Debug)]
211struct StartJobRequestSerializer;
212impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StartJobRequestSerializer {
213    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
214    fn serialize_input(
215        &self,
216        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
217        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
218    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
219        let input = input.downcast::<crate::operation::start_job::StartJobInput>().expect("correct type");
220        let _header_serialization_settings = _cfg
221            .load::<crate::serialization_settings::HeaderSerializationSettings>()
222            .cloned()
223            .unwrap_or_default();
224        let mut request_builder = {
225            #[allow(clippy::uninlined_format_args)]
226            fn uri_base(
227                _input: &crate::operation::start_job::StartJobInput,
228                output: &mut ::std::string::String,
229            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
230                use ::std::fmt::Write as _;
231                let input_1 = &_input.job_id;
232                let input_1 = input_1
233                    .as_ref()
234                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("job_id", "cannot be empty or unset"))?;
235                let job_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
236                if job_id.is_empty() {
237                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
238                        "job_id",
239                        "cannot be empty or unset",
240                    ));
241                }
242                ::std::write!(output, "/v1/jobs/{JobId}", JobId = job_id).expect("formatting should succeed");
243                ::std::result::Result::Ok(())
244            }
245            #[allow(clippy::unnecessary_wraps)]
246            fn update_http_builder(
247                input: &crate::operation::start_job::StartJobInput,
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("PATCH").uri(uri))
253            }
254            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
255            builder
256        };
257        let body = ::aws_smithy_types::body::SdkBody::from("");
258
259        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
260    }
261}
262#[derive(Debug)]
263struct StartJobEndpointParamsInterceptor;
264
265#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
266impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartJobEndpointParamsInterceptor {
267    fn name(&self) -> &'static str {
268        "StartJobEndpointParamsInterceptor"
269    }
270
271    fn read_before_execution(
272        &self,
273        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
274            '_,
275            ::aws_smithy_runtime_api::client::interceptors::context::Input,
276            ::aws_smithy_runtime_api::client::interceptors::context::Output,
277            ::aws_smithy_runtime_api::client::interceptors::context::Error,
278        >,
279        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
280    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
281        let _input = context
282            .input()
283            .downcast_ref::<StartJobInput>()
284            .ok_or("failed to downcast to StartJobInput")?;
285
286        let params = crate::config::endpoint::Params::builder()
287            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
288            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
289            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
290            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
291            .build()
292            .map_err(|err| {
293                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
294            })?;
295        cfg.interceptor_state()
296            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
297        ::std::result::Result::Ok(())
298    }
299}
300
301// The get_* functions below are generated from JMESPath expressions in the
302// operationContextParams trait. They target the operation's input shape.
303
304/// Error type for the `StartJobError` operation.
305#[non_exhaustive]
306#[derive(::std::fmt::Debug)]
307pub enum StartJobError {
308    /// <p>Access to the resource is denied.</p>
309    AccessDeniedException(crate::types::error::AccessDeniedException),
310    /// <p>The request couldn't be completed because it conflicted with the current state of the resource.</p>
311    ConflictException(crate::types::error::ConflictException),
312    /// <p>An exception occurred with the service.</p>
313    InternalServerException(crate::types::error::InternalServerException),
314    /// <p>The resource couldn't be found.</p>
315    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
316    /// <p>The limit on the number of requests per second was exceeded.</p>
317    ThrottlingException(crate::types::error::ThrottlingException),
318    /// <p>The request was invalid.</p>
319    ValidationException(crate::types::error::ValidationException),
320    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
321    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
322    variable wildcard pattern and check `.code()`:
323     \
324    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
325     \
326    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StartJobError) for what information is available for the error.")]
327    Unhandled(crate::error::sealed_unhandled::Unhandled),
328}
329impl StartJobError {
330    /// Creates the `StartJobError::Unhandled` variant from any error type.
331    pub fn unhandled(
332        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
333    ) -> Self {
334        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
335            source: err.into(),
336            meta: ::std::default::Default::default(),
337        })
338    }
339
340    /// Creates the `StartJobError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
341    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
342        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
343            source: err.clone().into(),
344            meta: err,
345        })
346    }
347    ///
348    /// Returns error metadata, which includes the error code, message,
349    /// request ID, and potentially additional information.
350    ///
351    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
352        match self {
353            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
354            Self::ConflictException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
355            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
356            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
357            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
358            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
359            Self::Unhandled(e) => &e.meta,
360        }
361    }
362    /// Returns `true` if the error kind is `StartJobError::AccessDeniedException`.
363    pub fn is_access_denied_exception(&self) -> bool {
364        matches!(self, Self::AccessDeniedException(_))
365    }
366    /// Returns `true` if the error kind is `StartJobError::ConflictException`.
367    pub fn is_conflict_exception(&self) -> bool {
368        matches!(self, Self::ConflictException(_))
369    }
370    /// Returns `true` if the error kind is `StartJobError::InternalServerException`.
371    pub fn is_internal_server_exception(&self) -> bool {
372        matches!(self, Self::InternalServerException(_))
373    }
374    /// Returns `true` if the error kind is `StartJobError::ResourceNotFoundException`.
375    pub fn is_resource_not_found_exception(&self) -> bool {
376        matches!(self, Self::ResourceNotFoundException(_))
377    }
378    /// Returns `true` if the error kind is `StartJobError::ThrottlingException`.
379    pub fn is_throttling_exception(&self) -> bool {
380        matches!(self, Self::ThrottlingException(_))
381    }
382    /// Returns `true` if the error kind is `StartJobError::ValidationException`.
383    pub fn is_validation_exception(&self) -> bool {
384        matches!(self, Self::ValidationException(_))
385    }
386}
387impl ::std::error::Error for StartJobError {
388    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
389        match self {
390            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
391            Self::ConflictException(_inner) => ::std::option::Option::Some(_inner),
392            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
393            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
394            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
395            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
396            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
397        }
398    }
399}
400impl ::std::fmt::Display for StartJobError {
401    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
402        match self {
403            Self::AccessDeniedException(_inner) => _inner.fmt(f),
404            Self::ConflictException(_inner) => _inner.fmt(f),
405            Self::InternalServerException(_inner) => _inner.fmt(f),
406            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
407            Self::ThrottlingException(_inner) => _inner.fmt(f),
408            Self::ValidationException(_inner) => _inner.fmt(f),
409            Self::Unhandled(_inner) => {
410                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
411                    write!(f, "unhandled error ({code})")
412                } else {
413                    f.write_str("unhandled error")
414                }
415            }
416        }
417    }
418}
419impl ::aws_smithy_types::retry::ProvideErrorKind for StartJobError {
420    fn code(&self) -> ::std::option::Option<&str> {
421        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
422    }
423    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
424        ::std::option::Option::None
425    }
426}
427impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StartJobError {
428    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
429        match self {
430            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
431            Self::ConflictException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
432            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
433            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
434            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
435            Self::ValidationException(_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 StartJobError {
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::start_job::StartJobError {
452    fn request_id(&self) -> Option<&str> {
453        self.meta().request_id()
454    }
455}
456
457pub use crate::operation::start_job::_start_job_input::StartJobInput;
458
459pub use crate::operation::start_job::_start_job_output::StartJobOutput;
460
461mod _start_job_input;
462
463mod _start_job_output;
464
465/// Builders
466pub mod builders;
aws_sdk_dataexchange/operation/start_job.rs

aws_sdk_dataexchange/operation/
start_job.rs
