Struct aws_sdk_gamelift::client::fluent_builders::DescribeFleetLocationAttributes

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

Fluent builder constructing a request to DescribeFleetLocationAttributes.

Retrieves information on a fleet's remote locations, including life-cycle status and any suspended fleet activity.

This operation can be used in the following ways:

• To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested.

• To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order.

When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet's home Region, call DescribeFleetAttributes.

Learn more

Setting up GameLift fleets

Related actions

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

Implementations

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

pub async fn send(
    self
) -> Result<DescribeFleetLocationAttributesOutput, SdkError<DescribeFleetLocationAttributesError>> where
    R::Policy: SmithyRetryPolicy<DescribeFleetLocationAttributesInputOperationOutputAlias, DescribeFleetLocationAttributesOutput, DescribeFleetLocationAttributesError, DescribeFleetLocationAttributesInputOperationRetryAlias>, 

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 retrieve remote locations 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 retrieve remote locations for. You can use either the fleet ID or ARN value.

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

Appends an item to Locations.

To override the contents of this collection use set_locations.

A list of fleet locations to retrieve information for. Specify locations in the form of an AWS Region code, such as us-west-2.

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

A list of fleet locations to retrieve information for. Specify locations in the form of an AWS Region code, such as us-west-2.

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

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This limit is not currently enforced.

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 limit is not currently enforced.

pub fn next_token(self, inp: 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.

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.

Trait Implementations

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

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

Formats the value using the given formatter.