aws_sdk_cloudtrail/operation/
describe_trails.rs

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

aws_sdk_cloudtrail/operation/
describe_trails.rs
