describe_fleet_location_attributes

describe_fleet_location_attributes(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_fleet_location_attributes(
    FleetId='string',
    Locations=[
        'string',
    ],
    Limit=123,
    NextToken='string'
)

Parameters

• FleetId (string) --

  [REQUIRED]

  A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.

• Locations (list) --

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

  • (string) --
• Limit (integer) -- 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.
• NextToken (string) -- 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.

Return type

dict

Returns

Response Syntax

{
    'FleetId': 'string',
    'FleetArn': 'string',
    'LocationAttributes': [
        {
            'LocationState': {
                'Location': 'string',
                'Status': 'NEW'|'DOWNLOADING'|'VALIDATING'|'BUILDING'|'ACTIVATING'|'ACTIVE'|'DELETING'|'ERROR'|'TERMINATED'|'NOT_FOUND'
            },
            'StoppedActions': [
                'AUTO_SCALING',
            ],
            'UpdateStatus': 'PENDING_UPDATE'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • FleetId (string) --

    A unique identifier for the fleet that location attributes were requested for.

  • FleetArn (string) --

    The Amazon Resource Name ( ARN ) that is assigned to a GameLift 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 .

  • LocationAttributes (list) --

    Location-specific information on the requested fleet's remote locations.

    • (dict) --

      Details about a location in a multi-location fleet.

      • LocationState (dict) --

        A fleet location and its current life-cycle state.

        • Location (string) --

          The fleet location, expressed as an Amazon Web Services Region code such as us-west-2 .

        • Status (string) --

          The life-cycle status of a fleet location.

      • StoppedActions (list) --

        A list of fleet actions that have been suspended in the fleet location.

        • (string) --

      • UpdateStatus (string) --

        The status of fleet activity updates to the location. The status PENDING_UPDATE indicates that StopFleetActions or StartFleetActions has been requested but the update has not yet been completed for the location.

  • NextToken (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.

Exceptions

• GameLift.Client.exceptions.InternalServiceException
• GameLift.Client.exceptions.InvalidRequestException
• GameLift.Client.exceptions.UnauthorizedException
• GameLift.Client.exceptions.NotFoundException
• GameLift.Client.exceptions.UnsupportedRegionException