aws_sdk_cloudtrail/operation/
get_trail_status.rs

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

aws_sdk_cloudtrail/operation/
get_trail_status.rs
