aws_sdk_cloudwatchlogs/operation/
start_query.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `StartQuery`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct StartQuery;
6impl StartQuery {
7    /// Creates a new `StartQuery`
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_query::StartQueryInput,
14    ) -> ::std::result::Result<
15        crate::operation::start_query::StartQueryOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::start_query::StartQueryError,
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_query::StartQueryError>()
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_query::StartQueryOutput>()
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_query::StartQueryInput,
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", "StartQuery", 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.StartQuery",
59                "rpc.service" = "CloudWatch Logs",
60                "rpc.method" = "StartQuery",
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 StartQuery {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("StartQuery");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            StartQueryRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            StartQueryResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("StartQuery")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "StartQuery",
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("StartQuery")
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                StartQueryTelemetryInputCaptureInterceptor,
131            ))
132            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
133                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
134            ))
135            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
136                StartQueryEndpointParamsInterceptor,
137            ))
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
139                crate::operation::start_query::StartQueryError,
140            >::new())
141            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
142                crate::operation::start_query::StartQueryError,
143            >::new())
144            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
145                crate::operation::start_query::StartQueryError,
146            >::new());
147
148        ::std::borrow::Cow::Owned(rcb)
149    }
150}
151
152#[derive(Debug)]
153struct StartQueryTelemetryInputCaptureInterceptor;
154
155#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
156impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartQueryTelemetryInputCaptureInterceptor {
157    fn name(&self) -> &'static str {
158        "StartQueryTelemetryInputCaptureInterceptor"
159    }
160
161    fn read_before_execution(
162        &self,
163        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
164            '_,
165            ::aws_smithy_runtime_api::client::interceptors::context::Input,
166            ::aws_smithy_runtime_api::client::interceptors::context::Output,
167            ::aws_smithy_runtime_api::client::interceptors::context::Error,
168        >,
169        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
170    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
171        // Nothing to do unless the customer opted in by naming members to record.
172        let ::std::option::Option::Some(requested) = cfg
173            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
174            .filter(|r| !r.is_empty())
175        else {
176            return ::std::result::Result::Ok(());
177        };
178
179        let ::std::option::Option::Some(input) = context.input().downcast_ref::<StartQueryInput>() else {
180            // A mismatched input is not this interceptor's concern; skip quietly.
181            return ::std::result::Result::Ok(());
182        };
183
184        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
185        if requested.should_capture("logGroupName") {
186            if let ::std::option::Option::Some(value) = input.log_group_name.as_deref() {
187                captured.insert("logGroupName", value);
188            }
189        }
190        if requested.should_capture("queryString") {
191            if let ::std::option::Option::Some(value) = input.query_string.as_deref() {
192                captured.insert("queryString", value);
193            }
194        }
195
196        cfg.interceptor_state().store_put(captured);
197        ::std::result::Result::Ok(())
198    }
199}
200#[derive(Debug)]
201struct StartQueryResponseDeserializer;
202impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StartQueryResponseDeserializer {
203    fn deserialize_nonstreaming_with_config(
204        &self,
205        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
206        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
207    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
208        let (success, status) = (response.status().is_success(), response.status().as_u16());
209        let headers = response.headers();
210        let body = response.body().bytes().expect("body loaded");
211        #[allow(unused_mut)]
212        let mut force_error = false;
213        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
214        let parse_result = if !success && status != 200 || force_error {
215            crate::protocol_serde::shape_start_query::de_start_query_http_error(status, headers, body)
216        } else {
217            crate::protocol_serde::shape_start_query::de_start_query_http_response(status, headers, body)
218        };
219        crate::protocol_serde::type_erase_result(parse_result)
220    }
221}
222#[derive(Debug)]
223struct StartQueryRequestSerializer;
224impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StartQueryRequestSerializer {
225    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
226    fn serialize_input(
227        &self,
228        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
229        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
230    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
231        let input = input.downcast::<crate::operation::start_query::StartQueryInput>().expect("correct type");
232        let _header_serialization_settings = _cfg
233            .load::<crate::serialization_settings::HeaderSerializationSettings>()
234            .cloned()
235            .unwrap_or_default();
236        let mut request_builder = {
237            #[allow(clippy::uninlined_format_args)]
238            fn uri_base(
239                _input: &crate::operation::start_query::StartQueryInput,
240                output: &mut ::std::string::String,
241            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
242                use ::std::fmt::Write as _;
243                ::std::write!(output, "/").expect("formatting should succeed");
244                ::std::result::Result::Ok(())
245            }
246            #[allow(clippy::unnecessary_wraps)]
247            fn update_http_builder(
248                input: &crate::operation::start_query::StartQueryInput,
249                builder: ::http_1x::request::Builder,
250            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
251                let mut uri = ::std::string::String::new();
252                uri_base(input, &mut uri)?;
253                ::std::result::Result::Ok(builder.method("POST").uri(uri))
254            }
255            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
256            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-amz-json-1.1");
257            builder = _header_serialization_settings.set_default_header(
258                builder,
259                ::http_1x::header::HeaderName::from_static("x-amz-target"),
260                "Logs_20140328.StartQuery",
261            );
262            builder
263        };
264        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_start_query::ser_start_query_input(&input)?);
265        if let Some(content_length) = body.content_length() {
266            let content_length = content_length.to_string();
267            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
268        }
269        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
270    }
271}
272#[derive(Debug)]
273struct StartQueryEndpointParamsInterceptor;
274
275#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
276impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartQueryEndpointParamsInterceptor {
277    fn name(&self) -> &'static str {
278        "StartQueryEndpointParamsInterceptor"
279    }
280
281    fn read_before_execution(
282        &self,
283        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
284            '_,
285            ::aws_smithy_runtime_api::client::interceptors::context::Input,
286            ::aws_smithy_runtime_api::client::interceptors::context::Output,
287            ::aws_smithy_runtime_api::client::interceptors::context::Error,
288        >,
289        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
290    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
291        let _input = context
292            .input()
293            .downcast_ref::<StartQueryInput>()
294            .ok_or("failed to downcast to StartQueryInput")?;
295
296        let params = crate::config::endpoint::Params::builder()
297            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
298            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
299            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
300            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
301            .build()
302            .map_err(|err| {
303                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
304            })?;
305        cfg.interceptor_state()
306            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
307        ::std::result::Result::Ok(())
308    }
309}
310
311// The get_* functions below are generated from JMESPath expressions in the
312// operationContextParams trait. They target the operation's input shape.
313
314/// Error type for the `StartQueryError` operation.
315#[non_exhaustive]
316#[derive(::std::fmt::Debug)]
317pub enum StartQueryError {
318    /// <p>A parameter is specified incorrectly.</p>
319    InvalidParameterException(crate::types::error::InvalidParameterException),
320    /// <p>You have reached the maximum number of resources that can be created.</p>
321    LimitExceededException(crate::types::error::LimitExceededException),
322    /// <p>The query string is not valid. Details about this error are displayed in a <code>QueryCompileError</code> object. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_QueryCompileError.html">QueryCompileError</a>.</p>
323    /// <p>For more information about valid query syntax, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html">CloudWatch Logs Insights Query Syntax</a>.</p>
324    MalformedQueryException(crate::types::error::MalformedQueryException),
325    /// <p>The specified resource does not exist.</p>
326    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
327    /// <p>The service cannot complete the request.</p>
328    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
329    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
330    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
331    variable wildcard pattern and check `.code()`:
332     \
333    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
334     \
335    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StartQueryError) for what information is available for the error.")]
336    Unhandled(crate::error::sealed_unhandled::Unhandled),
337}
338impl StartQueryError {
339    /// Creates the `StartQueryError::Unhandled` variant from any error type.
340    pub fn unhandled(
341        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
342    ) -> Self {
343        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
344            source: err.into(),
345            meta: ::std::default::Default::default(),
346        })
347    }
348
349    /// Creates the `StartQueryError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
350    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
351        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
352            source: err.clone().into(),
353            meta: err,
354        })
355    }
356    ///
357    /// Returns error metadata, which includes the error code, message,
358    /// request ID, and potentially additional information.
359    ///
360    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
361        match self {
362            Self::InvalidParameterException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
363            Self::LimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
364            Self::MalformedQueryException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
365            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
366            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
367            Self::Unhandled(e) => &e.meta,
368        }
369    }
370    /// Returns `true` if the error kind is `StartQueryError::InvalidParameterException`.
371    pub fn is_invalid_parameter_exception(&self) -> bool {
372        matches!(self, Self::InvalidParameterException(_))
373    }
374    /// Returns `true` if the error kind is `StartQueryError::LimitExceededException`.
375    pub fn is_limit_exceeded_exception(&self) -> bool {
376        matches!(self, Self::LimitExceededException(_))
377    }
378    /// Returns `true` if the error kind is `StartQueryError::MalformedQueryException`.
379    pub fn is_malformed_query_exception(&self) -> bool {
380        matches!(self, Self::MalformedQueryException(_))
381    }
382    /// Returns `true` if the error kind is `StartQueryError::ResourceNotFoundException`.
383    pub fn is_resource_not_found_exception(&self) -> bool {
384        matches!(self, Self::ResourceNotFoundException(_))
385    }
386    /// Returns `true` if the error kind is `StartQueryError::ServiceUnavailableException`.
387    pub fn is_service_unavailable_exception(&self) -> bool {
388        matches!(self, Self::ServiceUnavailableException(_))
389    }
390}
391impl ::std::error::Error for StartQueryError {
392    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
393        match self {
394            Self::InvalidParameterException(_inner) => ::std::option::Option::Some(_inner),
395            Self::LimitExceededException(_inner) => ::std::option::Option::Some(_inner),
396            Self::MalformedQueryException(_inner) => ::std::option::Option::Some(_inner),
397            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
398            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
399            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
400        }
401    }
402}
403impl ::std::fmt::Display for StartQueryError {
404    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
405        match self {
406            Self::InvalidParameterException(_inner) => _inner.fmt(f),
407            Self::LimitExceededException(_inner) => _inner.fmt(f),
408            Self::MalformedQueryException(_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 StartQueryError {
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 StartQueryError {
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::LimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
434            Self::MalformedQueryException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
435            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
436            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
437            Self::Unhandled(_inner) => &_inner.meta,
438        }
439    }
440}
441impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StartQueryError {
442    fn create_unhandled_error(
443        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
444        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
445    ) -> Self {
446        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
447            source,
448            meta: meta.unwrap_or_default(),
449        })
450    }
451}
452impl ::aws_types::request_id::RequestId for crate::operation::start_query::StartQueryError {
453    fn request_id(&self) -> Option<&str> {
454        self.meta().request_id()
455    }
456}
457
458pub use crate::operation::start_query::_start_query_input::StartQueryInput;
459
460pub use crate::operation::start_query::_start_query_output::StartQueryOutput;
461
462mod _start_query_input;
463
464mod _start_query_output;
465
466/// Builders
467pub mod builders;
aws_sdk_cloudwatchlogs/operation/start_query.rs

aws_sdk_cloudwatchlogs/operation/
start_query.rs
