LocationState - Amazon GameLift
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

LocationState

A fleet location and its life-cycle state. A location state object might be used to describe a fleet's remote location or home Region. Life-cycle state tracks the progress of launching the first instance in a new location and preparing it for game hosting, and then removing all instances and deleting the location from the fleet.

  • NEW -- A new fleet location has been defined and desired instances is set to 1.

  • DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet location, creating new instances with the game build or Realtime script and starting server processes.

  • ACTIVE -- Hosts can now accept game sessions.

  • ERROR -- An error occurred when downloading, validating, building, or activating the fleet location.

  • DELETING -- Hosts are responding to a delete fleet location request.

  • TERMINATED -- The fleet location no longer exists.

  • NOT_FOUND -- The fleet location was not found. This could be because the custom location was removed or not created.

Contents

Note

In the following list, the required parameters are described first.

Location

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: ^[A-Za-z0-9\-]+

Required: No

Status

The life-cycle status of a fleet location.

Type: String

Valid Values: NEW | DOWNLOADING | VALIDATING | BUILDING | ACTIVATING | ACTIVE | DELETING | ERROR | TERMINATED | NOT_FOUND

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: