aws_sdk_apptest/operation/
get_test_run_step.rs

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