Struct aws_sdk_gamelift::client::fluent_builders::DescribeGameServerInstances

pub struct DescribeGameServerInstances { /* private fields */ }

Fluent builder constructing a request to DescribeGameServerInstances.

This operation is used with the GameLift FleetIQ solution and game server groups.

Retrieves status information about the Amazon EC2 instances associated with a GameLift FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers. If you are looking for instance configuration information, call DescribeGameServerGroup or access the corresponding Auto Scaling group properties.

To request status for all instances in the game server group, provide a game server group ID only. To request status for specific instances, provide the game server group ID and one or more instance IDs. Use the pagination parameters to retrieve results in sequential segments. If successful, a collection of GameServerInstance objects is returned.

This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds.

Learn more

GameLift FleetIQ Guide

Related actions

CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task

Implementations

impl DescribeGameServerInstances

pub async fn send(
    self
) -> Result<DescribeGameServerInstancesOutput, SdkError<DescribeGameServerInstancesError>>

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) -> DescribeGameServerInstancesPaginator

Create a paginator for this request

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

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

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

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

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

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

Appends an item to InstanceIds.

To override the contents of this collection use set_instance_ids.

The Amazon EC2 instance IDs that you want to retrieve status on. Amazon EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

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

The Amazon EC2 instance IDs that you want to retrieve status on. Amazon EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0. To retrieve all instances in the game server group, leave this parameter empty.

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.

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.

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.

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 Clone for DescribeGameServerInstances

fn clone(&self) -> DescribeGameServerInstances

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeGameServerInstances

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

Formats the value using the given formatter.