Struct aws_sdk_gamelift::client::fluent_builders::DescribeFleetUtilization [−][src]
pub struct DescribeFleetUtilization<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to DescribeFleetUtilization
.
Retrieves utilization statistics for one or more fleets. Utilization data provides a snapshot of how the fleet's hosting resources are currently being used. For fleets with remote locations, this operation retrieves data for the fleet's home Region only. See DescribeFleetLocationUtilization to get utilization statistics for a fleet's remote locations.
This operation can be used in the following ways:
-
To get utilization data for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
-
To get utilization data for all fleets, do not provide a fleet identifier.
When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetUtilization object is returned for each
requested fleet ID, unless the fleet identifier is not found. Each fleet utilization
object includes a Location
property, which is set to the fleet's home
Region.
Some API operations may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Learn more
Related actions
ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task
Implementations
impl<C, M, R> DescribeFleetUtilization<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> DescribeFleetUtilization<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<DescribeFleetUtilizationOutput, SdkError<DescribeFleetUtilizationError>> where
R::Policy: SmithyRetryPolicy<DescribeFleetUtilizationInputOperationOutputAlias, DescribeFleetUtilizationOutput, DescribeFleetUtilizationError, DescribeFleetUtilizationInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<DescribeFleetUtilizationOutput, SdkError<DescribeFleetUtilizationError>> where
R::Policy: SmithyRetryPolicy<DescribeFleetUtilizationInputOperationOutputAlias, DescribeFleetUtilizationOutput, DescribeFleetUtilizationError, DescribeFleetUtilizationInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
Appends an item to FleetIds
.
To override the contents of this collection use set_fleet_ids
.
A unique identifier for the fleet(s) to retrieve utilization data for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter.
A unique identifier for the fleet(s) to retrieve utilization data for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter.
The maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet
IDs.
The maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet
IDs.
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.
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.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for DescribeFleetUtilization<C, M, R>
impl<C, M, R> Send for DescribeFleetUtilization<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for DescribeFleetUtilization<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for DescribeFleetUtilization<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for DescribeFleetUtilization<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more