aws_sdk_ssm/operation/
modify_document_permission.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ModifyDocumentPermission`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ModifyDocumentPermission;
6impl ModifyDocumentPermission {
7    /// Creates a new `ModifyDocumentPermission`
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::modify_document_permission::ModifyDocumentPermissionInput,
14    ) -> ::std::result::Result<
15        crate::operation::modify_document_permission::ModifyDocumentPermissionOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::modify_document_permission::ModifyDocumentPermissionError,
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::modify_document_permission::ModifyDocumentPermissionError>()
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::modify_document_permission::ModifyDocumentPermissionOutput>()
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::modify_document_permission::ModifyDocumentPermissionInput,
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("SSM", "ModifyDocumentPermission", 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                "SSM.ModifyDocumentPermission",
59                "rpc.service" = "SSM",
60                "rpc.method" = "ModifyDocumentPermission",
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 ModifyDocumentPermission {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ModifyDocumentPermission");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            ModifyDocumentPermissionRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            ModifyDocumentPermissionResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("ModifyDocumentPermission")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "ModifyDocumentPermission",
107            "SSM",
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("ModifyDocumentPermission")
129            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130            .with_interceptor(ModifyDocumentPermissionEndpointParamsInterceptor)
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::modify_document_permission::ModifyDocumentPermissionError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::modify_document_permission::ModifyDocumentPermissionError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::modify_document_permission::ModifyDocumentPermissionError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct ModifyDocumentPermissionResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ModifyDocumentPermissionResponseDeserializer {
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_modify_document_permission::de_modify_document_permission_http_error(status, headers, body)
160        } else {
161            crate::protocol_serde::shape_modify_document_permission::de_modify_document_permission_http_response(status, headers, body)
162        };
163        crate::protocol_serde::type_erase_result(parse_result)
164    }
165}
166#[derive(Debug)]
167struct ModifyDocumentPermissionRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ModifyDocumentPermissionRequestSerializer {
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::modify_document_permission::ModifyDocumentPermissionInput>()
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            fn uri_base(
184                _input: &crate::operation::modify_document_permission::ModifyDocumentPermissionInput,
185                output: &mut ::std::string::String,
186            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
187                use ::std::fmt::Write as _;
188                ::std::write!(output, "/").expect("formatting should succeed");
189                ::std::result::Result::Ok(())
190            }
191            #[allow(clippy::unnecessary_wraps)]
192            fn update_http_builder(
193                input: &crate::operation::modify_document_permission::ModifyDocumentPermissionInput,
194                builder: ::http::request::Builder,
195            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
196                let mut uri = ::std::string::String::new();
197                uri_base(input, &mut uri)?;
198                ::std::result::Result::Ok(builder.method("POST").uri(uri))
199            }
200            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
201            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.1");
202            builder = _header_serialization_settings.set_default_header(
203                builder,
204                ::http::header::HeaderName::from_static("x-amz-target"),
205                "AmazonSSM.ModifyDocumentPermission",
206            );
207            builder
208        };
209        let body = ::aws_smithy_types::body::SdkBody::from(
210            crate::protocol_serde::shape_modify_document_permission::ser_modify_document_permission_input(&input)?,
211        );
212        if let Some(content_length) = body.content_length() {
213            let content_length = content_length.to_string();
214            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
215        }
216        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
217    }
218}
219#[derive(Debug)]
220struct ModifyDocumentPermissionEndpointParamsInterceptor;
221
222impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ModifyDocumentPermissionEndpointParamsInterceptor {
223    fn name(&self) -> &'static str {
224        "ModifyDocumentPermissionEndpointParamsInterceptor"
225    }
226
227    fn read_before_execution(
228        &self,
229        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
230            '_,
231            ::aws_smithy_runtime_api::client::interceptors::context::Input,
232            ::aws_smithy_runtime_api::client::interceptors::context::Output,
233            ::aws_smithy_runtime_api::client::interceptors::context::Error,
234        >,
235        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
236    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
237        let _input = context
238            .input()
239            .downcast_ref::<ModifyDocumentPermissionInput>()
240            .ok_or("failed to downcast to ModifyDocumentPermissionInput")?;
241
242        let params = crate::config::endpoint::Params::builder()
243            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
244            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
245            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
246            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
247            .build()
248            .map_err(|err| {
249                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
250            })?;
251        cfg.interceptor_state()
252            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
253        ::std::result::Result::Ok(())
254    }
255}
256
257// The get_* functions below are generated from JMESPath expressions in the
258// operationContextParams trait. They target the operation's input shape.
259
260/// Error type for the `ModifyDocumentPermissionError` operation.
261#[non_exhaustive]
262#[derive(::std::fmt::Debug)]
263pub enum ModifyDocumentPermissionError {
264    /// <p>You can have at most 500 active SSM documents.</p>
265    DocumentLimitExceeded(crate::types::error::DocumentLimitExceeded),
266    /// <p>The document can't be shared with more Amazon Web Services accounts. You can specify a maximum of 20 accounts per API operation to share a private document.</p>
267    /// <p>By default, you can share a private document with a maximum of 1,000 accounts and publicly share up to five documents.</p>
268    /// <p>If you need to increase the quota for privately or publicly shared Systems Manager documents, contact Amazon Web Services Support.</p>
269    DocumentPermissionLimit(crate::types::error::DocumentPermissionLimit),
270    /// <p>An error occurred on the server side.</p>
271    InternalServerError(crate::types::error::InternalServerError),
272    /// <p>The specified SSM document doesn't exist.</p>
273    InvalidDocument(crate::types::error::InvalidDocument),
274    /// <p>The permission type isn't supported. <i>Share</i> is the only supported permission type.</p>
275    InvalidPermissionType(crate::types::error::InvalidPermissionType),
276    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
277    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
278    variable wildcard pattern and check `.code()`:
279     \
280    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
281     \
282    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ModifyDocumentPermissionError) for what information is available for the error.")]
283    Unhandled(crate::error::sealed_unhandled::Unhandled),
284}
285impl ModifyDocumentPermissionError {
286    /// Creates the `ModifyDocumentPermissionError::Unhandled` variant from any error type.
287    pub fn unhandled(
288        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
289    ) -> Self {
290        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
291            source: err.into(),
292            meta: ::std::default::Default::default(),
293        })
294    }
295
296    /// Creates the `ModifyDocumentPermissionError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
297    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
298        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
299            source: err.clone().into(),
300            meta: err,
301        })
302    }
303    ///
304    /// Returns error metadata, which includes the error code, message,
305    /// request ID, and potentially additional information.
306    ///
307    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
308        match self {
309            Self::DocumentLimitExceeded(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
310            Self::DocumentPermissionLimit(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
311            Self::InternalServerError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
312            Self::InvalidDocument(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
313            Self::InvalidPermissionType(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
314            Self::Unhandled(e) => &e.meta,
315        }
316    }
317    /// Returns `true` if the error kind is `ModifyDocumentPermissionError::DocumentLimitExceeded`.
318    pub fn is_document_limit_exceeded(&self) -> bool {
319        matches!(self, Self::DocumentLimitExceeded(_))
320    }
321    /// Returns `true` if the error kind is `ModifyDocumentPermissionError::DocumentPermissionLimit`.
322    pub fn is_document_permission_limit(&self) -> bool {
323        matches!(self, Self::DocumentPermissionLimit(_))
324    }
325    /// Returns `true` if the error kind is `ModifyDocumentPermissionError::InternalServerError`.
326    pub fn is_internal_server_error(&self) -> bool {
327        matches!(self, Self::InternalServerError(_))
328    }
329    /// Returns `true` if the error kind is `ModifyDocumentPermissionError::InvalidDocument`.
330    pub fn is_invalid_document(&self) -> bool {
331        matches!(self, Self::InvalidDocument(_))
332    }
333    /// Returns `true` if the error kind is `ModifyDocumentPermissionError::InvalidPermissionType`.
334    pub fn is_invalid_permission_type(&self) -> bool {
335        matches!(self, Self::InvalidPermissionType(_))
336    }
337}
338impl ::std::error::Error for ModifyDocumentPermissionError {
339    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
340        match self {
341            Self::DocumentLimitExceeded(_inner) => ::std::option::Option::Some(_inner),
342            Self::DocumentPermissionLimit(_inner) => ::std::option::Option::Some(_inner),
343            Self::InternalServerError(_inner) => ::std::option::Option::Some(_inner),
344            Self::InvalidDocument(_inner) => ::std::option::Option::Some(_inner),
345            Self::InvalidPermissionType(_inner) => ::std::option::Option::Some(_inner),
346            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
347        }
348    }
349}
350impl ::std::fmt::Display for ModifyDocumentPermissionError {
351    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
352        match self {
353            Self::DocumentLimitExceeded(_inner) => _inner.fmt(f),
354            Self::DocumentPermissionLimit(_inner) => _inner.fmt(f),
355            Self::InternalServerError(_inner) => _inner.fmt(f),
356            Self::InvalidDocument(_inner) => _inner.fmt(f),
357            Self::InvalidPermissionType(_inner) => _inner.fmt(f),
358            Self::Unhandled(_inner) => {
359                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
360                    write!(f, "unhandled error ({code})")
361                } else {
362                    f.write_str("unhandled error")
363                }
364            }
365        }
366    }
367}
368impl ::aws_smithy_types::retry::ProvideErrorKind for ModifyDocumentPermissionError {
369    fn code(&self) -> ::std::option::Option<&str> {
370        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
371    }
372    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
373        ::std::option::Option::None
374    }
375}
376impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ModifyDocumentPermissionError {
377    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
378        match self {
379            Self::DocumentLimitExceeded(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
380            Self::DocumentPermissionLimit(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
381            Self::InternalServerError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
382            Self::InvalidDocument(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
383            Self::InvalidPermissionType(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
384            Self::Unhandled(_inner) => &_inner.meta,
385        }
386    }
387}
388impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ModifyDocumentPermissionError {
389    fn create_unhandled_error(
390        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
391        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
392    ) -> Self {
393        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
394            source,
395            meta: meta.unwrap_or_default(),
396        })
397    }
398}
399impl ::aws_types::request_id::RequestId for crate::operation::modify_document_permission::ModifyDocumentPermissionError {
400    fn request_id(&self) -> Option<&str> {
401        self.meta().request_id()
402    }
403}
404
405pub use crate::operation::modify_document_permission::_modify_document_permission_output::ModifyDocumentPermissionOutput;
406
407pub use crate::operation::modify_document_permission::_modify_document_permission_input::ModifyDocumentPermissionInput;
408
409mod _modify_document_permission_input;
410
411mod _modify_document_permission_output;
412
413/// Builders
414pub mod builders;
aws_sdk_ssm/operation/modify_document_permission.rs

aws_sdk_ssm/operation/
modify_document_permission.rs
