Skip to main content

aws_sdk_s3control/operation/
create_job.rs

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