fleet_location_attributes
Creates, updates, deletes, gets or lists a fleet_location_attributes resource.
Overview
| Name | fleet_location_attributes |
| Type | Resource |
| Id | aws.gamelift.fleet_location_attributes |
Fields
The following fields are returned by SELECT queries:
- describe_fleet_location_attributes
| Name | Datatype | Description |
|---|---|---|
fleet_arn | string | The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. (pattern: <code>^arn:.*:[a-z]*fleet/[a-z]*fleet-[a-zA-Z0-9-]+$</code>) |
fleet_id | string | A unique identifier for the fleet that location attributes were requested for. (pattern: <code>^[a-z]fleet-[a-zA-Z0-9-]+$|^arn:.:[a-z]*fleet/[a-z]*fleet-[a-zA-Z0-9-]+$</code>) |
location_attributes | array | Location-specific information on the requested fleet's remote locations. |
next_token | string | A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_fleet_location_attributes | select | region | This API works with the following fleet types: EC2, Anywhere, Container 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. Learn more Setting up Amazon GameLift Servers fleets Amazon GameLift Servers service locations for managed hosting |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_fleet_location_attributes
This API works with the following fleet types: EC2, Anywhere, Container 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. Learn more Setting up Amazon GameLift Servers fleets Amazon GameLift Servers service locations for managed hosting
SELECT
fleet_arn,
fleet_id,
location_attributes,
next_token
FROM aws.gamelift.fleet_location_attributes
WHERE region = '{{ region }}' -- required
;