Struct aws_sdk_gamelift::client::fluent_builders::DescribeFleetLocationUtilization

pub struct DescribeFleetLocationUtilization<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to DescribeFleetLocationUtilization.

Retrieves current usage data for a fleet location. Utilization data provides a snapshot of current game hosting activity at the requested location. Use this operation to retrieve utilization information for a fleet's remote location or home Region (you can also retrieve home Region utilization by calling DescribeFleetUtilization).

To retrieve utilization data, identify a fleet and location.

If successful, a FleetUtilization object is returned for the requested fleet location.

Learn more

Setting up GameLift fleets

GameLift metrics for fleets

Related actions

CreateFleetLocations | DescribeFleetLocationAttributes | DescribeFleetLocationCapacity | DescribeFleetLocationUtilization | DescribeFleetAttributes | DescribeFleetCapacity | DescribeFleetUtilization | UpdateFleetCapacity | StopFleetActions | DeleteFleetLocations | All APIs by task

Implementations

impl<C, M, R> DescribeFleetLocationUtilization<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeFleetLocationUtilizationOutput, SdkError<DescribeFleetLocationUtilizationError>> where
    R::Policy: SmithyRetryPolicy<DescribeFleetLocationUtilizationInputOperationOutputAlias, DescribeFleetLocationUtilizationOutput, DescribeFleetLocationUtilizationError, DescribeFleetLocationUtilizationInputOperationRetryAlias>, 

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 fleet_id(self, inp: impl Into<String>) -> Self

A unique identifier for the fleet to request location utilization for. You can use either the fleet ID or ARN value.

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

A unique identifier for the fleet to request location utilization for. You can use either the fleet ID or ARN value.

pub fn location(self, inp: impl Into<String>) -> Self

The fleet location to retrieve utilization information for. Specify a location in the form of an AWS Region code, such as us-west-2.

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

The fleet location to retrieve utilization information for. Specify a location in the form of an AWS Region code, such as us-west-2.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeFleetLocationUtilization<C, M, R>

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

Formats the value using the given formatter.