Container for the parameters to the DescribeFleetLocationAttributes operation. 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
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.DescribeFleetLocationAttributesRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class DescribeFleetLocationAttributesRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The DescribeFleetLocationAttributesRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
DescribeFleetLocationAttributesRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
FleetId | System.String |
Gets and sets the property FleetId. A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value. |
|
|
Limit | System.Int32 |
Gets and sets the property Limit.
The maximum number of results to return. Use this parameter with |
|
|
Locations | System.Collections.Generic.List<System.String> |
Gets and sets the property Locations.
A list of fleet locations to retrieve information for. Specify locations in the form
of an Amazon Web Services Region code, such as |
|
|
NextToken | System.String |
Gets and sets the property NextToken. 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. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5