aws_sdk_workdocs/operation/
delete_custom_metadata.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DeleteCustomMetadata`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DeleteCustomMetadata;
6impl DeleteCustomMetadata {
7    /// Creates a new `DeleteCustomMetadata`
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::delete_custom_metadata::DeleteCustomMetadataInput,
14    ) -> ::std::result::Result<
15        crate::operation::delete_custom_metadata::DeleteCustomMetadataOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::delete_custom_metadata::DeleteCustomMetadataError,
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::delete_custom_metadata::DeleteCustomMetadataError>()
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::delete_custom_metadata::DeleteCustomMetadataOutput>()
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::delete_custom_metadata::DeleteCustomMetadataInput,
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("WorkDocs", "DeleteCustomMetadata", 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                "WorkDocs.DeleteCustomMetadata",
59                "rpc.service" = "WorkDocs",
60                "rpc.method" = "DeleteCustomMetadata",
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 DeleteCustomMetadata {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DeleteCustomMetadata");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            DeleteCustomMetadataRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            DeleteCustomMetadataResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("DeleteCustomMetadata")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "DeleteCustomMetadata",
107            "WorkDocs",
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("DeleteCustomMetadata")
129            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130            .with_interceptor(DeleteCustomMetadataEndpointParamsInterceptor)
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::delete_custom_metadata::DeleteCustomMetadataError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::delete_custom_metadata::DeleteCustomMetadataError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::delete_custom_metadata::DeleteCustomMetadataError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct DeleteCustomMetadataResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DeleteCustomMetadataResponseDeserializer {
148    fn deserialize_nonstreaming(
149        &self,
150        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
151    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
152        let (success, status) = (response.status().is_success(), response.status().as_u16());
153        let headers = response.headers();
154        let body = response.body().bytes().expect("body loaded");
155        #[allow(unused_mut)]
156        let mut force_error = false;
157        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
158        let parse_result = if !success && status != 200 || force_error {
159            crate::protocol_serde::shape_delete_custom_metadata::de_delete_custom_metadata_http_error(status, headers, body)
160        } else {
161            crate::protocol_serde::shape_delete_custom_metadata::de_delete_custom_metadata_http_response(status, headers, body)
162        };
163        crate::protocol_serde::type_erase_result(parse_result)
164    }
165}
166#[derive(Debug)]
167struct DeleteCustomMetadataRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DeleteCustomMetadataRequestSerializer {
169    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
170    fn serialize_input(
171        &self,
172        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
173        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
174    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
175        let input = input
176            .downcast::<crate::operation::delete_custom_metadata::DeleteCustomMetadataInput>()
177            .expect("correct type");
178        let _header_serialization_settings = _cfg
179            .load::<crate::serialization_settings::HeaderSerializationSettings>()
180            .cloned()
181            .unwrap_or_default();
182        let mut request_builder = {
183            #[allow(clippy::uninlined_format_args)]
184            fn uri_base(
185                _input: &crate::operation::delete_custom_metadata::DeleteCustomMetadataInput,
186                output: &mut ::std::string::String,
187            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
188                use ::std::fmt::Write as _;
189                let input_1 = &_input.resource_id;
190                let input_1 = input_1
191                    .as_ref()
192                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("resource_id", "cannot be empty or unset"))?;
193                let resource_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
194                if resource_id.is_empty() {
195                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
196                        "resource_id",
197                        "cannot be empty or unset",
198                    ));
199                }
200                ::std::write!(output, "/api/v1/resources/{ResourceId}/customMetadata", ResourceId = resource_id).expect("formatting should succeed");
201                ::std::result::Result::Ok(())
202            }
203            fn uri_query(
204                _input: &crate::operation::delete_custom_metadata::DeleteCustomMetadataInput,
205                mut output: &mut ::std::string::String,
206            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
207                let mut query = ::aws_smithy_http::query::Writer::new(output);
208                if let ::std::option::Option::Some(inner_2) = &_input.version_id {
209                    {
210                        query.push_kv("versionId", &::aws_smithy_http::query::fmt_string(inner_2));
211                    }
212                }
213                if let ::std::option::Option::Some(inner_3) = &_input.keys {
214                    {
215                        for inner_4 in inner_3 {
216                            query.push_kv("keys", &::aws_smithy_http::query::fmt_string(inner_4));
217                        }
218                    }
219                }
220                if let ::std::option::Option::Some(inner_5) = &_input.delete_all {
221                    {
222                        query.push_kv("deleteAll", ::aws_smithy_types::primitive::Encoder::from(*inner_5).encode());
223                    }
224                }
225                ::std::result::Result::Ok(())
226            }
227            #[allow(clippy::unnecessary_wraps)]
228            fn update_http_builder(
229                input: &crate::operation::delete_custom_metadata::DeleteCustomMetadataInput,
230                builder: ::http::request::Builder,
231            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
232                let mut uri = ::std::string::String::new();
233                uri_base(input, &mut uri)?;
234                uri_query(input, &mut uri)?;
235                let builder = crate::protocol_serde::shape_delete_custom_metadata::ser_delete_custom_metadata_headers(input, builder)?;
236                ::std::result::Result::Ok(builder.method("DELETE").uri(uri))
237            }
238            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
239            builder
240        };
241        let body = ::aws_smithy_types::body::SdkBody::from("");
242
243        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
244    }
245}
246#[derive(Debug)]
247struct DeleteCustomMetadataEndpointParamsInterceptor;
248
249impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DeleteCustomMetadataEndpointParamsInterceptor {
250    fn name(&self) -> &'static str {
251        "DeleteCustomMetadataEndpointParamsInterceptor"
252    }
253
254    fn read_before_execution(
255        &self,
256        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
257            '_,
258            ::aws_smithy_runtime_api::client::interceptors::context::Input,
259            ::aws_smithy_runtime_api::client::interceptors::context::Output,
260            ::aws_smithy_runtime_api::client::interceptors::context::Error,
261        >,
262        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
263    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
264        let _input = context
265            .input()
266            .downcast_ref::<DeleteCustomMetadataInput>()
267            .ok_or("failed to downcast to DeleteCustomMetadataInput")?;
268
269        let params = crate::config::endpoint::Params::builder()
270            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
271            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
272            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
273            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
274            .build()
275            .map_err(|err| {
276                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
277            })?;
278        cfg.interceptor_state()
279            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
280        ::std::result::Result::Ok(())
281    }
282}
283
284// The get_* functions below are generated from JMESPath expressions in the
285// operationContextParams trait. They target the operation's input shape.
286
287/// Error type for the `DeleteCustomMetadataError` operation.
288#[non_exhaustive]
289#[derive(::std::fmt::Debug)]
290pub enum DeleteCustomMetadataError {
291    /// <p>The resource does not exist.</p>
292    EntityNotExistsException(crate::types::error::EntityNotExistsException),
293    /// <p>The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.</p>
294    FailedDependencyException(crate::types::error::FailedDependencyException),
295    /// <p>The specified document version is not in the INITIALIZED state.</p>
296    ProhibitedStateException(crate::types::error::ProhibitedStateException),
297    /// <p>One or more of the dependencies is unavailable.</p>
298    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
299    /// <p>The operation is not permitted.</p>
300    UnauthorizedOperationException(crate::types::error::UnauthorizedOperationException),
301    /// <p>The caller does not have access to perform the action on the resource.</p>
302    UnauthorizedResourceAccessException(crate::types::error::UnauthorizedResourceAccessException),
303    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
304    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
305    variable wildcard pattern and check `.code()`:
306     \
307    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
308     \
309    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DeleteCustomMetadataError) for what information is available for the error.")]
310    Unhandled(crate::error::sealed_unhandled::Unhandled),
311}
312impl DeleteCustomMetadataError {
313    /// Creates the `DeleteCustomMetadataError::Unhandled` variant from any error type.
314    pub fn unhandled(
315        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
316    ) -> Self {
317        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
318            source: err.into(),
319            meta: ::std::default::Default::default(),
320        })
321    }
322
323    /// Creates the `DeleteCustomMetadataError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
324    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
325        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
326            source: err.clone().into(),
327            meta: err,
328        })
329    }
330    ///
331    /// Returns error metadata, which includes the error code, message,
332    /// request ID, and potentially additional information.
333    ///
334    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
335        match self {
336            Self::EntityNotExistsException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
337            Self::FailedDependencyException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
338            Self::ProhibitedStateException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
339            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
340            Self::UnauthorizedOperationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
341            Self::UnauthorizedResourceAccessException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
342            Self::Unhandled(e) => &e.meta,
343        }
344    }
345    /// Returns `true` if the error kind is `DeleteCustomMetadataError::EntityNotExistsException`.
346    pub fn is_entity_not_exists_exception(&self) -> bool {
347        matches!(self, Self::EntityNotExistsException(_))
348    }
349    /// Returns `true` if the error kind is `DeleteCustomMetadataError::FailedDependencyException`.
350    pub fn is_failed_dependency_exception(&self) -> bool {
351        matches!(self, Self::FailedDependencyException(_))
352    }
353    /// Returns `true` if the error kind is `DeleteCustomMetadataError::ProhibitedStateException`.
354    pub fn is_prohibited_state_exception(&self) -> bool {
355        matches!(self, Self::ProhibitedStateException(_))
356    }
357    /// Returns `true` if the error kind is `DeleteCustomMetadataError::ServiceUnavailableException`.
358    pub fn is_service_unavailable_exception(&self) -> bool {
359        matches!(self, Self::ServiceUnavailableException(_))
360    }
361    /// Returns `true` if the error kind is `DeleteCustomMetadataError::UnauthorizedOperationException`.
362    pub fn is_unauthorized_operation_exception(&self) -> bool {
363        matches!(self, Self::UnauthorizedOperationException(_))
364    }
365    /// Returns `true` if the error kind is `DeleteCustomMetadataError::UnauthorizedResourceAccessException`.
366    pub fn is_unauthorized_resource_access_exception(&self) -> bool {
367        matches!(self, Self::UnauthorizedResourceAccessException(_))
368    }
369}
370impl ::std::error::Error for DeleteCustomMetadataError {
371    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
372        match self {
373            Self::EntityNotExistsException(_inner) => ::std::option::Option::Some(_inner),
374            Self::FailedDependencyException(_inner) => ::std::option::Option::Some(_inner),
375            Self::ProhibitedStateException(_inner) => ::std::option::Option::Some(_inner),
376            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
377            Self::UnauthorizedOperationException(_inner) => ::std::option::Option::Some(_inner),
378            Self::UnauthorizedResourceAccessException(_inner) => ::std::option::Option::Some(_inner),
379            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
380        }
381    }
382}
383impl ::std::fmt::Display for DeleteCustomMetadataError {
384    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
385        match self {
386            Self::EntityNotExistsException(_inner) => _inner.fmt(f),
387            Self::FailedDependencyException(_inner) => _inner.fmt(f),
388            Self::ProhibitedStateException(_inner) => _inner.fmt(f),
389            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
390            Self::UnauthorizedOperationException(_inner) => _inner.fmt(f),
391            Self::UnauthorizedResourceAccessException(_inner) => _inner.fmt(f),
392            Self::Unhandled(_inner) => {
393                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
394                    write!(f, "unhandled error ({code})")
395                } else {
396                    f.write_str("unhandled error")
397                }
398            }
399        }
400    }
401}
402impl ::aws_smithy_types::retry::ProvideErrorKind for DeleteCustomMetadataError {
403    fn code(&self) -> ::std::option::Option<&str> {
404        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
405    }
406    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
407        ::std::option::Option::None
408    }
409}
410impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DeleteCustomMetadataError {
411    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
412        match self {
413            Self::EntityNotExistsException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
414            Self::FailedDependencyException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
415            Self::ProhibitedStateException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
416            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
417            Self::UnauthorizedOperationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
418            Self::UnauthorizedResourceAccessException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
419            Self::Unhandled(_inner) => &_inner.meta,
420        }
421    }
422}
423impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DeleteCustomMetadataError {
424    fn create_unhandled_error(
425        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
426        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
427    ) -> Self {
428        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
429            source,
430            meta: meta.unwrap_or_default(),
431        })
432    }
433}
434impl ::aws_types::request_id::RequestId for crate::operation::delete_custom_metadata::DeleteCustomMetadataError {
435    fn request_id(&self) -> Option<&str> {
436        self.meta().request_id()
437    }
438}
439
440pub use crate::operation::delete_custom_metadata::_delete_custom_metadata_output::DeleteCustomMetadataOutput;
441
442pub use crate::operation::delete_custom_metadata::_delete_custom_metadata_input::DeleteCustomMetadataInput;
443
444mod _delete_custom_metadata_input;
445
446mod _delete_custom_metadata_output;
447
448/// Builders
449pub mod builders;