API version '2015-10-01' of the Amazon GameLift SDK configuration.

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Please resolve the conflict before retrying.

One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.

The requested operation would cause a conflict with the current state of a service resource associated with the request. Please resolve the conflict before retrying this request.

The service is unable to resolve the routing for a particular alias because it has a terminal RoutingStrategy associated with it. The message returned in this exception is the message defined in the TerminalRoutingStrategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.

A service resource associated with the request could not be found. Such requests should not be retried by clients.

The game instance is currently full and cannot allow the requested player(s) to join. This exception occurs in response to a CreatePlayerSession request.

The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Such requests should not be retried by clients without resolving the conflict.

The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.

The client failed authentication. Such requests should not be retried without valid authentication credentials.

The specified fleet has no available instances to fulfill a request to create a new game session. Such requests should only be retried once the fleet capacity has been increased.

The requested operation would cause the resource to exceed the allowed service limit. Please resolve the issue before retrying.

AWS access credentials required to upload game build files to Amazon GameLift. These credentials are generated with CreateBuild, and are valid for a limited time. If they expire before you upload your game build, get a new set by calling RequestUploadCredentials.

See: awsCredentials smart constructor.

Creates a value of AWSCredentials with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• acSecretAccessKey
• acSessionToken
• acAccessKeyId

Secret key for an AWS account.

Token specific to a build ID.

Access key for an AWS account.

Properties describing a fleet alias.

See: alias smart constructor.

Creates a value of Alias with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• aCreationTime
• aLastUpdatedTime
• aAliasId
• aRoutingStrategy
• aName
• aDescription

Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).

Time stamp indicating when this object was last modified. Format is an integer representing the number of seconds since the Unix epoch (Unix time).

Unique identifier for a fleet alias.

Undocumented member.

Descriptive label associated with this alias. Alias names do not need to be unique.

Human-readable description of the alias.

Properties describing a game build.

See: build smart constructor.

Creates a value of Build with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• bCreationTime
• bStatus
• bBuildId
• bName
• bVersion
• bSizeOnDisk

Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).

Current status of the build. Possible build states include:

• INITIALIZED: A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this state. When a build is successfully created, the build state is set to this value.
• READY: The game build has been successfully uploaded. You can now create new fleets for this build.
• FAILED: The game build upload failed. You cannot create new fleets for this build.

Unique identifier for a build.

Descriptive label associated with this build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.

Version associated with this build. Version strings do not need to be unique to a build. This value can be set using CreateBuild or UpdateBuild.

File size of the uploaded game build, expressed in bytes. When the build state is INITIALIZED, this value is 0.

Current status of fleet capacity. The number of active instances should match or be in the process of matching the number of desired instances. Pending and terminating counts are non-zero only if fleet capacity is adjusting to an UpdateFleetCapacity request, or if access to resources is temporarily affected.

See: ec2InstanceCounts smart constructor.

Creates a value of EC2InstanceCounts with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eicIdLE
• eicTERMINATING
• eicPENDING
• eicMAXIMUM
• eicDESIRED
• eicMINIMUM
• eicACTIVE

Number of active instances in the fleet that are not currently hosting a game session.

Number of instances in the fleet that are no longer active but haven't yet been terminated.

Number of instances in the fleet that are starting but not yet active.

Maximum value allowed for the fleet's instance count.

Ideal number of active instances in the fleet.

Minimum value allowed for the fleet's instance count.

Actual number of active instances in the fleet.

Maximum number of instances allowed based on the Amazon Elastic Compute Cloud (Amazon EC2) instance type. Instance limits can be retrieved by calling DescribeEC2InstanceLimits.

See: ec2InstanceLimit smart constructor.

Creates a value of EC2InstanceLimit with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eilEC2InstanceType
• eilCurrentInstances
• eilInstanceLimit

Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each.

Number of instances of the specified type that are currently in use by this AWS account.

Number of instances allowed.

Log entry describing an event involving an Amazon GameLift resource (such as a fleet).

See: event smart constructor.

Creates a value of Event with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• eResourceId
• eEventTime
• eMessage
• eEventCode
• eEventId

Unique identifier for the resource, such as a fleet ID.

