aws_sdk_gamelift/operation/
describe_game_sessions.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeGameSessions`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeGameSessions;
6impl DescribeGameSessions {
7    /// Creates a new `DescribeGameSessions`
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::describe_game_sessions::DescribeGameSessionsInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_game_sessions::DescribeGameSessionsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_game_sessions::DescribeGameSessionsError,
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_game_sessions::DescribeGameSessionsError>()
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_game_sessions::DescribeGameSessionsOutput>()
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_game_sessions::DescribeGameSessionsInput,
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("GameLift", "DescribeGameSessions", 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                "GameLift.DescribeGameSessions",
59                "rpc.service" = "GameLift",
60                "rpc.method" = "DescribeGameSessions",
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 DescribeGameSessions {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeGameSessions");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            DescribeGameSessionsRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            DescribeGameSessionsResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("DescribeGameSessions")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
106        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
107            "DescribeGameSessions",
108            "GameLift",
109        ));
110        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
111        signing_options.double_uri_encode = true;
112        signing_options.content_sha256_header = false;
113        signing_options.normalize_uri_path = true;
114        signing_options.payload_override = None;
115
116        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
117            signing_options,
118            ..::std::default::Default::default()
119        });
120
121        ::std::option::Option::Some(cfg.freeze())
122    }
123
124    fn runtime_components(
125        &self,
126        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
127    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
128        #[allow(unused_mut)]
129        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeGameSessions")
130            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
131            .with_interceptor(DescribeGameSessionsEndpointParamsInterceptor)
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
133                crate::operation::describe_game_sessions::DescribeGameSessionsError,
134            >::new())
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
136                crate::operation::describe_game_sessions::DescribeGameSessionsError,
137            >::new())
138            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
139                crate::operation::describe_game_sessions::DescribeGameSessionsError,
140            >::new());
141
142        ::std::borrow::Cow::Owned(rcb)
143    }
144}
145
146#[derive(Debug)]
147struct DescribeGameSessionsResponseDeserializer;
148impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeGameSessionsResponseDeserializer {
149    fn deserialize_nonstreaming(
150        &self,
151        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
152    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
153        let (success, status) = (response.status().is_success(), response.status().as_u16());
154        let headers = response.headers();
155        let body = response.body().bytes().expect("body loaded");
156        #[allow(unused_mut)]
157        let mut force_error = false;
158        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
159        let parse_result = if !success && status != 200 || force_error {
160            crate::protocol_serde::shape_describe_game_sessions::de_describe_game_sessions_http_error(status, headers, body)
161        } else {
162            crate::protocol_serde::shape_describe_game_sessions::de_describe_game_sessions_http_response(status, headers, body)
163        };
164        crate::protocol_serde::type_erase_result(parse_result)
165    }
166}
167#[derive(Debug)]
168struct DescribeGameSessionsRequestSerializer;
169impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeGameSessionsRequestSerializer {
170    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
171    fn serialize_input(
172        &self,
173        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
174        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
175    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
176        let input = input
177            .downcast::<crate::operation::describe_game_sessions::DescribeGameSessionsInput>()
178            .expect("correct type");
179        let _header_serialization_settings = _cfg
180            .load::<crate::serialization_settings::HeaderSerializationSettings>()
181            .cloned()
182            .unwrap_or_default();
183        let mut request_builder = {
184            #[allow(clippy::uninlined_format_args)]
185            fn uri_base(
186                _input: &crate::operation::describe_game_sessions::DescribeGameSessionsInput,
187                output: &mut ::std::string::String,
188            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
189                use ::std::fmt::Write as _;
190                ::std::write!(output, "/").expect("formatting should succeed");
191                ::std::result::Result::Ok(())
192            }
193            #[allow(clippy::unnecessary_wraps)]
194            fn update_http_builder(
195                input: &crate::operation::describe_game_sessions::DescribeGameSessionsInput,
196                builder: ::http::request::Builder,
197            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
198                let mut uri = ::std::string::String::new();
199                uri_base(input, &mut uri)?;
200                ::std::result::Result::Ok(builder.method("POST").uri(uri))
201            }
202            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
203            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.1");
204            builder = _header_serialization_settings.set_default_header(
205                builder,
206                ::http::header::HeaderName::from_static("x-amz-target"),
207                "GameLift.DescribeGameSessions",
208            );
209            builder
210        };
211        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_describe_game_sessions::ser_describe_game_sessions_input(
212            &input,
213        )?);
214        if let Some(content_length) = body.content_length() {
215            let content_length = content_length.to_string();
216            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
217        }
218        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
219    }
220}
221#[derive(Debug)]
222struct DescribeGameSessionsEndpointParamsInterceptor;
223
224impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeGameSessionsEndpointParamsInterceptor {
225    fn name(&self) -> &'static str {
226        "DescribeGameSessionsEndpointParamsInterceptor"
227    }
228
229    fn read_before_execution(
230        &self,
231        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
232            '_,
233            ::aws_smithy_runtime_api::client::interceptors::context::Input,
234            ::aws_smithy_runtime_api::client::interceptors::context::Output,
235            ::aws_smithy_runtime_api::client::interceptors::context::Error,
236        >,
237        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
238    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
239        let _input = context
240            .input()
241            .downcast_ref::<DescribeGameSessionsInput>()
242            .ok_or("failed to downcast to DescribeGameSessionsInput")?;
243
244        let params = crate::config::endpoint::Params::builder()
245            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
246            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
247            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
248            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
249            .build()
250            .map_err(|err| {
251                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
252            })?;
253        cfg.interceptor_state()
254            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
255        ::std::result::Result::Ok(())
256    }
257}
258
259// The get_* functions below are generated from JMESPath expressions in the
260// operationContextParams trait. They target the operation's input shape.
261
262/// Error type for the `DescribeGameSessionsError` operation.
263#[non_exhaustive]
264#[derive(::std::fmt::Debug)]
265pub enum DescribeGameSessionsError {
266    /// <p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.</p>
267    InternalServiceException(crate::types::error::InternalServiceException),
268    /// <p>One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.</p>
269    InvalidRequestException(crate::types::error::InvalidRequestException),
270    /// <p>The requested resources was not found. The resource was either not created yet or deleted.</p>
271    NotFoundException(crate::types::error::NotFoundException),
272    /// <p>The service is unable to resolve the routing for a particular alias because it has a terminal <code>RoutingStrategy</code> associated with it. The message returned in this exception is the message defined in the routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.</p>
273    TerminalRoutingStrategyException(crate::types::error::TerminalRoutingStrategyException),
274    /// <p>The client failed authentication. Clients should not retry such requests.</p>
275    UnauthorizedException(crate::types::error::UnauthorizedException),
276    /// <p>The requested operation is not supported in the Region specified.</p>
277    UnsupportedRegionException(crate::types::error::UnsupportedRegionException),
278    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
279    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
280    variable wildcard pattern and check `.code()`:
281     \
282    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
283     \
284    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeGameSessionsError) for what information is available for the error.")]
285    Unhandled(crate::error::sealed_unhandled::Unhandled),
286}
287impl DescribeGameSessionsError {
288    /// Creates the `DescribeGameSessionsError::Unhandled` variant from any error type.
289    pub fn unhandled(
290        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
291    ) -> Self {
292        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
293            source: err.into(),
294            meta: ::std::default::Default::default(),
295        })
296    }
297
298    /// Creates the `DescribeGameSessionsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
299    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
300        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
301            source: err.clone().into(),
302            meta: err,
303        })
304    }
305    ///
306    /// Returns error metadata, which includes the error code, message,
307    /// request ID, and potentially additional information.
308    ///
309    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
310        match self {
311            Self::InternalServiceException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
312            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
313            Self::NotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
314            Self::TerminalRoutingStrategyException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
315            Self::UnauthorizedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
316            Self::UnsupportedRegionException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
317            Self::Unhandled(e) => &e.meta,
318        }
319    }
320    /// Returns `true` if the error kind is `DescribeGameSessionsError::InternalServiceException`.
321    pub fn is_internal_service_exception(&self) -> bool {
322        matches!(self, Self::InternalServiceException(_))
323    }
324    /// Returns `true` if the error kind is `DescribeGameSessionsError::InvalidRequestException`.
325    pub fn is_invalid_request_exception(&self) -> bool {
326        matches!(self, Self::InvalidRequestException(_))
327    }
328    /// Returns `true` if the error kind is `DescribeGameSessionsError::NotFoundException`.
329    pub fn is_not_found_exception(&self) -> bool {
330        matches!(self, Self::NotFoundException(_))
331    }
332    /// Returns `true` if the error kind is `DescribeGameSessionsError::TerminalRoutingStrategyException`.
333    pub fn is_terminal_routing_strategy_exception(&self) -> bool {
334        matches!(self, Self::TerminalRoutingStrategyException(_))
335    }
336    /// Returns `true` if the error kind is `DescribeGameSessionsError::UnauthorizedException`.
337    pub fn is_unauthorized_exception(&self) -> bool {
338        matches!(self, Self::UnauthorizedException(_))
339    }
340    /// Returns `true` if the error kind is `DescribeGameSessionsError::UnsupportedRegionException`.
341    pub fn is_unsupported_region_exception(&self) -> bool {
342        matches!(self, Self::UnsupportedRegionException(_))
343    }
344}
345impl ::std::error::Error for DescribeGameSessionsError {
346    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
347        match self {
348            Self::InternalServiceException(_inner) => ::std::option::Option::Some(_inner),
349            Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
350            Self::NotFoundException(_inner) => ::std::option::Option::Some(_inner),
351            Self::TerminalRoutingStrategyException(_inner) => ::std::option::Option::Some(_inner),
352            Self::UnauthorizedException(_inner) => ::std::option::Option::Some(_inner),
353            Self::UnsupportedRegionException(_inner) => ::std::option::Option::Some(_inner),
354            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
355        }
356    }
357}
358impl ::std::fmt::Display for DescribeGameSessionsError {
359    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
360        match self {
361            Self::InternalServiceException(_inner) => _inner.fmt(f),
362            Self::InvalidRequestException(_inner) => _inner.fmt(f),
363            Self::NotFoundException(_inner) => _inner.fmt(f),
364            Self::TerminalRoutingStrategyException(_inner) => _inner.fmt(f),
365            Self::UnauthorizedException(_inner) => _inner.fmt(f),
366            Self::UnsupportedRegionException(_inner) => _inner.fmt(f),
367            Self::Unhandled(_inner) => {
368                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
369                    write!(f, "unhandled error ({code})")
370                } else {
371                    f.write_str("unhandled error")
372                }
373            }
374        }
375    }
376}
377impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeGameSessionsError {
378    fn code(&self) -> ::std::option::Option<&str> {
379        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
380    }
381    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
382        ::std::option::Option::None
383    }
384}
385impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeGameSessionsError {
386    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
387        match self {
388            Self::InternalServiceException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
389            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
390            Self::NotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
391            Self::TerminalRoutingStrategyException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
392            Self::UnauthorizedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
393            Self::UnsupportedRegionException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
394            Self::Unhandled(_inner) => &_inner.meta,
395        }
396    }
397}
398impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeGameSessionsError {
399    fn create_unhandled_error(
400        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
401        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
402    ) -> Self {
403        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
404            source,
405            meta: meta.unwrap_or_default(),
406        })
407    }
408}
409impl ::aws_types::request_id::RequestId for crate::operation::describe_game_sessions::DescribeGameSessionsError {
410    fn request_id(&self) -> Option<&str> {
411        self.meta().request_id()
412    }
413}
414
415pub use crate::operation::describe_game_sessions::_describe_game_sessions_output::DescribeGameSessionsOutput;
416
417pub use crate::operation::describe_game_sessions::_describe_game_sessions_input::DescribeGameSessionsInput;
418
419mod _describe_game_sessions_input;
420
421mod _describe_game_sessions_output;
422
423/// Builders
424pub mod builders;
425
426/// Paginator for this operation
427pub mod paginator;
aws_sdk_gamelift/operation/describe_game_sessions.rs

aws_sdk_gamelift/operation/
describe_game_sessions.rs
