Struct aws_sdk_gamelift::client::fluent_builders::DescribeFleetUtilization

pub struct DescribeFleetUtilization { /* private fields */ }

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

Setting up GameLift Fleets

GameLift Metrics for Fleets

Related actions

ListFleets | DescribeEC2InstanceLimits | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetEvents | DescribeFleetLocationAttributes | DescribeFleetPortSettings | DescribeFleetUtilization | DescribeRuntimeConfiguration | DescribeScalingPolicies | All APIs by task

Implementations

impl DescribeFleetUtilization

pub async fn send(
    self
) -> Result<DescribeFleetUtilizationOutput, SdkError<DescribeFleetUtilizationError>>

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.

pub fn into_paginator(self) -> DescribeFleetUtilizationPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn fleet_ids(self, input: impl Into<String>) -> Self

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.

pub fn set_fleet_ids(self, input: Option<Vec<String>>) -> Self

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.

pub fn limit(self, input: i32) -> Self

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.

pub fn set_limit(self, input: Option<i32>) -> Self

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.

pub fn next_token(self, input: impl Into<String>) -> Self

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.

pub fn set_next_token(self, input: Option<String>) -> Self

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

impl Clone for DescribeFleetUtilization

fn clone(&self) -> DescribeFleetUtilization

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeFleetUtilization

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.