Time stamp indicating when this event occurred. Format is an integer representing the number of seconds since the Unix epoch (Unix time).

Additional information related to the event.

Type of event being logged.

Unique identifier for a fleet event.

General properties describing a fleet.

See: fleetAttributes smart constructor.

Creates a value of FleetAttributes with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• faCreationTime
• faStatus
• faServerLaunchParameters
• faLogPaths
• faBuildId
• faTerminationTime
• faNewGameSessionProtectionPolicy
• faName
• faServerLaunchPath
• faFleetId
• faDescription

Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).

Current status of the fleet. Possible fleet states include:

• NEW: A new fleet has been defined and hosts allocated.
• DOWNLOADING/VALIDATING/BUILDING/ACTIVATING: The new fleet is being set up with the game build, and new hosts are being started.
• ACTIVE: Hosts can now accept game sessions.
• ERROR: An error occurred when downloading, validating, building, or activating the fleet.
• DELETING: Hosts are responding to a delete fleet request.
• TERMINATED: The fleet no longer exists.

Parameters required to launch your game server. These parameters should be expressed as a string of command-line parameters. Example: "+sv_port 33435 +start_lobby".

Path to game-session log files generated by your game server. Once a game session has been terminated, Amazon GameLift captures and stores the logs on Amazon S3. Use the GameLift console to access the stored logs.

Unique identifier for a build.

Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).

Type of game session protection to set for all new instances started in the fleet.

• NoProtection: The game session can be terminated during a scale-down event.
• FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

Descriptive label associated with this fleet. Fleet names do not need to be unique.

Path to the launch executable for the game server. A game server is built into a 'C:\\game' drive. This value must be expressed as 'C:\game\[launchpath]'. Example: If, when built, your game server files are in a folder called "MyGame", your log path should be 'C:\\game\\MyGame\\server.exe'.

Unique identifier for a fleet.

Human-readable description of the fleet.

Information about the fleet's capacity. Fleet capacity is measured in EC2 instances. By default, new fleets have a capacity of one instance, but can be updated as needed. The maximum number of instances for a fleet is determined by the fleet's instance type.

See: fleetCapacity smart constructor.

Creates a value of FleetCapacity with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• fcInstanceType
• fcFleetId
• fcInstanceCounts

Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each.

Unique identifier for a fleet.

Current status of fleet capacity.

Current status of fleet utilization, including the number of game and player sessions being hosted.

See: fleetUtilization smart constructor.

Creates a value of FleetUtilization with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• fuActiveGameSessionCount
• fuMaximumPlayerSessionCount
• fuCurrentPlayerSessionCount
• fuFleetId

Number of active game sessions currently being hosted on fleet game servers.

Maximum players allowed across all game sessions currently hosted in the fleet.

Number of active player sessions currently being hosted on fleet game servers.

Unique identifier for a fleet.

Set of key-value pairs containing information your game server requires to set up sessions. This object allows you to pass in any set of data needed for your game. For more information, see the Amazon GameLift Developer Guide.

See: gameProperty smart constructor.

Creates a value of GameProperty with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gpKey
• gpValue

Undocumented member.

Undocumented member.

Properties describing a game session.

See: gameSession smart constructor.

Creates a value of GameSession with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gsCreationTime
• gsStatus
• gsGameProperties
• gsIPAddress
• gsGameSessionId
• gsMaximumPlayerSessionCount
• gsTerminationTime
• gsPlayerSessionCreationPolicy
• gsName
• gsCurrentPlayerSessionCount
• gsFleetId

Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).

Current status of the game session. A game session must be in an ACTIVE state to have player sessions.

Set of custom properties for the game session.

IP address of the game session.

Unique identifier for a game session.

Maximum number of players allowed in the game session.

Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).

Indicates whether or not the game session is accepting new players.

Descriptive label associated with this game session. Session names do not need to be unique.

Number of players currently in the game session.

Unique identifier for a fleet.

A game session's properties and the protection policy currently in force.

See: gameSessionDetail smart constructor.

Creates a value of GameSessionDetail with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gsdGameSession
• gsdProtectionPolicy

Undocumented member.

Current status of protection for the game session.

• NoProtection: The game session can be terminated during a scale-down event.
• FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.

