String aliasId
Unique identifier for a fleet alias.
String name
Descriptive label associated with this alias. Alias names do not need to be unique.
String description
Human-readable description of the alias.
RoutingStrategy routingStrategy
Date creationTime
Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
Date lastUpdatedTime
Time stamp indicating when this object was last modified. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
String buildId
Unique identifier for a build.
String name
Descriptive label associated with this build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.
String version
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.
String status
Current status of the build. Possible build states include:
Long sizeOnDisk
File size of the uploaded game build, expressed in bytes. When the build state is INITIALIZED, this value is 0.
Date creationTime
Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
String name
Descriptive label associated with this alias. Alias names do not need to be unique.
String description
Human-readable description of the alias.
RoutingStrategy routingStrategy
Object specifying the fleet and routing type to use for the alias.
Alias alias
Object containing the newly created alias record.
String name
Descriptive label associated with this build. Build names do not need to be unique. A build name can be changed later using UpdateBuild.
String version
Version associated with this build. Version strings do not need to be unique to a build. A build version can be changed later using UpdateBuild.
S3Location storageLocation
Build build
Set of properties for the newly created build.
Credentials uploadCredentials
AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for. If you need to get fresh credentials, call RequestUploadCredentials.
S3Location storageLocation
Amazon S3 path and key, identifying where the game build files are stored.
String name
Descriptive label associated with this fleet. Fleet names do not need to be unique.
String description
Human-readable description of the fleet.
String buildId
Unique identifier for the build you want the new fleet to use.
String serverLaunchPath
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.
String serverLaunchParameters
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".
List<E> logPaths
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.
String eC2InstanceType
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.
List<E> eC2InboundPermissions
Access limits for incoming traffic. Setting these values limits game server access to incoming traffic using specified IP ranges and port numbers. Some ports in a range may be restricted. You can provide one or more sets of permissions for the fleet.
String newGameSessionProtectionPolicy
Game session protection policy to apply to all instances created in this fleet. If this parameter is not set, new instances in this fleet will default to no protection. Protection can be set for individual instances using UpdateGameSession.
FleetAttributes fleetAttributes
Properties for the newly created fleet.
String fleetId
Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.
String aliasId
Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.
Integer maximumPlayerSessionCount
Maximum number of players that can be connected simultaneously to the game session.
String name
Descriptive label associated with this game session. Session names do not need to be unique.
List<E> gameProperties
Set of properties used to administer a game session. These properties are passed to your game server.
GameSession gameSession
Object containing the newly created game session record.
PlayerSession playerSession
Object containing the newly created player session record.
String aliasId
Unique identifier for a fleet alias. Specify the alias you want to delete.
String buildId
Unique identifier for the build you want to delete.
String fleetId
Unique identifier for the fleet you want to delete.
String aliasId
Unique identifier for a fleet alias. Specify the alias you want to retrieve.
Alias alias
Object containing the requested alias.
String buildId
Unique identifier for the build you want to retrieve properties for.
Build build
Set of properties describing the requested build.
String eC2InstanceType
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. Leave this parameter blank to retrieve limits for all types.
List<E> fleetIds
Unique identifiers for the fleet(s) that you want to retrieve attributes for. Leave this parameter empty to retrieve attributes for all fleets.
Integer limit
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
List<E> fleetAttributes
Collection of objects containing attribute metadata for each requested fleet ID.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
List<E> fleetIds
Unique identifier for the fleet(s) you want to retrieve capacity information for.
Integer limit
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
List<E> fleetCapacity
Collection of objects containing capacity information for each requested fleet ID. Leave this parameter empty to retrieve capacity information for all fleets.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
String fleetId
Unique identifier for the fleet to get event logs for.
Date startTime
Earliest date to retrieve event logs for. If no start time is specified, this call returns entries starting from when the fleet was created to the specified end time. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
Date endTime
Most recent date to retrieve event logs for. If no end time is specified, this call returns entries from the specified start time up to the present. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
Integer limit
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
List<E> events
Collection of objects containing event log entries for the specified fleet.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
String fleetId
Unique identifier for the fleet you want to retrieve port settings for.
List<E> fleetIds
Unique identifier for the fleet(s) you want to retrieve utilization data for. Leave this parameter empty to retrieve utilization data for all fleets.
Integer limit
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
List<E> fleetUtilization
Collection of objects containing utilization information for each requested fleet ID.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
String fleetId
Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.
String gameSessionId
Unique identifier for a game session. Specify the game session to retrieve information on.
String aliasId
Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.
String statusFilter
Game session status to filter results on. Possible game session states include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).
Integer limit
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
List<E> gameSessionDetails
Collection of objects containing game session properties and the protection policy currently in force for each session matching the request.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
String fleetId
Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.
String gameSessionId
Unique identifier for a game session. Specify the game session to retrieve information on.
String aliasId
Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.
String statusFilter
Game session status to filter results on. Possible game session states include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).
Integer limit
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
List<E> gameSessions
Collection of objects containing game session properties for each session matching the request.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
String gameSessionId
Unique identifier for a game session.
String playerId
Unique identifier for a player.
String playerSessionId
Unique identifier for a player session.
String playerSessionStatusFilter
Player session status to filter results on. Possible player session states include:
Integer limit
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value. If a player session ID is specified, this parameter is ignored.
List<E> playerSessions
Collection of objects containing properties for each player session that matches the request.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
String fleetId
Unique identifier for a fleet. Specify the fleet to retrieve scaling policies for.
String statusFilter
Game session status to filter results on. A scaling policy is only in force when in an Active state.
Integer limit
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
List<E> scalingPolicies
Collection of objects containing the scaling policies matching the request.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
Integer dESIRED
Ideal number of active instances in the fleet.
Integer mINIMUM
Minimum value allowed for the fleet's instance count.
Integer mAXIMUM
Maximum value allowed for the fleet's instance count.
Integer pENDING
Number of instances in the fleet that are starting but not yet active.
Integer aCTIVE
Actual number of active instances in the fleet.
Integer iDLE
Number of active instances in the fleet that are not currently hosting a game session.
Integer tERMINATING
Number of instances in the fleet that are no longer active but haven't yet been terminated.
String eC2InstanceType
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.
Integer currentInstances
Number of instances of the specified type that are currently in use by this AWS account.
Integer instanceLimit
Number of instances allowed.
String eventId
Unique identifier for a fleet event.
String resourceId
Unique identifier for the resource, such as a fleet ID.
String eventCode
Type of event being logged.
String message
Additional information related to the event.
Date eventTime
Time stamp indicating when this event occurred. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
String fleetId
Unique identifier for a fleet.
String description
Human-readable description of the fleet.
String name
Descriptive label associated with this fleet. Fleet names do not need to be unique.
Date creationTime
Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
Date terminationTime
Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
String status
Current status of the fleet. Possible fleet states include:
String buildId
Unique identifier for a build.
String serverLaunchPath
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.
String serverLaunchParameters
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".
List<E> logPaths
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.
String newGameSessionProtectionPolicy
Type of game session protection to set for all new instances started in the fleet.
String fleetId
Unique identifier for a fleet.
String instanceType
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.
EC2InstanceCounts instanceCounts
Current status of fleet capacity.
String fleetId
Unique identifier for a fleet.
Integer activeGameSessionCount
Number of active game sessions currently being hosted on fleet game servers.
Integer currentPlayerSessionCount
Number of active player sessions currently being hosted on fleet game servers.
Integer maximumPlayerSessionCount
Maximum players allowed across all game sessions currently hosted in the fleet.
String gameSessionId
Unique identifier for a game session.
String name
Descriptive label associated with this game session. Session names do not need to be unique.
String fleetId
Unique identifier for a fleet.
Date creationTime
Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
Date terminationTime
Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
Integer currentPlayerSessionCount
Number of players currently in the game session.
Integer maximumPlayerSessionCount
Maximum number of players allowed in the game session.
String status
Current status of the game session. A game session must be in an ACTIVE state to have player sessions.
List<E> gameProperties
Set of custom properties for the game session.
String ipAddress
IP address of the game session.
String playerSessionCreationPolicy
Indicates whether or not the game session is accepting new players.
GameSession gameSession
String protectionPolicy
Current status of protection for the game session.
String gameSessionId
Unique identifier for a game session. Specify the game session you want to get logs for.
String preSignedUrl
Location of the requested game session logs, available for download.
Integer fromPort
Starting value for a range of allowed port numbers.
Integer toPort
Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
String ipRange
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]
".
String protocol
Network communication protocol used by the fleet.
String routingStrategyType
Type of routing to filter results on. Use this parameter to retrieve only aliases of a certain type. To retrieve all aliases, leave this parameter empty. Possible routing types include:
String name
Descriptive label associated with this alias. Alias names do not need to be unique.
Integer limit
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
List<E> aliases
Collection of alias records that match the list request.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
String status
Build state to filter results on. Use this parameter to retrieve builds in a certain state. To retrieve all builds, leave this parameter empty. Possible build states include:
Integer limit
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
List<E> builds
Collection of build records that match the request.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
String buildId
Unique identifier of the build to return fleets for. Use this parameter to return only fleets using the specified build. To retrieve all fleets, leave this parameter empty.
Integer limit
Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
String nextToken
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
List<E> fleetIds
Set of fleet IDs matching the list request. You can retrieve additional information about all returned fleets by passing this result set to a call to DescribeFleetAttributes, DescribeFleetCapacity, and DescribeFleetUtilization.
String nextToken
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.
String playerSessionId
Unique identifier for a player session.
String playerId
Unique identifier for a player.
String gameSessionId
Unique identifier for a game session.
String fleetId
Unique identifier for a fleet.
Date creationTime
Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
Date terminationTime
Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
String status
Current status of the player session. Possible player session states include:
String ipAddress
Game session IP address. All player sessions reference the game session location.
String name
Descriptive label associated with this scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.
String fleetId
Unique identity for the fleet to scale with this policy.
Integer scalingAdjustment
Amount of adjustment to make, based on the scaling adjustment type.
String scalingAdjustmentType
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
Double threshold
Metric value used to trigger a scaling event.
String comparisonOperator
Comparison operator to use when measuring the metric against the threshold value.
Integer evaluationPeriods
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
String metricName
Name of the Service-defined metric that is used to trigger an adjustment.
String name
Descriptive label associated with this scaling policy. Policy names do not need to be unique.
String buildId
Unique identifier for the build you want to get credentials for.
Credentials uploadCredentials
AWS credentials required when uploading a game build to the storage location. These credentials have a limited lifespan and are valid only for the build they were issued for.
S3Location storageLocation
Amazon S3 path and key, identifying where the game build files are stored.
String aliasId
Unique identifier for the alias you want to resolve.
String fleetId
Fleet ID associated with the requested alias.
String type
Type of routing strategy. Possible routing types include:
String fleetId
Unique identifier for a fleet.
String message
Message text to be used with a terminal routing strategy.
String fleetId
Unique identity for the fleet associated with this scaling policy.
String name
Descriptive label associated with this scaling policy. Policy names do not need to be unique.
String status
Current status of the scaling policy. The scaling policy is only in force when in an Active state.
Integer scalingAdjustment
Amount of adjustment to make, based on the scaling adjustment type.
String scalingAdjustmentType
Type of adjustment to make to a fleet's instance count (see FleetCapacity):
String comparisonOperator
Comparison operator to use when measuring a metric against the threshold value.
Double threshold
Metric value used to trigger a scaling event.
Integer evaluationPeriods
Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
String metricName
Name of the GameLift-defined metric that is used to trigger an adjustment.
String aliasId
Unique identifier for a fleet alias. Specify the alias you want to update.
String name
Descriptive label associated with this alias. Alias names do not need to be unique.
String description
Human-readable description of the alias.
RoutingStrategy routingStrategy
Object specifying the fleet and routing type to use for the alias.
Alias alias
Object containing the updated alias configuration.
Build build
Object containing the updated build record.
String fleetId
Unique identifier for the fleet you want to update attribute metadata for.
String name
Descriptive label associated with this fleet. Fleet names do not need to be unique.
String description
Human-readable description of the fleet.
String newGameSessionProtectionPolicy
Game session protection policy to apply to all new instances created in this fleet. Instances that already exist will not be affected. You can set protection for individual instances using UpdateGameSession.
String fleetId
Unique identifier for the updated fleet.
String fleetId
Unique identifier for the fleet you want to update capacity for.
Integer desiredInstances
Number of EC2 instances you want this fleet to host.
Integer minSize
Minimum value allowed for the fleet's instance count. Default if not set is 0.
Integer maxSize
Maximum value allowed for the fleet's instance count. Default if not set is 1.
String fleetId
Unique identifier for the updated fleet.
String fleetId
Unique identifier for the fleet you want to update port settings for.
List<E> inboundPermissionAuthorizations
Collection of port settings to be added to the fleet record.
List<E> inboundPermissionRevocations
Collection of port settings to be removed from the fleet record.
String fleetId
Unique identifier for the updated fleet.
String gameSessionId
Unique identifier for a game session. Specify the game session you want to update.
Integer maximumPlayerSessionCount
Maximum number of players that can be simultaneously connected to the game session.
String name
Descriptive label associated with this game session. Session names do not need to be unique.
String playerSessionCreationPolicy
Policy determining whether or not the game session accepts new players.
String protectionPolicy
Game session protection policy to apply to this game session only.
GameSession gameSession
Object containing the updated game session metadata.
Copyright © 2016. All rights reserved.