aws_sdk_cloudwatchlogs/operation/
describe_log_streams.rs

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

aws_sdk_cloudwatchlogs/operation/
describe_log_streams.rs
