aws_sdk_cloudwatchlogs/operation/
start_live_tail.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `StartLiveTail`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct StartLiveTail;
6impl StartLiveTail {
7    /// Creates a new `StartLiveTail`
8    pub fn new() -> Self {
9        Self
10    }
11    pub(crate) async fn orchestrate(
12        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
13        input: crate::operation::start_live_tail::StartLiveTailInput,
14    ) -> ::std::result::Result<
15        crate::operation::start_live_tail::StartLiveTailOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::start_live_tail::StartLiveTailError,
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::start_live_tail::StartLiveTailError>()
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::start_live_tail::StartLiveTailOutput>()
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::start_live_tail::StartLiveTailInput,
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("CloudWatch Logs", "StartLiveTail", 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                "CloudWatch Logs.StartLiveTail",
59                "rpc.service" = "CloudWatch Logs",
60                "rpc.method" = "StartLiveTail",
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 StartLiveTail {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("StartLiveTail");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            StartLiveTailRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            StartLiveTailResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("StartLiveTail")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "StartLiveTail",
107            "CloudWatch Logs",
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("StartLiveTail")
129            .with_interceptor(StartLiveTailEndpointParamsInterceptor)
130            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
131                crate::operation::start_live_tail::StartLiveTailError,
132            >::new())
133            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
134                crate::operation::start_live_tail::StartLiveTailError,
135            >::new())
136            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
137                crate::operation::start_live_tail::StartLiveTailError,
138            >::new());
139
140        ::std::borrow::Cow::Owned(rcb)
141    }
142}
143
144#[derive(Debug)]
145struct StartLiveTailResponseDeserializer;
146impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StartLiveTailResponseDeserializer {
147    fn deserialize_streaming(
148        &self,
149        response: &mut ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
150    ) -> ::std::option::Option<::aws_smithy_runtime_api::client::interceptors::context::OutputOrError> {
151        #[allow(unused_mut)]
152        let mut force_error = false;
153        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
154
155        // If this is an error, defer to the non-streaming parser
156        if (!response.status().is_success() && response.status().as_u16() != 200) || force_error {
157            return ::std::option::Option::None;
158        }
159        ::std::option::Option::Some(crate::protocol_serde::type_erase_result(
160            crate::protocol_serde::shape_start_live_tail::de_start_live_tail_http_response(response),
161        ))
162    }
163
164    fn deserialize_nonstreaming(
165        &self,
166        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
167    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
168        // For streaming operations, we only hit this case if its an error
169        let body = response.body().bytes().expect("body loaded");
170        crate::protocol_serde::type_erase_result(crate::protocol_serde::shape_start_live_tail::de_start_live_tail_http_error(
171            response.status().as_u16(),
172            response.headers(),
173            body,
174        ))
175    }
176}
177#[derive(Debug)]
178struct StartLiveTailRequestSerializer;
179impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StartLiveTailRequestSerializer {
180    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
181    fn serialize_input(
182        &self,
183        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
184        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
185    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
186        let input = input
187            .downcast::<crate::operation::start_live_tail::StartLiveTailInput>()
188            .expect("correct type");
189        let _header_serialization_settings = _cfg
190            .load::<crate::serialization_settings::HeaderSerializationSettings>()
191            .cloned()
192            .unwrap_or_default();
193        let mut request_builder = {
194            #[allow(clippy::uninlined_format_args)]
195            fn uri_base(
196                _input: &crate::operation::start_live_tail::StartLiveTailInput,
197                output: &mut ::std::string::String,
198            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
199                use ::std::fmt::Write as _;
200                ::std::write!(output, "/").expect("formatting should succeed");
201                ::std::result::Result::Ok(())
202            }
203            #[allow(clippy::unnecessary_wraps)]
204            fn update_http_builder(
205                input: &crate::operation::start_live_tail::StartLiveTailInput,
206                builder: ::http::request::Builder,
207            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
208                let mut uri = ::std::string::String::new();
209                uri_base(input, &mut uri)?;
210                ::std::result::Result::Ok(builder.method("POST").uri(uri))
211            }
212            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
213            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.1");
214            builder = _header_serialization_settings.set_default_header(
215                builder,
216                ::http::header::HeaderName::from_static("x-amz-target"),
217                "Logs_20140328.StartLiveTail",
218            );
219            builder
220        };
221        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_start_live_tail::ser_start_live_tail_input(&input)?);
222        if let Some(content_length) = body.content_length() {
223            let content_length = content_length.to_string();
224            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
225        }
226        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
227    }
228}
229#[derive(Debug)]
230struct StartLiveTailEndpointParamsInterceptor;
231
232impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartLiveTailEndpointParamsInterceptor {
233    fn name(&self) -> &'static str {
234        "StartLiveTailEndpointParamsInterceptor"
235    }
236
237    fn read_before_execution(
238        &self,
239        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
240            '_,
241            ::aws_smithy_runtime_api::client::interceptors::context::Input,
242            ::aws_smithy_runtime_api::client::interceptors::context::Output,
243            ::aws_smithy_runtime_api::client::interceptors::context::Error,
244        >,
245        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
246    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
247        let _input = context
248            .input()
249            .downcast_ref::<StartLiveTailInput>()
250            .ok_or("failed to downcast to StartLiveTailInput")?;
251
252        let endpoint_prefix = ::aws_smithy_runtime_api::client::endpoint::EndpointPrefix::new("streaming-").map_err(|err| {
253            ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint prefix could not be built", err)
254        })?;
255        cfg.interceptor_state().store_put(endpoint_prefix);
256
257        let params = crate::config::endpoint::Params::builder()
258            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
259            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
260            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
261            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
262            .build()
263            .map_err(|err| {
264                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
265            })?;
266        cfg.interceptor_state()
267            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
268        ::std::result::Result::Ok(())
269    }
270}
271
272// The get_* functions below are generated from JMESPath expressions in the
273// operationContextParams trait. They target the operation's input shape.
274
275/// Error type for the `StartLiveTailError` operation.
276#[non_exhaustive]
277#[derive(::std::fmt::Debug)]
278pub enum StartLiveTailError {
279    /// <p>You don't have sufficient permissions to perform this action.</p>
280    AccessDeniedException(crate::types::error::AccessDeniedException),
281    /// <p>The operation is not valid on the specified resource.</p>
282    InvalidOperationException(crate::types::error::InvalidOperationException),
283    /// <p>A parameter is specified incorrectly.</p>
284    InvalidParameterException(crate::types::error::InvalidParameterException),
285    /// <p>You have reached the maximum number of resources that can be created.</p>
286    LimitExceededException(crate::types::error::LimitExceededException),
287    /// <p>The specified resource does not exist.</p>
288    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
289    /// <p>This exception is returned in a Live Tail stream when the Live Tail session times out. Live Tail sessions time out after three hours.</p>
290    SessionTimeoutException(crate::types::error::SessionTimeoutException),
291    /// <p>This exception is returned if an unknown error occurs during a Live Tail session.</p>
292    SessionStreamingException(crate::types::error::SessionStreamingException),
293    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
294    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
295    variable wildcard pattern and check `.code()`:
296     \
297    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
298     \
299    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StartLiveTailError) for what information is available for the error.")]
300    Unhandled(crate::error::sealed_unhandled::Unhandled),
301}
302impl StartLiveTailError {
303    /// Creates the `StartLiveTailError::Unhandled` variant from any error type.
304    pub fn unhandled(
305        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
306    ) -> Self {
307        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
308            source: err.into(),
309            meta: ::std::default::Default::default(),
310        })
311    }
312
313    /// Creates the `StartLiveTailError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
314    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
315        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
316            source: err.clone().into(),
317            meta: err,
318        })
319    }
320    ///
321    /// Returns error metadata, which includes the error code, message,
322    /// request ID, and potentially additional information.
323    ///
324    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
325        match self {
326            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
327            Self::InvalidOperationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
328            Self::InvalidParameterException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
329            Self::LimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
330            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
331            Self::SessionTimeoutException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
332            Self::SessionStreamingException(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 `StartLiveTailError::AccessDeniedException`.
337    pub fn is_access_denied_exception(&self) -> bool {
338        matches!(self, Self::AccessDeniedException(_))
339    }
340    /// Returns `true` if the error kind is `StartLiveTailError::InvalidOperationException`.
341    pub fn is_invalid_operation_exception(&self) -> bool {
342        matches!(self, Self::InvalidOperationException(_))
343    }
344    /// Returns `true` if the error kind is `StartLiveTailError::InvalidParameterException`.
345    pub fn is_invalid_parameter_exception(&self) -> bool {
346        matches!(self, Self::InvalidParameterException(_))
347    }
348    /// Returns `true` if the error kind is `StartLiveTailError::LimitExceededException`.
349    pub fn is_limit_exceeded_exception(&self) -> bool {
350        matches!(self, Self::LimitExceededException(_))
351    }
352    /// Returns `true` if the error kind is `StartLiveTailError::ResourceNotFoundException`.
353    pub fn is_resource_not_found_exception(&self) -> bool {
354        matches!(self, Self::ResourceNotFoundException(_))
355    }
356    /// Returns `true` if the error kind is `StartLiveTailError::SessionTimeoutException`.
357    pub fn is_session_timeout_exception(&self) -> bool {
358        matches!(self, Self::SessionTimeoutException(_))
359    }
360    /// Returns `true` if the error kind is `StartLiveTailError::SessionStreamingException`.
361    pub fn is_session_streaming_exception(&self) -> bool {
362        matches!(self, Self::SessionStreamingException(_))
363    }
364}
365impl ::std::error::Error for StartLiveTailError {
366    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
367        match self {
368            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
369            Self::InvalidOperationException(_inner) => ::std::option::Option::Some(_inner),
370            Self::InvalidParameterException(_inner) => ::std::option::Option::Some(_inner),
371            Self::LimitExceededException(_inner) => ::std::option::Option::Some(_inner),
372            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
373            Self::SessionTimeoutException(_inner) => ::std::option::Option::Some(_inner),
374            Self::SessionStreamingException(_inner) => ::std::option::Option::Some(_inner),
375            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
376        }
377    }
378}
379impl ::std::fmt::Display for StartLiveTailError {
380    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
381        match self {
382            Self::AccessDeniedException(_inner) => _inner.fmt(f),
383            Self::InvalidOperationException(_inner) => _inner.fmt(f),
384            Self::InvalidParameterException(_inner) => _inner.fmt(f),
385            Self::LimitExceededException(_inner) => _inner.fmt(f),
386            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
387            Self::SessionTimeoutException(_inner) => _inner.fmt(f),
388            Self::SessionStreamingException(_inner) => _inner.fmt(f),
389            Self::Unhandled(_inner) => {
390                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
391                    write!(f, "unhandled error ({code})")
392                } else {
393                    f.write_str("unhandled error")
394                }
395            }
396        }
397    }
398}
399impl ::aws_smithy_types::retry::ProvideErrorKind for StartLiveTailError {
400    fn code(&self) -> ::std::option::Option<&str> {
401        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
402    }
403    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
404        ::std::option::Option::None
405    }
406}
407impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StartLiveTailError {
408    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
409        match self {
410            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
411            Self::InvalidOperationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
412            Self::InvalidParameterException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
413            Self::LimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
414            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
415            Self::SessionTimeoutException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
416            Self::SessionStreamingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
417            Self::Unhandled(_inner) => &_inner.meta,
418        }
419    }
420}
421impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StartLiveTailError {
422    fn create_unhandled_error(
423        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
424        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
425    ) -> Self {
426        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
427            source,
428            meta: meta.unwrap_or_default(),
429        })
430    }
431}
432impl ::aws_types::request_id::RequestId for crate::operation::start_live_tail::StartLiveTailError {
433    fn request_id(&self) -> Option<&str> {
434        self.meta().request_id()
435    }
436}
437
438pub use crate::operation::start_live_tail::_start_live_tail_output::StartLiveTailOutput;
439
440pub use crate::operation::start_live_tail::_start_live_tail_input::StartLiveTailInput;
441
442mod _start_live_tail_input;
443
444mod _start_live_tail_output;
445
446/// Builders
447pub mod builders;
aws_sdk_cloudwatchlogs/operation/start_live_tail.rs

aws_sdk_cloudwatchlogs/operation/
start_live_tail.rs
