aws_sdk_gamelift/operation/describe_fleet_capacity/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_fleet_capacity::_describe_fleet_capacity_output::DescribeFleetCapacityOutputBuilder;
3
4pub use crate::operation::describe_fleet_capacity::_describe_fleet_capacity_input::DescribeFleetCapacityInputBuilder;
5
6impl crate::operation::describe_fleet_capacity::builders::DescribeFleetCapacityInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::describe_fleet_capacity::DescribeFleetCapacityOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::describe_fleet_capacity::DescribeFleetCapacityError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.describe_fleet_capacity();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DescribeFleetCapacity`.
24///
25/// <p>Retrieves the resource capacity settings for one or more fleets. For a container fleet, this operation also returns counts for game server container groups.</p>
26/// <p>With multi-location fleets, this operation retrieves data for the fleet's home Region only. To retrieve capacity for remote locations, see <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html">https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html</a>.</p>
27/// <p>This operation can be used in the following ways:</p>
28/// <ul>
29/// <li>
30/// <p>To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.</p></li>
31/// <li>
32/// <p>To get capacity data for all fleets, do not provide a fleet identifier.</p></li>
33/// </ul>
34/// <p>When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.</p>
35/// <p>If successful, a <code>FleetCapacity</code> object is returned for each requested fleet ID. Each <code>FleetCapacity</code> object includes a <code>Location</code> property, which is set to the fleet's home Region. Capacity values are returned only for fleets that currently exist.</p><note>
36/// <p>Some API operations may limit the number of fleet IDs that are allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.</p>
37/// </note>
38/// <p><b>Learn more</b></p>
39/// <p><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift Servers fleets</a></p>
40/// <p><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</a></p>
41#[derive(::std::clone::Clone, ::std::fmt::Debug)]
42pub struct DescribeFleetCapacityFluentBuilder {
43 handle: ::std::sync::Arc<crate::client::Handle>,
44 inner: crate::operation::describe_fleet_capacity::builders::DescribeFleetCapacityInputBuilder,
45 config_override: ::std::option::Option<crate::config::Builder>,
46}
47impl
48 crate::client::customize::internal::CustomizableSend<
49 crate::operation::describe_fleet_capacity::DescribeFleetCapacityOutput,
50 crate::operation::describe_fleet_capacity::DescribeFleetCapacityError,
51 > for DescribeFleetCapacityFluentBuilder
52{
53 fn send(
54 self,
55 config_override: crate::config::Builder,
56 ) -> crate::client::customize::internal::BoxFuture<
57 crate::client::customize::internal::SendResult<
58 crate::operation::describe_fleet_capacity::DescribeFleetCapacityOutput,
59 crate::operation::describe_fleet_capacity::DescribeFleetCapacityError,
60 >,
61 > {
62 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
63 }
64}
65impl DescribeFleetCapacityFluentBuilder {
66 /// Creates a new `DescribeFleetCapacityFluentBuilder`.
67 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
68 Self {
69 handle,
70 inner: ::std::default::Default::default(),
71 config_override: ::std::option::Option::None,
72 }
73 }
74 /// Access the DescribeFleetCapacity as a reference.
75 pub fn as_input(&self) -> &crate::operation::describe_fleet_capacity::builders::DescribeFleetCapacityInputBuilder {
76 &self.inner
77 }
78 /// Sends the request and returns the response.
79 ///
80 /// If an error occurs, an `SdkError` will be returned with additional details that
81 /// can be matched against.
82 ///
83 /// By default, any retryable failures will be retried twice. Retry behavior
84 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
85 /// set when configuring the client.
86 pub async fn send(
87 self,
88 ) -> ::std::result::Result<
89 crate::operation::describe_fleet_capacity::DescribeFleetCapacityOutput,
90 ::aws_smithy_runtime_api::client::result::SdkError<
91 crate::operation::describe_fleet_capacity::DescribeFleetCapacityError,
92 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
93 >,
94 > {
95 let input = self
96 .inner
97 .build()
98 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
99 let runtime_plugins = crate::operation::describe_fleet_capacity::DescribeFleetCapacity::operation_runtime_plugins(
100 self.handle.runtime_plugins.clone(),
101 &self.handle.conf,
102 self.config_override,
103 );
104 crate::operation::describe_fleet_capacity::DescribeFleetCapacity::orchestrate(&runtime_plugins, input).await
105 }
106
107 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
108 pub fn customize(
109 self,
110 ) -> crate::client::customize::CustomizableOperation<
111 crate::operation::describe_fleet_capacity::DescribeFleetCapacityOutput,
112 crate::operation::describe_fleet_capacity::DescribeFleetCapacityError,
113 Self,
114 > {
115 crate::client::customize::CustomizableOperation::new(self)
116 }
117 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
118 self.set_config_override(::std::option::Option::Some(config_override.into()));
119 self
120 }
121
122 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
123 self.config_override = config_override;
124 self
125 }
126 /// Create a paginator for this request
127 ///
128 /// Paginators are used by calling [`send().await`](crate::operation::describe_fleet_capacity::paginator::DescribeFleetCapacityPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
129 pub fn into_paginator(self) -> crate::operation::describe_fleet_capacity::paginator::DescribeFleetCapacityPaginator {
130 crate::operation::describe_fleet_capacity::paginator::DescribeFleetCapacityPaginator::new(self.handle, self.inner)
131 }
132 ///
133 /// Appends an item to `FleetIds`.
134 ///
135 /// To override the contents of this collection use [`set_fleet_ids`](Self::set_fleet_ids).
136 ///
137 /// <p>A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.</p>
138 pub fn fleet_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
139 self.inner = self.inner.fleet_ids(input.into());
140 self
141 }
142 /// <p>A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.</p>
143 pub fn set_fleet_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
144 self.inner = self.inner.set_fleet_ids(input);
145 self
146 }
147 /// <p>A unique identifier for the fleet to retrieve capacity information for. You can use either the fleet ID or ARN value. Leave this parameter empty to retrieve capacity information for all fleets.</p>
148 pub fn get_fleet_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
149 self.inner.get_fleet_ids()
150 }
151 /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
152 pub fn limit(mut self, input: i32) -> Self {
153 self.inner = self.inner.limit(input);
154 self
155 }
156 /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
157 pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
158 self.inner = self.inner.set_limit(input);
159 self
160 }
161 /// <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
162 pub fn get_limit(&self) -> &::std::option::Option<i32> {
163 self.inner.get_limit()
164 }
165 /// <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
166 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
167 self.inner = self.inner.next_token(input.into());
168 self
169 }
170 /// <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
171 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
172 self.inner = self.inner.set_next_token(input);
173 self
174 }
175 /// <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.</p>
176 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
177 self.inner.get_next_token()
178 }
179}