aws_sdk_qbusiness/operation/
check_document_access.rs1#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct CheckDocumentAccess;
6impl CheckDocumentAccess {
7 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::check_document_access::CheckDocumentAccessInput,
14 ) -> ::std::result::Result<
15 crate::operation::check_document_access::CheckDocumentAccessOutput,
16 ::aws_smithy_runtime_api::client::result::SdkError<
17 crate::operation::check_document_access::CheckDocumentAccessError,
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::check_document_access::CheckDocumentAccessError>()
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::check_document_access::CheckDocumentAccessOutput>()
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::check_document_access::CheckDocumentAccessInput,
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("QBusiness", "CheckDocumentAccess", input, runtime_plugins, stop_point)
55 .instrument(::tracing::debug_span!(
58 "QBusiness.CheckDocumentAccess",
59 "rpc.service" = "QBusiness",
60 "rpc.method" = "CheckDocumentAccess",
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 CheckDocumentAccess {
88 fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89 let mut cfg = ::aws_smithy_types::config_bag::Layer::new("CheckDocumentAccess");
90
91 cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92 CheckDocumentAccessRequestSerializer,
93 ));
94 cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95 CheckDocumentAccessResponseDeserializer,
96 ));
97
98 cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99 crate::config::auth::Params::builder()
100 .operation_name("CheckDocumentAccess")
101 .build()
102 .expect("required fields set"),
103 ));
104
105 cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106 "CheckDocumentAccess",
107 "QBusiness",
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("CheckDocumentAccess")
129 .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130 .with_interceptor(CheckDocumentAccessEndpointParamsInterceptor)
131 .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132 crate::operation::check_document_access::CheckDocumentAccessError,
133 >::new())
134 .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135 crate::operation::check_document_access::CheckDocumentAccessError,
136 >::new())
137 .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138 crate::operation::check_document_access::CheckDocumentAccessError,
139 >::new());
140
141 ::std::borrow::Cow::Owned(rcb)
142 }
143}
144
145#[derive(Debug)]
146struct CheckDocumentAccessResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for CheckDocumentAccessResponseDeserializer {
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_check_document_access::de_check_document_access_http_error(status, headers, body)
160 } else {
161 crate::protocol_serde::shape_check_document_access::de_check_document_access_http_response(status, headers, body)
162 };
163 crate::protocol_serde::type_erase_result(parse_result)
164 }
165}
166#[derive(Debug)]
167struct CheckDocumentAccessRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for CheckDocumentAccessRequestSerializer {
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::check_document_access::CheckDocumentAccessInput>()
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::check_document_access::CheckDocumentAccessInput,
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.application_id;
190 let input_1 = input_1
191 .as_ref()
192 .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("application_id", "cannot be empty or unset"))?;
193 let application_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
194 if application_id.is_empty() {
195 return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
196 "application_id",
197 "cannot be empty or unset",
198 ));
199 }
200 let input_2 = &_input.index_id;
201 let input_2 = input_2
202 .as_ref()
203 .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("index_id", "cannot be empty or unset"))?;
204 let index_id = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
205 if index_id.is_empty() {
206 return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
207 "index_id",
208 "cannot be empty or unset",
209 ));
210 }
211 let input_3 = &_input.user_id;
212 let input_3 = input_3
213 .as_ref()
214 .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("user_id", "cannot be empty or unset"))?;
215 let user_id = ::aws_smithy_http::label::fmt_string(input_3, ::aws_smithy_http::label::EncodingStrategy::Default);
216 if user_id.is_empty() {
217 return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
218 "user_id",
219 "cannot be empty or unset",
220 ));
221 }
222 let input_4 = &_input.document_id;
223 let input_4 = input_4
224 .as_ref()
225 .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("document_id", "cannot be empty or unset"))?;
226 let document_id = ::aws_smithy_http::label::fmt_string(input_4, ::aws_smithy_http::label::EncodingStrategy::Default);
227 if document_id.is_empty() {
228 return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
229 "document_id",
230 "cannot be empty or unset",
231 ));
232 }
233 ::std::write!(
234 output,
235 "/applications/{applicationId}/index/{indexId}/users/{userId}/documents/{documentId}/check-document-access",
236 applicationId = application_id,
237 indexId = index_id,
238 userId = user_id,
239 documentId = document_id
240 )
241 .expect("formatting should succeed");
242 ::std::result::Result::Ok(())
243 }
244 fn uri_query(
245 _input: &crate::operation::check_document_access::CheckDocumentAccessInput,
246 mut output: &mut ::std::string::String,
247 ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
248 let mut query = ::aws_smithy_http::query::Writer::new(output);
249 if let ::std::option::Option::Some(inner_5) = &_input.data_source_id {
250 {
251 query.push_kv("dataSourceId", &::aws_smithy_http::query::fmt_string(inner_5));
252 }
253 }
254 ::std::result::Result::Ok(())
255 }
256 #[allow(clippy::unnecessary_wraps)]
257 fn update_http_builder(
258 input: &crate::operation::check_document_access::CheckDocumentAccessInput,
259 builder: ::http::request::Builder,
260 ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
261 let mut uri = ::std::string::String::new();
262 uri_base(input, &mut uri)?;
263 uri_query(input, &mut uri)?;
264 ::std::result::Result::Ok(builder.method("GET").uri(uri))
265 }
266 let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
267 builder
268 };
269 let body = ::aws_smithy_types::body::SdkBody::from("");
270
271 ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
272 }
273}
274#[derive(Debug)]
275struct CheckDocumentAccessEndpointParamsInterceptor;
276
277impl ::aws_smithy_runtime_api::client::interceptors::Intercept for CheckDocumentAccessEndpointParamsInterceptor {
278 fn name(&self) -> &'static str {
279 "CheckDocumentAccessEndpointParamsInterceptor"
280 }
281
282 fn read_before_execution(
283 &self,
284 context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
285 '_,
286 ::aws_smithy_runtime_api::client::interceptors::context::Input,
287 ::aws_smithy_runtime_api::client::interceptors::context::Output,
288 ::aws_smithy_runtime_api::client::interceptors::context::Error,
289 >,
290 cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
291 ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
292 let _input = context
293 .input()
294 .downcast_ref::<CheckDocumentAccessInput>()
295 .ok_or("failed to downcast to CheckDocumentAccessInput")?;
296
297 let params = crate::config::endpoint::Params::builder()
298 .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
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#[non_exhaustive]
316#[derive(::std::fmt::Debug)]
317pub enum CheckDocumentAccessError {
318 AccessDeniedException(crate::types::error::AccessDeniedException),
320 InternalServerException(crate::types::error::InternalServerException),
322 ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
324 ThrottlingException(crate::types::error::ThrottlingException),
326 ValidationException(crate::types::error::ValidationException),
328 #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
330 variable wildcard pattern and check `.code()`:
331 \
332 `err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
333 \
334 See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-CheckDocumentAccessError) for what information is available for the error.")]
335 Unhandled(crate::error::sealed_unhandled::Unhandled),
336}
337impl CheckDocumentAccessError {
338 pub fn unhandled(
340 err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
341 ) -> Self {
342 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
343 source: err.into(),
344 meta: ::std::default::Default::default(),
345 })
346 }
347
348 pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
350 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
351 source: err.clone().into(),
352 meta: err,
353 })
354 }
355 pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
360 match self {
361 Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
362 Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
363 Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
364 Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
365 Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
366 Self::Unhandled(e) => &e.meta,
367 }
368 }
369 pub fn is_access_denied_exception(&self) -> bool {
371 matches!(self, Self::AccessDeniedException(_))
372 }
373 pub fn is_internal_server_exception(&self) -> bool {
375 matches!(self, Self::InternalServerException(_))
376 }
377 pub fn is_resource_not_found_exception(&self) -> bool {
379 matches!(self, Self::ResourceNotFoundException(_))
380 }
381 pub fn is_throttling_exception(&self) -> bool {
383 matches!(self, Self::ThrottlingException(_))
384 }
385 pub fn is_validation_exception(&self) -> bool {
387 matches!(self, Self::ValidationException(_))
388 }
389}
390impl ::std::error::Error for CheckDocumentAccessError {
391 fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
392 match self {
393 Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
394 Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
395 Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
396 Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
397 Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
398 Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
399 }
400 }
401}
402impl ::std::fmt::Display for CheckDocumentAccessError {
403 fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
404 match self {
405 Self::AccessDeniedException(_inner) => _inner.fmt(f),
406 Self::InternalServerException(_inner) => _inner.fmt(f),
407 Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
408 Self::ThrottlingException(_inner) => _inner.fmt(f),
409 Self::ValidationException(_inner) => _inner.fmt(f),
410 Self::Unhandled(_inner) => {
411 if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
412 write!(f, "unhandled error ({code})")
413 } else {
414 f.write_str("unhandled error")
415 }
416 }
417 }
418 }
419}
420impl ::aws_smithy_types::retry::ProvideErrorKind for CheckDocumentAccessError {
421 fn code(&self) -> ::std::option::Option<&str> {
422 ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
423 }
424 fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
425 ::std::option::Option::None
426 }
427}
428impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for CheckDocumentAccessError {
429 fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
430 match self {
431 Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
432 Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
433 Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
434 Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
435 Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
436 Self::Unhandled(_inner) => &_inner.meta,
437 }
438 }
439}
440impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for CheckDocumentAccessError {
441 fn create_unhandled_error(
442 source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
443 meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
444 ) -> Self {
445 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
446 source,
447 meta: meta.unwrap_or_default(),
448 })
449 }
450}
451impl ::aws_types::request_id::RequestId for crate::operation::check_document_access::CheckDocumentAccessError {
452 fn request_id(&self) -> Option<&str> {
453 self.meta().request_id()
454 }
455}
456
457pub use crate::operation::check_document_access::_check_document_access_output::CheckDocumentAccessOutput;
458
459pub use crate::operation::check_document_access::_check_document_access_input::CheckDocumentAccessInput;
460
461mod _check_document_access_input;
462
463mod _check_document_access_output;
464
465pub mod builders;