Struct aws_sdk_gamelift::client::fluent_builders::DescribeInstances

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

Fluent builder constructing a request to DescribeInstances.

Retrieves information about a fleet's instances, including instance IDs, connection data, and status.

This operation can be used in the following ways:

• To get information on all instances that are deployed to a fleet's home Region, provide the fleet ID.

• To get information on all instances that are deployed to a fleet's remote location, provide the fleet ID and location name.

• To get information on a specific instance in a fleet, provide the fleet ID and instance ID.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, an Instance object is returned for each requested instance. Instances are not returned in any particular order.

Learn more

Remotely Access Fleet Instances

Debug Fleet Issues

Related actions

DescribeInstances | GetInstanceAccess | DescribeEC2InstanceLimits | All APIs by task

Implementations

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

pub async fn send(
    self
) -> Result<DescribeInstancesOutput, SdkError<DescribeInstancesError>> where
    R::Policy: SmithyRetryPolicy<DescribeInstancesInputOperationOutputAlias, DescribeInstancesOutput, DescribeInstancesError, DescribeInstancesInputOperationRetryAlias>, 

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

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

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

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

A unique identifier for an instance to retrieve. Specify an instance ID or leave blank to retrieve all instances in the fleet.

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.

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, 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.

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

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

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

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

Trait Implementations

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

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

Formats the value using the given formatter.