IP addresses and port settings used to limit access by incoming traffic (players) to a fleet. Permissions specify a range of IP addresses and port settings that must be used to gain access to a game server on a fleet machine.

See: ipPermission smart constructor.

Creates a value of IPPermission with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ipFromPort
• ipToPort
• ipIPRange
• ipProtocol

Starting value for a range of allowed port numbers.

Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.

Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "'000.000.000.000/[subnet mask]'" or optionally the shortened version "'0.0.0.0/[subnet mask]'".

Network communication protocol used by the fleet.

Properties describing a player session.

See: playerSession smart constructor.

Creates a value of PlayerSession with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• psCreationTime
• psStatus
• psIPAddress
• psGameSessionId
• psTerminationTime
• psPlayerSessionId
• psFleetId
• psPlayerId

Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).

Current status of the player session. Possible player session states include:

• RESERVED: The player session request has been received, but the player has not yet connected to the game server and/or been validated.
• ACTIVE: The player has been validated by the game server and is currently connected.
• COMPLETED: The player connection has been dropped.
• TIMEDOUT: A player session request was received, but the player did not connect and/or was not validated within the time-out limit (60 seconds).

Game session IP address. All player sessions reference the game session location.

Unique identifier for a game session.

Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).

Unique identifier for a player session.

Unique identifier for a fleet.

Unique identifier for a player.

Routing configuration for a fleet alias.

See: routingStrategy smart constructor.

Creates a value of RoutingStrategy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rsType
• rsMessage
• rsFleetId

Type of routing strategy. Possible routing types include:

• SIMPLE: The alias resolves to one specific fleet. Use this type when routing to active fleets.
• TERMINAL: The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.

Message text to be used with a terminal routing strategy.

Unique identifier for a fleet.

Location in Amazon Simple Storage Service (Amazon S3) where a build's files are stored. This location is assigned in response to a CreateBuild call, and is always in the same region as the service used to create the build. For more details see the Amazon S3 documentation.

See: s3Location smart constructor.

Creates a value of S3Location with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• slBucket
• slKey
• slRoleARN

Amazon S3 bucket identifier.

Amazon S3 bucket key.

Undocumented member.

Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.

See: scalingPolicy smart constructor.

Creates a value of ScalingPolicy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• spStatus
• spScalingAdjustmentType
• spEvaluationPeriods
• spMetricName
• spComparisonOperator
• spName
• spThreshold
• spScalingAdjustment
• spFleetId

Current status of the scaling policy. The scaling policy is only in force when in an Active state.

• ACTIVE: The scaling policy is currently in force.
• UPDATEREQUESTED: A request to update the scaling policy has been received.
• UPDATING: A change is being made to the scaling policy.
• DELETEREQUESTED: A request to delete the scaling policy has been received.
• DELETING: The scaling policy is being deleted.
• DELETED: The scaling policy has been deleted.
• ERROR: An error occurred in creating the policy. It should be removed and recreated.

Type of adjustment to make to a fleet's instance count (see FleetCapacity):

• ChangeInCapacity: add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
• ExactCapacity: set the instance count to the scaling adjustment value.
• PercentChangeInCapacity: increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.

Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.

Name of the GameLift-defined metric that is used to trigger an adjustment.

• ActivatingGameSessions: number of game sessions in the process of being created (game session status = ACTIVATING).
• ActiveGameSessions: number of game sessions currently running (game session status = ACTIVE).
• CurrentPlayerSessions: number of active or reserved player sessions (player session status = ACTIVE or RESERVED).
• AvailablePlayerSessions: number of player session slots currently available in active game sessions across the fleet, calculated by subtracting a game session's current player session count from its maximum player session count. This number does include game sessions that are not currently accepting players (game session PlayerSessionCreationPolicy = DENY_ALL).
• ActiveInstances: number of instances currently running a game session.
• IdleInstances: number of instances not currently running a game session.

Comparison operator to use when measuring a metric against the threshold value.

Descriptive label associated with this scaling policy. Policy names do not need to be unique.

Metric value used to trigger a scaling event.

Amount of adjustment to make, based on the scaling adjustment type.

Unique identity for the fleet associated with this scaling policy.