aws_sdk_comprehend/operation/
start_sentiment_detection_job.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `StartSentimentDetectionJob`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct StartSentimentDetectionJob;
6impl StartSentimentDetectionJob {
7    /// Creates a new `StartSentimentDetectionJob`
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_sentiment_detection_job::StartSentimentDetectionJobInput,
14    ) -> ::std::result::Result<
15        crate::operation::start_sentiment_detection_job::StartSentimentDetectionJobOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::start_sentiment_detection_job::StartSentimentDetectionJobError,
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_sentiment_detection_job::StartSentimentDetectionJobError>()
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_sentiment_detection_job::StartSentimentDetectionJobOutput>()
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_sentiment_detection_job::StartSentimentDetectionJobInput,
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            "Comprehend",
56            "StartSentimentDetectionJob",
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            "Comprehend.StartSentimentDetectionJob",
65            "rpc.service" = "Comprehend",
66            "rpc.method" = "StartSentimentDetectionJob",
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        runtime_plugins = runtime_plugins.with_operation_plugin(crate::client_idempotency_token::IdempotencyTokenRuntimePlugin::new(
80            |token_provider, input| {
81                let input: &mut crate::operation::start_sentiment_detection_job::StartSentimentDetectionJobInput =
82                    input.downcast_mut().expect("correct type");
83                if input.client_request_token.is_none() {
84                    input.client_request_token = ::std::option::Option::Some(token_provider.make_idempotency_token());
85                }
86            },
87        ));
88        if let ::std::option::Option::Some(config_override) = config_override {
89            for plugin in config_override.runtime_plugins.iter().cloned() {
90                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
91            }
92            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
93                config_override,
94                client_config.config.clone(),
95                &client_config.runtime_components,
96            ));
97        }
98        runtime_plugins
99    }
100}
101impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for StartSentimentDetectionJob {
102    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
103        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("StartSentimentDetectionJob");
104
105        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
106            StartSentimentDetectionJobRequestSerializer,
107        ));
108        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
109            StartSentimentDetectionJobResponseDeserializer,
110        ));
111
112        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
113            crate::config::auth::Params::builder()
114                .operation_name("StartSentimentDetectionJob")
115                .build()
116                .expect("required fields set"),
117        ));
118
119        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
120            "StartSentimentDetectionJob",
121            "Comprehend",
122        ));
123        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
124        signing_options.double_uri_encode = true;
125        signing_options.content_sha256_header = false;
126        signing_options.normalize_uri_path = true;
127        signing_options.payload_override = None;
128
129        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
130            signing_options,
131            ..::std::default::Default::default()
132        });
133
134        ::std::option::Option::Some(cfg.freeze())
135    }
136
137    fn runtime_components(
138        &self,
139        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
140    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
141        #[allow(unused_mut)]
142        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("StartSentimentDetectionJob")
143            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
144                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
145            ))
146            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
147                StartSentimentDetectionJobEndpointParamsInterceptor,
148            ))
149            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
150                crate::operation::start_sentiment_detection_job::StartSentimentDetectionJobError,
151            >::new())
152            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
153                crate::operation::start_sentiment_detection_job::StartSentimentDetectionJobError,
154            >::new())
155            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
156                crate::operation::start_sentiment_detection_job::StartSentimentDetectionJobError,
157            >::new());
158
159        ::std::borrow::Cow::Owned(rcb)
160    }
161}
162
163#[derive(Debug)]
164struct StartSentimentDetectionJobResponseDeserializer;
165impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StartSentimentDetectionJobResponseDeserializer {
166    fn deserialize_nonstreaming(
167        &self,
168        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
169    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
170        let (success, status) = (response.status().is_success(), response.status().as_u16());
171        let headers = response.headers();
172        let body = response.body().bytes().expect("body loaded");
173        #[allow(unused_mut)]
174        let mut force_error = false;
175        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
176        let parse_result = if !success && status != 200 || force_error {
177            crate::protocol_serde::shape_start_sentiment_detection_job::de_start_sentiment_detection_job_http_error(status, headers, body)
178        } else {
179            crate::protocol_serde::shape_start_sentiment_detection_job::de_start_sentiment_detection_job_http_response(status, headers, body)
180        };
181        crate::protocol_serde::type_erase_result(parse_result)
182    }
183}
184#[derive(Debug)]
185struct StartSentimentDetectionJobRequestSerializer;
186impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StartSentimentDetectionJobRequestSerializer {
187    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
188    fn serialize_input(
189        &self,
190        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
191        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
192    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
193        let input = input
194            .downcast::<crate::operation::start_sentiment_detection_job::StartSentimentDetectionJobInput>()
195            .expect("correct type");
196        let _header_serialization_settings = _cfg
197            .load::<crate::serialization_settings::HeaderSerializationSettings>()
198            .cloned()
199            .unwrap_or_default();
200        let mut request_builder = {
201            #[allow(clippy::uninlined_format_args)]
202            fn uri_base(
203                _input: &crate::operation::start_sentiment_detection_job::StartSentimentDetectionJobInput,
204                output: &mut ::std::string::String,
205            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
206                use ::std::fmt::Write as _;
207                ::std::write!(output, "/").expect("formatting should succeed");
208                ::std::result::Result::Ok(())
209            }
210            #[allow(clippy::unnecessary_wraps)]
211            fn update_http_builder(
212                input: &crate::operation::start_sentiment_detection_job::StartSentimentDetectionJobInput,
213                builder: ::http_1x::request::Builder,
214            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
215                let mut uri = ::std::string::String::new();
216                uri_base(input, &mut uri)?;
217                ::std::result::Result::Ok(builder.method("POST").uri(uri))
218            }
219            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
220            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-amz-json-1.1");
221            builder = _header_serialization_settings.set_default_header(
222                builder,
223                ::http_1x::header::HeaderName::from_static("x-amz-target"),
224                "Comprehend_20171127.StartSentimentDetectionJob",
225            );
226            builder
227        };
228        let body = ::aws_smithy_types::body::SdkBody::from(
229            crate::protocol_serde::shape_start_sentiment_detection_job::ser_start_sentiment_detection_job_input(&input)?,
230        );
231        if let Some(content_length) = body.content_length() {
232            let content_length = content_length.to_string();
233            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
234        }
235        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
236    }
237}
238#[derive(Debug)]
239struct StartSentimentDetectionJobEndpointParamsInterceptor;
240
241#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
242impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartSentimentDetectionJobEndpointParamsInterceptor {
243    fn name(&self) -> &'static str {
244        "StartSentimentDetectionJobEndpointParamsInterceptor"
245    }
246
247    fn read_before_execution(
248        &self,
249        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
250            '_,
251            ::aws_smithy_runtime_api::client::interceptors::context::Input,
252            ::aws_smithy_runtime_api::client::interceptors::context::Output,
253            ::aws_smithy_runtime_api::client::interceptors::context::Error,
254        >,
255        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
256    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
257        let _input = context
258            .input()
259            .downcast_ref::<StartSentimentDetectionJobInput>()
260            .ok_or("failed to downcast to StartSentimentDetectionJobInput")?;
261
262        let params = crate::config::endpoint::Params::builder()
263            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
264            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
265            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
266            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
267            .build()
268            .map_err(|err| {
269                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
270            })?;
271        cfg.interceptor_state()
272            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
273        ::std::result::Result::Ok(())
274    }
275}
276
277// The get_* functions below are generated from JMESPath expressions in the
278// operationContextParams trait. They target the operation's input shape.
279
280/// Error type for the `StartSentimentDetectionJobError` operation.
281#[non_exhaustive]
282#[derive(::std::fmt::Debug)]
283pub enum StartSentimentDetectionJobError {
284    /// <p>An internal server error occurred. Retry your request.</p>
285    InternalServerException(crate::types::error::InternalServerException),
286    /// <p>The request is invalid.</p>
287    InvalidRequestException(crate::types::error::InvalidRequestException),
288    /// <p>The KMS customer managed key (CMK) entered cannot be validated. Verify the key and re-enter it.</p>
289    KmsKeyValidationException(crate::types::error::KmsKeyValidationException),
290    /// <p>The specified resource name is already in use. Use a different name and try your request again.</p>
291    ResourceInUseException(crate::types::error::ResourceInUseException),
292    /// <p>The number of requests exceeds the limit. Resubmit your request later.</p>
293    TooManyRequestsException(crate::types::error::TooManyRequestsException),
294    /// <p>The request contains more tags than can be associated with a resource (50 tags per resource). The maximum number of tags includes both existing tags and those included in your current request.</p>
295    TooManyTagsException(crate::types::error::TooManyTagsException),
296    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
297    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
298    variable wildcard pattern and check `.code()`:
299     \
300    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
301     \
302    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StartSentimentDetectionJobError) for what information is available for the error.")]
303    Unhandled(crate::error::sealed_unhandled::Unhandled),
304}
305impl StartSentimentDetectionJobError {
306    /// Creates the `StartSentimentDetectionJobError::Unhandled` variant from any error type.
307    pub fn unhandled(
308        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
309    ) -> Self {
310        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
311            source: err.into(),
312            meta: ::std::default::Default::default(),
313        })
314    }
315
316    /// Creates the `StartSentimentDetectionJobError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
317    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
318        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
319            source: err.clone().into(),
320            meta: err,
321        })
322    }
323    ///
324    /// Returns error metadata, which includes the error code, message,
325    /// request ID, and potentially additional information.
326    ///
327    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
328        match self {
329            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
330            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
331            Self::KmsKeyValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
332            Self::ResourceInUseException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
333            Self::TooManyRequestsException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
334            Self::TooManyTagsException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
335            Self::Unhandled(e) => &e.meta,
336        }
337    }
338    /// Returns `true` if the error kind is `StartSentimentDetectionJobError::InternalServerException`.
339    pub fn is_internal_server_exception(&self) -> bool {
340        matches!(self, Self::InternalServerException(_))
341    }
342    /// Returns `true` if the error kind is `StartSentimentDetectionJobError::InvalidRequestException`.
343    pub fn is_invalid_request_exception(&self) -> bool {
344        matches!(self, Self::InvalidRequestException(_))
345    }
346    /// Returns `true` if the error kind is `StartSentimentDetectionJobError::KmsKeyValidationException`.
347    pub fn is_kms_key_validation_exception(&self) -> bool {
348        matches!(self, Self::KmsKeyValidationException(_))
349    }
350    /// Returns `true` if the error kind is `StartSentimentDetectionJobError::ResourceInUseException`.
351    pub fn is_resource_in_use_exception(&self) -> bool {
352        matches!(self, Self::ResourceInUseException(_))
353    }
354    /// Returns `true` if the error kind is `StartSentimentDetectionJobError::TooManyRequestsException`.
355    pub fn is_too_many_requests_exception(&self) -> bool {
356        matches!(self, Self::TooManyRequestsException(_))
357    }
358    /// Returns `true` if the error kind is `StartSentimentDetectionJobError::TooManyTagsException`.
359    pub fn is_too_many_tags_exception(&self) -> bool {
360        matches!(self, Self::TooManyTagsException(_))
361    }
362}
363impl ::std::error::Error for StartSentimentDetectionJobError {
364    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
365        match self {
366            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
367            Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
368            Self::KmsKeyValidationException(_inner) => ::std::option::Option::Some(_inner),
369            Self::ResourceInUseException(_inner) => ::std::option::Option::Some(_inner),
370            Self::TooManyRequestsException(_inner) => ::std::option::Option::Some(_inner),
371            Self::TooManyTagsException(_inner) => ::std::option::Option::Some(_inner),
372            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
373        }
374    }
375}
376impl ::std::fmt::Display for StartSentimentDetectionJobError {
377    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
378        match self {
379            Self::InternalServerException(_inner) => _inner.fmt(f),
380            Self::InvalidRequestException(_inner) => _inner.fmt(f),
381            Self::KmsKeyValidationException(_inner) => _inner.fmt(f),
382            Self::ResourceInUseException(_inner) => _inner.fmt(f),
383            Self::TooManyRequestsException(_inner) => _inner.fmt(f),
384            Self::TooManyTagsException(_inner) => _inner.fmt(f),
385            Self::Unhandled(_inner) => {
386                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
387                    write!(f, "unhandled error ({code})")
388                } else {
389                    f.write_str("unhandled error")
390                }
391            }
392        }
393    }
394}
395impl ::aws_smithy_types::retry::ProvideErrorKind for StartSentimentDetectionJobError {
396    fn code(&self) -> ::std::option::Option<&str> {
397        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
398    }
399    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
400        ::std::option::Option::None
401    }
402}
403impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StartSentimentDetectionJobError {
404    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
405        match self {
406            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
407            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
408            Self::KmsKeyValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
409            Self::ResourceInUseException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
410            Self::TooManyRequestsException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
411            Self::TooManyTagsException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
412            Self::Unhandled(_inner) => &_inner.meta,
413        }
414    }
415}
416impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StartSentimentDetectionJobError {
417    fn create_unhandled_error(
418        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
419        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
420    ) -> Self {
421        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
422            source,
423            meta: meta.unwrap_or_default(),
424        })
425    }
426}
427impl ::aws_types::request_id::RequestId for crate::operation::start_sentiment_detection_job::StartSentimentDetectionJobError {
428    fn request_id(&self) -> Option<&str> {
429        self.meta().request_id()
430    }
431}
432
433pub use crate::operation::start_sentiment_detection_job::_start_sentiment_detection_job_input::StartSentimentDetectionJobInput;
434
435pub use crate::operation::start_sentiment_detection_job::_start_sentiment_detection_job_output::StartSentimentDetectionJobOutput;
436
437mod _start_sentiment_detection_job_input;
438
439mod _start_sentiment_detection_job_output;
440
441/// Builders
442pub mod builders;
aws_sdk_comprehend/operation/start_sentiment_detection_job.rs

aws_sdk_comprehend/operation/
start_sentiment_detection_job.rs
