aws_sdk_quicksight/operation/
describe_dashboard_snapshot_job.rs1#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeDashboardSnapshotJob;
6impl DescribeDashboardSnapshotJob {
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::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobInput,
14 ) -> ::std::result::Result<
15 crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobOutput,
16 ::aws_smithy_runtime_api::client::result::SdkError<
17 crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobError,
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::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobError>()
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::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobOutput>()
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::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobInput,
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 "QuickSight",
56 "DescribeDashboardSnapshotJob",
57 input,
58 runtime_plugins,
59 stop_point,
60 )
61 .instrument(::tracing::debug_span!(
64 "QuickSight.DescribeDashboardSnapshotJob",
65 "rpc.service" = "QuickSight",
66 "rpc.method" = "DescribeDashboardSnapshotJob",
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
80 if let ::std::option::Option::Some(config_override) = config_override {
81 for plugin in config_override.runtime_plugins.iter().cloned() {
82 runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
83 }
84 runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
85 config_override,
86 client_config.config.clone(),
87 &client_config.runtime_components,
88 ));
89 }
90 runtime_plugins
91 }
92}
93impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for DescribeDashboardSnapshotJob {
94 fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
95 let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeDashboardSnapshotJob");
96
97 cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
98 DescribeDashboardSnapshotJobRequestSerializer,
99 ));
100 cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
101 DescribeDashboardSnapshotJobResponseDeserializer,
102 ));
103
104 cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
105 crate::config::auth::Params::builder()
106 .operation_name("DescribeDashboardSnapshotJob")
107 .build()
108 .expect("required fields set"),
109 ));
110
111 cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
112 cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
113 "DescribeDashboardSnapshotJob",
114 "QuickSight",
115 ));
116 let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
117 signing_options.double_uri_encode = true;
118 signing_options.content_sha256_header = false;
119 signing_options.normalize_uri_path = true;
120 signing_options.payload_override = None;
121
122 cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
123 signing_options,
124 ..::std::default::Default::default()
125 });
126
127 ::std::option::Option::Some(cfg.freeze())
128 }
129
130 fn runtime_components(
131 &self,
132 _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
133 ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
134 #[allow(unused_mut)]
135 let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeDashboardSnapshotJob")
136 .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
137 .with_interceptor(DescribeDashboardSnapshotJobEndpointParamsInterceptor)
138 .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
139 crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobError,
140 >::new())
141 .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
142 crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobError,
143 >::new())
144 .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
145 crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobError,
146 >::new());
147
148 ::std::borrow::Cow::Owned(rcb)
149 }
150}
151
152#[derive(Debug)]
153struct DescribeDashboardSnapshotJobResponseDeserializer;
154impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeDashboardSnapshotJobResponseDeserializer {
155 fn deserialize_nonstreaming(
156 &self,
157 response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
158 ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
159 let (success, status) = (response.status().is_success(), response.status().as_u16());
160 let headers = response.headers();
161 let body = response.body().bytes().expect("body loaded");
162 #[allow(unused_mut)]
163 let mut force_error = false;
164 ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
165 let parse_result = if !success && status != 200 || force_error {
166 crate::protocol_serde::shape_describe_dashboard_snapshot_job::de_describe_dashboard_snapshot_job_http_error(status, headers, body)
167 } else {
168 crate::protocol_serde::shape_describe_dashboard_snapshot_job::de_describe_dashboard_snapshot_job_http_response(status, headers, body)
169 };
170 crate::protocol_serde::type_erase_result(parse_result)
171 }
172}
173#[derive(Debug)]
174struct DescribeDashboardSnapshotJobRequestSerializer;
175impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeDashboardSnapshotJobRequestSerializer {
176 #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
177 fn serialize_input(
178 &self,
179 input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
180 _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
181 ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
182 let input = input
183 .downcast::<crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobInput>()
184 .expect("correct type");
185 let _header_serialization_settings = _cfg
186 .load::<crate::serialization_settings::HeaderSerializationSettings>()
187 .cloned()
188 .unwrap_or_default();
189 let mut request_builder = {
190 fn uri_base(
191 _input: &crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobInput,
192 output: &mut ::std::string::String,
193 ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
194 use ::std::fmt::Write as _;
195 let input_1 = &_input.aws_account_id;
196 let input_1 = input_1
197 .as_ref()
198 .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("aws_account_id", "cannot be empty or unset"))?;
199 let aws_account_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
200 if aws_account_id.is_empty() {
201 return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
202 "aws_account_id",
203 "cannot be empty or unset",
204 ));
205 }
206 let input_2 = &_input.dashboard_id;
207 let input_2 = input_2
208 .as_ref()
209 .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("dashboard_id", "cannot be empty or unset"))?;
210 let dashboard_id = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
211 if dashboard_id.is_empty() {
212 return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
213 "dashboard_id",
214 "cannot be empty or unset",
215 ));
216 }
217 let input_3 = &_input.snapshot_job_id;
218 let input_3 = input_3
219 .as_ref()
220 .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("snapshot_job_id", "cannot be empty or unset"))?;
221 let snapshot_job_id = ::aws_smithy_http::label::fmt_string(input_3, ::aws_smithy_http::label::EncodingStrategy::Default);
222 if snapshot_job_id.is_empty() {
223 return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
224 "snapshot_job_id",
225 "cannot be empty or unset",
226 ));
227 }
228 ::std::write!(
229 output,
230 "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}",
231 AwsAccountId = aws_account_id,
232 DashboardId = dashboard_id,
233 SnapshotJobId = snapshot_job_id
234 )
235 .expect("formatting should succeed");
236 ::std::result::Result::Ok(())
237 }
238 #[allow(clippy::unnecessary_wraps)]
239 fn update_http_builder(
240 input: &crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobInput,
241 builder: ::http::request::Builder,
242 ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
243 let mut uri = ::std::string::String::new();
244 uri_base(input, &mut uri)?;
245 ::std::result::Result::Ok(builder.method("GET").uri(uri))
246 }
247 let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
248 builder
249 };
250 let body = ::aws_smithy_types::body::SdkBody::from("");
251
252 ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
253 }
254}
255#[derive(Debug)]
256struct DescribeDashboardSnapshotJobEndpointParamsInterceptor;
257
258impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeDashboardSnapshotJobEndpointParamsInterceptor {
259 fn name(&self) -> &'static str {
260 "DescribeDashboardSnapshotJobEndpointParamsInterceptor"
261 }
262
263 fn read_before_execution(
264 &self,
265 context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
266 '_,
267 ::aws_smithy_runtime_api::client::interceptors::context::Input,
268 ::aws_smithy_runtime_api::client::interceptors::context::Output,
269 ::aws_smithy_runtime_api::client::interceptors::context::Error,
270 >,
271 cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
272 ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
273 let _input = context
274 .input()
275 .downcast_ref::<DescribeDashboardSnapshotJobInput>()
276 .ok_or("failed to downcast to DescribeDashboardSnapshotJobInput")?;
277
278 let params = crate::config::endpoint::Params::builder()
279 .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
280 .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
281 .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
282 .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
283 .build()
284 .map_err(|err| {
285 ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
286 })?;
287 cfg.interceptor_state()
288 .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
289 ::std::result::Result::Ok(())
290 }
291}
292
293#[non_exhaustive]
298#[derive(::std::fmt::Debug)]
299pub enum DescribeDashboardSnapshotJobError {
300 AccessDeniedException(crate::types::error::AccessDeniedException),
302 InternalFailureException(crate::types::error::InternalFailureException),
304 ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
306 ThrottlingException(crate::types::error::ThrottlingException),
308 UnsupportedUserEditionException(crate::types::error::UnsupportedUserEditionException),
310 #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
312 variable wildcard pattern and check `.code()`:
313 \
314 `err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
315 \
316 See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeDashboardSnapshotJobError) for what information is available for the error.")]
317 Unhandled(crate::error::sealed_unhandled::Unhandled),
318}
319impl DescribeDashboardSnapshotJobError {
320 pub fn unhandled(
322 err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
323 ) -> Self {
324 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
325 source: err.into(),
326 meta: ::std::default::Default::default(),
327 })
328 }
329
330 pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
332 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
333 source: err.clone().into(),
334 meta: err,
335 })
336 }
337 pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
342 match self {
343 Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
344 Self::InternalFailureException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
345 Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
346 Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
347 Self::UnsupportedUserEditionException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
348 Self::Unhandled(e) => &e.meta,
349 }
350 }
351 pub fn is_access_denied_exception(&self) -> bool {
353 matches!(self, Self::AccessDeniedException(_))
354 }
355 pub fn is_internal_failure_exception(&self) -> bool {
357 matches!(self, Self::InternalFailureException(_))
358 }
359 pub fn is_resource_not_found_exception(&self) -> bool {
361 matches!(self, Self::ResourceNotFoundException(_))
362 }
363 pub fn is_throttling_exception(&self) -> bool {
365 matches!(self, Self::ThrottlingException(_))
366 }
367 pub fn is_unsupported_user_edition_exception(&self) -> bool {
369 matches!(self, Self::UnsupportedUserEditionException(_))
370 }
371}
372impl ::std::error::Error for DescribeDashboardSnapshotJobError {
373 fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
374 match self {
375 Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
376 Self::InternalFailureException(_inner) => ::std::option::Option::Some(_inner),
377 Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
378 Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
379 Self::UnsupportedUserEditionException(_inner) => ::std::option::Option::Some(_inner),
380 Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
381 }
382 }
383}
384impl ::std::fmt::Display for DescribeDashboardSnapshotJobError {
385 fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
386 match self {
387 Self::AccessDeniedException(_inner) => _inner.fmt(f),
388 Self::InternalFailureException(_inner) => _inner.fmt(f),
389 Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
390 Self::ThrottlingException(_inner) => _inner.fmt(f),
391 Self::UnsupportedUserEditionException(_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 DescribeDashboardSnapshotJobError {
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 DescribeDashboardSnapshotJobError {
411 fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
412 match self {
413 Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
414 Self::InternalFailureException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
415 Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
416 Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
417 Self::UnsupportedUserEditionException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
418 Self::Unhandled(_inner) => &_inner.meta,
419 }
420 }
421}
422impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeDashboardSnapshotJobError {
423 fn create_unhandled_error(
424 source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
425 meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
426 ) -> Self {
427 Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
428 source,
429 meta: meta.unwrap_or_default(),
430 })
431 }
432}
433impl ::aws_types::request_id::RequestId for crate::operation::describe_dashboard_snapshot_job::DescribeDashboardSnapshotJobError {
434 fn request_id(&self) -> Option<&str> {
435 self.meta().request_id()
436 }
437}
438
439pub use crate::operation::describe_dashboard_snapshot_job::_describe_dashboard_snapshot_job_output::DescribeDashboardSnapshotJobOutput;
440
441pub use crate::operation::describe_dashboard_snapshot_job::_describe_dashboard_snapshot_job_input::DescribeDashboardSnapshotJobInput;
442
443mod _describe_dashboard_snapshot_job_input;
444
445mod _describe_dashboard_snapshot_job_output;
446
447pub mod builders;