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><b>This API works with the following fleet types:</b> EC2, Container</p>
26/// <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>
27/// <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>
28/// <p>This operation can be used in the following ways:</p>
29/// <ul>
30/// <li>
31/// <p>To get capacity data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.</p></li>
32/// <li>
33/// <p>To get capacity data for all fleets, do not provide a fleet identifier.</p></li>
34/// </ul>
35/// <p>When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.</p>
36/// <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>
37/// <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>
38/// </note>
39/// <p><b>Learn more</b></p>
40/// <p><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up Amazon GameLift Servers fleets</a></p>
41/// <p><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</a></p>
42#[derive(::std::clone::Clone, ::std::fmt::Debug)]
43pub struct DescribeFleetCapacityFluentBuilder {
44 handle: ::std::sync::Arc<crate::client::Handle>,
45 inner: crate::operation::describe_fleet_capacity::builders::DescribeFleetCapacityInputBuilder,
46 config_override: ::std::option::Option<crate::config::Builder>,
47}
48impl
49 crate::client::customize::internal::CustomizableSend<
50 crate::operation::describe_fleet_capacity::DescribeFleetCapacityOutput,
51 crate::operation::describe_fleet_capacity::DescribeFleetCapacityError,
52 > for DescribeFleetCapacityFluentBuilder
53{
54 fn send(
55 self,
56 config_override: crate::config::Builder,
57 ) -> crate::client::customize::internal::BoxFuture<
58 crate::client::customize::internal::SendResult<
59 crate::operation::describe_fleet_capacity::DescribeFleetCapacityOutput,
60 crate::operation::describe_fleet_capacity::DescribeFleetCapacityError,
61 >,
62 > {
63 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
64 }
65}
66impl DescribeFleetCapacityFluentBuilder {
67 /// Creates a new `DescribeFleetCapacityFluentBuilder`.
68 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
69 Self {
70 handle,
71 inner: ::std::default::Default::default(),
72 config_override: ::std::option::Option::None,
73 }
74 }
75 /// Access the DescribeFleetCapacity as a reference.
76 pub fn as_input(&self) -> &crate::operation::describe_fleet_capacity::builders::DescribeFleetCapacityInputBuilder {
77 &self.inner
78 }
79 /// Sends the request and returns the response.
80 ///
81 /// If an error occurs, an `SdkError` will be returned with additional details that
82 /// can be matched against.
83 ///
84 /// By default, any retryable failures will be retried twice. Retry behavior
85 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
86 /// set when configuring the client.
87 pub async fn send(
88 self,
89 ) -> ::std::result::Result<
90 crate::operation::describe_fleet_capacity::DescribeFleetCapacityOutput,
91 ::aws_smithy_runtime_api::client::result::SdkError<
92 crate::operation::describe_fleet_capacity::DescribeFleetCapacityError,
93 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
94 >,
95 > {
96 let input = self
97 .inner
98 .build()
99 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
100 let runtime_plugins = crate::operation::describe_fleet_capacity::DescribeFleetCapacity::operation_runtime_plugins(
101 self.handle.runtime_plugins.clone(),
102 &self.handle.conf,
103 self.config_override,
104 );
105 crate::operation::describe_fleet_capacity::DescribeFleetCapacity::orchestrate(&runtime_plugins, input).await
106 }
107
108 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
109 pub fn customize(
110 self,
111 ) -> crate::client::customize::CustomizableOperation<
112 crate::operation::describe_fleet_capacity::DescribeFleetCapacityOutput,
113 crate::operation::describe_fleet_capacity::DescribeFleetCapacityError,
114 Self,
115 > {
116 crate::client::customize::CustomizableOperation::new(self)
117 }
118 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
119 self.set_config_override(::std::option::Option::Some(config_override.into()));
120 self
121 }
122
123 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
124 self.config_override = config_override;
125 self
126 }
127 /// Create a paginator for this request
128 ///
129 /// 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).
130 pub fn into_paginator(self) -> crate::operation::describe_fleet_capacity::paginator::DescribeFleetCapacityPaginator {
131 crate::operation::describe_fleet_capacity::paginator::DescribeFleetCapacityPaginator::new(self.handle, self.inner)
132 }
133 ///
134 /// Appends an item to `FleetIds`.
135 ///
136 /// To override the contents of this collection use [`set_fleet_ids`](Self::set_fleet_ids).
137 ///
138 /// <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>
139 pub fn fleet_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
140 self.inner = self.inner.fleet_ids(input.into());
141 self
142 }
143 /// <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>
144 pub fn set_fleet_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
145 self.inner = self.inner.set_fleet_ids(input);
146 self
147 }
148 /// <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>
149 pub fn get_fleet_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
150 self.inner.get_fleet_ids()
151 }
152 /// <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>
153 pub fn limit(mut self, input: i32) -> Self {
154 self.inner = self.inner.limit(input);
155 self
156 }
157 /// <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>
158 pub fn set_limit(mut self, input: ::std::option::Option<i32>) -> Self {
159 self.inner = self.inner.set_limit(input);
160 self
161 }
162 /// <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>
163 pub fn get_limit(&self) -> &::std::option::Option<i32> {
164 self.inner.get_limit()
165 }
166 /// <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>
167 pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
168 self.inner = self.inner.next_token(input.into());
169 self
170 }
171 /// <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>
172 pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
173 self.inner = self.inner.set_next_token(input);
174 self
175 }
176 /// <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>
177 pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
178 self.inner.get_next_token()
179 }
180}