@datafire/amazonaws_gamelift
Client library for Amazon GameLift
Installation and Usage
npm install --save @datafire/amazonaws_gamelift
let amazonaws_gamelift = require('@datafire/amazonaws_gamelift').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_gamelift.AcceptMatch({
"TicketId": "",
"PlayerIds": [],
"AcceptanceType": ""
}).then(data => {
console.log(data);
});
Description
Amazon GameLift Service
Amazon GameLift is a managed service for developers who need a scalable, dedicated server solution for their multiplayer games. Use Amazon GameLift for these tasks: (1) set up computing resources and deploy your game servers, (2) run game sessions and get players into games, (3) automatically scale your resources to meet player demand and manage costs, and (4) track in-depth metrics on game server performance and player usage.
The Amazon GameLift service API includes two important function sets:
-
Manage game sessions and player access -- Retrieve information on available game sessions; create new game sessions; send player requests to join a game session.
-
Configure and manage game server resources -- Manage builds, fleets, queues, and aliases; set autoscaling policies; retrieve logs and metrics.
This reference guide describes the low-level service API for Amazon GameLift. You can use the API functionality with these tools:
-
The Amazon Web Services software development kit (AWS SDK) is available in multiple languages including C++ and C#. Use the SDK to access the API programmatically from an application, such as a game client.
-
The AWS command-line interface (CLI) tool is primarily useful for handling administrative actions, such as setting up and managing Amazon GameLift settings and resources. You can use the AWS CLI to manage all of your AWS services.
-
The AWS Management Console for Amazon GameLift provides a web interface to manage your Amazon GameLift settings and resources. The console includes a dashboard for tracking key resources, including builds and fleets, and displays usage and performance metrics for your games as customizable graphs.
-
Amazon GameLift Local is a tool for testing your game's integration with Amazon GameLift before deploying it on the service. This tools supports a subset of key API actions, which can be called from either the AWS CLI or programmatically. See Testing an Integration.
Learn more
-
Developer Guide -- Read about Amazon GameLift features and how to use them.
-
Tutorials -- Get started fast with walkthroughs and sample projects.
-
GameDev Blog -- Stay up to date with new features and techniques.
-
GameDev Forums -- Connect with the GameDev community.
-
Release notes and document history -- Stay current with updates to the Amazon GameLift service, SDKs, and documentation.
API SUMMARY
This list offers a functional overview of the Amazon GameLift service API.
Managing Games and Players
Use these actions to start new game sessions, find existing game sessions, track game session status and other information, and enable player access to game sessions.
-
Discover existing game sessions
-
SearchGameSessions -- Retrieve all available game sessions or search for game sessions that match a set of criteria.
-
-
Start new game sessions
-
Start new games with Queues to find the best available hosting resources across multiple regions, minimize player latency, and balance game session activity for efficiency and cost effectiveness.
-
StartGameSessionPlacement -- Request a new game session placement and add one or more players to it.
-
DescribeGameSessionPlacement -- Get details on a placement request, including status.
-
StopGameSessionPlacement -- Cancel a placement request.
-
-
CreateGameSession -- Start a new game session on a specific fleet. Available in Amazon GameLift Local.
-
-
Match players to game sessions with FlexMatch matchmaking
-
StartMatchmaking -- Request matchmaking for one players or a group who want to play together.
-
StartMatchBackfill - Request additional player matches to fill empty slots in an existing game session.
-
DescribeMatchmaking -- Get details on a matchmaking request, including status.
-
AcceptMatch -- Register that a player accepts a proposed match, for matches that require player acceptance.
-
StopMatchmaking -- Cancel a matchmaking request.
-
-
Manage game session data
-
DescribeGameSessions -- Retrieve metadata for one or more game sessions, including length of time active and current player count. Available in Amazon GameLift Local.
-
DescribeGameSessionDetails -- Retrieve metadata and the game session protection setting for one or more game sessions.
-
UpdateGameSession -- Change game session settings, such as maximum player count and join policy.
-
GetGameSessionLogUrl -- Get the location of saved logs for a game session.
-
-
Manage player sessions
-
CreatePlayerSession -- Send a request for a player to join a game session. Available in Amazon GameLift Local.
-
CreatePlayerSessions -- Send a request for multiple players to join a game session. Available in Amazon GameLift Local.
-
DescribePlayerSessions -- Get details on player activity, including status, playing time, and player data. Available in Amazon GameLift Local.
-
Setting Up and Managing Game Servers
When setting up Amazon GameLift resources for your game, you first create a game build and upload it to Amazon GameLift. You can then use these actions to configure and manage a fleet of resources to run your game servers, scale capacity to meet player demand, access performance and utilization metrics, and more.
-
Manage game builds
-
CreateBuild -- Create a new build using files stored in an Amazon S3 bucket. To create a build and upload files from a local path, use the AWS CLI command
upload-build
. -
ListBuilds -- Get a list of all builds uploaded to a Amazon GameLift region.
-
DescribeBuild -- Retrieve information associated with a build.
-
UpdateBuild -- Change build metadata, including build name and version.
-
DeleteBuild -- Remove a build from Amazon GameLift.
-
-
Manage fleets
-
CreateFleet -- Configure and activate a new fleet to run a build's game servers.
-
ListFleets -- Get a list of all fleet IDs in a Amazon GameLift region (all statuses).
-
DeleteFleet -- Terminate a fleet that is no longer running game servers or hosting players.
-
View / update fleet configurations.
-
DescribeFleetAttributes / UpdateFleetAttributes -- View or change a fleet's metadata and settings for game session protection and resource creation limits.
-
DescribeFleetPortSettings / UpdateFleetPortSettings -- View or change the inbound permissions (IP address and port setting ranges) allowed for a fleet.
-
DescribeRuntimeConfiguration / UpdateRuntimeConfiguration -- View or change what server processes (and how many) to run on each instance in a fleet.
-
-
-
Control fleet capacity
-
DescribeEC2InstanceLimits -- Retrieve maximum number of instances allowed for the current AWS account and the current usage level.
-
DescribeFleetCapacity / UpdateFleetCapacity -- Retrieve the capacity settings and the current number of instances in a fleet; adjust fleet capacity settings to scale up or down.
-
Autoscale -- Manage autoscaling rules and apply them to a fleet.
-
PutScalingPolicy -- Create a new autoscaling policy, or update an existing one.
-
DescribeScalingPolicies -- Retrieve an existing autoscaling policy.
-
DeleteScalingPolicy -- Delete an autoscaling policy and stop it from affecting a fleet's capacity.
-
-
-
Manage VPC peering connections for fleets
-
CreateVpcPeeringAuthorization -- Authorize a peering connection to one of your VPCs.
-
DescribeVpcPeeringAuthorizations -- Retrieve valid peering connection authorizations.
-
DeleteVpcPeeringAuthorization -- Delete a peering connection authorization.
-
CreateVpcPeeringConnection -- Establish a peering connection between the VPC for a Amazon GameLift fleet and one of your VPCs.
-
DescribeVpcPeeringConnections -- Retrieve information on active or pending VPC peering connections with a Amazon GameLift fleet.
-
DeleteVpcPeeringConnection -- Delete a VPC peering connection with a Amazon GameLift fleet.
-
-
Access fleet activity statistics
-
DescribeFleetUtilization -- Get current data on the number of server processes, game sessions, and players currently active on a fleet.
-
DescribeFleetEvents -- Get a fleet's logged events for a specified time span.
-
DescribeGameSessions -- Retrieve metadata associated with one or more game sessions, including length of time active and current player count.
-
-
Remotely access an instance
-
DescribeInstances -- Get information on each instance in a fleet, including instance ID, IP address, and status.
-
GetInstanceAccess -- Request access credentials needed to remotely connect to a specified instance in a fleet.
-
-
Manage fleet aliases
-
CreateAlias -- Define a new alias and optionally assign it to a fleet.
-
ListAliases -- Get all fleet aliases defined in a Amazon GameLift region.
-
DescribeAlias -- Retrieve information on an existing alias.
-
UpdateAlias -- Change settings for a alias, such as redirecting it from one fleet to another.
-
DeleteAlias -- Remove an alias from the region.
-
ResolveAlias -- Get the fleet ID that a specified alias points to.
-
-
Manage game session queues
-
CreateGameSessionQueue -- Create a queue for processing requests for new game sessions.
-
DescribeGameSessionQueues -- Retrieve game session queues defined in a Amazon GameLift region.
-
UpdateGameSessionQueue -- Change the configuration of a game session queue.
-
DeleteGameSessionQueue -- Remove a game session queue from the region.
-
-
Manage FlexMatch resources
-
CreateMatchmakingConfiguration -- Create a matchmaking configuration with instructions for building a player group and placing in a new game session.
-
DescribeMatchmakingConfigurations -- Retrieve matchmaking configurations defined a Amazon GameLift region.
-
UpdateMatchmakingConfiguration -- Change settings for matchmaking configuration. queue.
-
DeleteMatchmakingConfiguration -- Remove a matchmaking configuration from the region.
-
CreateMatchmakingRuleSet -- Create a set of rules to use when searching for player matches.
-
DescribeMatchmakingRuleSets -- Retrieve matchmaking rule sets defined in a Amazon GameLift region.
-
ValidateMatchmakingRuleSet -- Verify syntax for a set of matchmaking rules.
-
Actions
AcceptMatch
amazonaws_gamelift.AcceptMatch({
"TicketId": "",
"PlayerIds": [],
"AcceptanceType": ""
}, context)
Input
- input
object
- AcceptanceType required AcceptanceType
- PlayerIds required StringList
- TicketId required MatchmakingIdStringModel
Output
- output AcceptMatchOutput
CreateAlias
amazonaws_gamelift.CreateAlias({
"Name": "",
"RoutingStrategy": {}
}, context)
Input
- input
object
- Description NonZeroAndMaxString
- Name required NonBlankAndLengthConstraintString
- RoutingStrategy required RoutingStrategy
Output
- output CreateAliasOutput
CreateBuild
amazonaws_gamelift.CreateBuild({}, context)
Input
- input
object
- Name NonZeroAndMaxString
- OperatingSystem OperatingSystem
- StorageLocation S3Location
- Version NonZeroAndMaxString
Output
- output CreateBuildOutput
CreateFleet
amazonaws_gamelift.CreateFleet({
"Name": "",
"BuildId": "",
"EC2InstanceType": ""
}, context)
Input
- input
object
- BuildId required BuildId
- Description NonZeroAndMaxString
- EC2InboundPermissions IpPermissionsList
- EC2InstanceType required EC2InstanceType
- FleetType FleetType
- LogPaths StringList
- MetricGroups MetricGroupList
- Name required NonZeroAndMaxString
- NewGameSessionProtectionPolicy ProtectionPolicy
- PeerVpcAwsAccountId NonZeroAndMaxString
- PeerVpcId NonZeroAndMaxString
- ResourceCreationLimitPolicy ResourceCreationLimitPolicy
- RuntimeConfiguration RuntimeConfiguration
- ServerLaunchParameters NonZeroAndMaxString
- ServerLaunchPath NonZeroAndMaxString
Output
- output CreateFleetOutput
CreateGameSession
amazonaws_gamelift.CreateGameSession({
"MaximumPlayerSessionCount": 0
}, context)
Input
- input
object
- AliasId AliasId
- CreatorId NonZeroAndMaxString
- FleetId FleetId
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionId IdStringModel
- IdempotencyToken IdStringModel
- MaximumPlayerSessionCount required WholeNumber
- Name NonZeroAndMaxString
Output
- output CreateGameSessionOutput
CreateGameSessionQueue
amazonaws_gamelift.CreateGameSessionQueue({
"Name": ""
}, context)
Input
- input
object
- Destinations GameSessionQueueDestinationList
- Name required GameSessionQueueName
- PlayerLatencyPolicies PlayerLatencyPolicyList
- TimeoutInSeconds WholeNumber
Output
- output CreateGameSessionQueueOutput
CreateMatchmakingConfiguration
amazonaws_gamelift.CreateMatchmakingConfiguration({
"Name": "",
"GameSessionQueueArns": [],
"RequestTimeoutSeconds": 0,
"AcceptanceRequired": true,
"RuleSetName": ""
}, context)
Input
- input
object
- AcceptanceRequired required BooleanModel
- AcceptanceTimeoutSeconds MatchmakingAcceptanceTimeoutInteger
- AdditionalPlayerCount WholeNumber
- CustomEventData CustomEventData
- Description NonZeroAndMaxString
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionQueueArns required QueueArnsList
- Name required MatchmakingIdStringModel
- NotificationTarget SnsArnStringModel
- RequestTimeoutSeconds required MatchmakingRequestTimeoutInteger
- RuleSetName required MatchmakingIdStringModel
Output
CreateMatchmakingRuleSet
amazonaws_gamelift.CreateMatchmakingRuleSet({
"Name": "",
"RuleSetBody": ""
}, context)
Input
- input
object
- Name required MatchmakingIdStringModel
- RuleSetBody required RuleSetBody
Output
CreatePlayerSession
amazonaws_gamelift.CreatePlayerSession({
"GameSessionId": "",
"PlayerId": ""
}, context)
Input
- input
object
- GameSessionId required ArnStringModel
- PlayerData PlayerData
- PlayerId required NonZeroAndMaxString
Output
- output CreatePlayerSessionOutput
CreatePlayerSessions
amazonaws_gamelift.CreatePlayerSessions({
"GameSessionId": "",
"PlayerIds": []
}, context)
Input
- input
object
- GameSessionId required ArnStringModel
- PlayerDataMap PlayerDataMap
- PlayerIds required PlayerIdList
Output
- output CreatePlayerSessionsOutput
CreateVpcPeeringAuthorization
amazonaws_gamelift.CreateVpcPeeringAuthorization({
"GameLiftAwsAccountId": "",
"PeerVpcId": ""
}, context)
Input
- input
object
- GameLiftAwsAccountId required NonZeroAndMaxString
- PeerVpcId required NonZeroAndMaxString
Output
CreateVpcPeeringConnection
amazonaws_gamelift.CreateVpcPeeringConnection({
"FleetId": "",
"PeerVpcAwsAccountId": "",
"PeerVpcId": ""
}, context)
Input
- input
object
- FleetId required FleetId
- PeerVpcAwsAccountId required NonZeroAndMaxString
- PeerVpcId required NonZeroAndMaxString
Output
DeleteAlias
amazonaws_gamelift.DeleteAlias({
"AliasId": ""
}, context)
Input
- input
object
- AliasId required AliasId
Output
Output schema unknown
DeleteBuild
amazonaws_gamelift.DeleteBuild({
"BuildId": ""
}, context)
Input
- input
object
- BuildId required BuildId
Output
Output schema unknown
DeleteFleet
amazonaws_gamelift.DeleteFleet({
"FleetId": ""
}, context)
Input
- input
object
- FleetId required FleetId
Output
Output schema unknown
DeleteGameSessionQueue
amazonaws_gamelift.DeleteGameSessionQueue({
"Name": ""
}, context)
Input
- input
object
- Name required GameSessionQueueName
Output
- output DeleteGameSessionQueueOutput
DeleteMatchmakingConfiguration
amazonaws_gamelift.DeleteMatchmakingConfiguration({
"Name": ""
}, context)
Input
- input
object
- Name required MatchmakingIdStringModel
Output
DeleteScalingPolicy
amazonaws_gamelift.DeleteScalingPolicy({
"Name": "",
"FleetId": ""
}, context)
Input
- input
object
- FleetId required FleetId
- Name required NonZeroAndMaxString
Output
Output schema unknown
DeleteVpcPeeringAuthorization
amazonaws_gamelift.DeleteVpcPeeringAuthorization({
"GameLiftAwsAccountId": "",
"PeerVpcId": ""
}, context)
Input
- input
object
- GameLiftAwsAccountId required NonZeroAndMaxString
- PeerVpcId required NonZeroAndMaxString
Output
DeleteVpcPeeringConnection
amazonaws_gamelift.DeleteVpcPeeringConnection({
"FleetId": "",
"VpcPeeringConnectionId": ""
}, context)
Input
- input
object
- FleetId required FleetId
- VpcPeeringConnectionId required NonZeroAndMaxString
Output
DescribeAlias
amazonaws_gamelift.DescribeAlias({
"AliasId": ""
}, context)
Input
- input
object
- AliasId required AliasId
Output
- output DescribeAliasOutput
DescribeBuild
amazonaws_gamelift.DescribeBuild({
"BuildId": ""
}, context)
Input
- input
object
- BuildId required BuildId
Output
- output DescribeBuildOutput
DescribeEC2InstanceLimits
amazonaws_gamelift.DescribeEC2InstanceLimits({}, context)
Input
- input
object
- EC2InstanceType EC2InstanceType
Output
DescribeFleetAttributes
amazonaws_gamelift.DescribeFleetAttributes({}, context)
Input
- input
object
- FleetIds FleetIdList
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
Output
DescribeFleetCapacity
amazonaws_gamelift.DescribeFleetCapacity({}, context)
Input
- input
object
- FleetIds FleetIdList
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
Output
- output DescribeFleetCapacityOutput
DescribeFleetEvents
amazonaws_gamelift.DescribeFleetEvents({
"FleetId": ""
}, context)
Input
- input
object
- EndTime Timestamp
- FleetId required FleetId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StartTime Timestamp
Output
- output DescribeFleetEventsOutput
DescribeFleetPortSettings
amazonaws_gamelift.DescribeFleetPortSettings({
"FleetId": ""
}, context)
Input
- input
object
- FleetId required FleetId
Output
DescribeFleetUtilization
amazonaws_gamelift.DescribeFleetUtilization({}, context)
Input
- input
object
- FleetIds FleetIdList
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
Output
DescribeGameSessionDetails
amazonaws_gamelift.DescribeGameSessionDetails({}, context)
Input
- input
object
- AliasId AliasId
- FleetId FleetId
- GameSessionId ArnStringModel
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StatusFilter NonZeroAndMaxString
Output
DescribeGameSessionPlacement
amazonaws_gamelift.DescribeGameSessionPlacement({
"PlacementId": ""
}, context)
Input
- input
object
- PlacementId required IdStringModel
Output
DescribeGameSessionQueues
amazonaws_gamelift.DescribeGameSessionQueues({}, context)
Input
- input
object
- Limit PositiveInteger
- Names GameSessionQueueNameList
- NextToken NonZeroAndMaxString
Output
DescribeGameSessions
amazonaws_gamelift.DescribeGameSessions({}, context)
Input
- input
object
- AliasId AliasId
- FleetId FleetId
- GameSessionId ArnStringModel
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StatusFilter NonZeroAndMaxString
Output
- output DescribeGameSessionsOutput
DescribeInstances
amazonaws_gamelift.DescribeInstances({
"FleetId": ""
}, context)
Input
- input
object
- FleetId required FleetId
- InstanceId InstanceId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
Output
- output DescribeInstancesOutput
DescribeMatchmaking
amazonaws_gamelift.DescribeMatchmaking({
"TicketIds": []
}, context)
Input
- input
object
- TicketIds required MatchmakingIdList
Output
- output DescribeMatchmakingOutput
DescribeMatchmakingConfigurations
amazonaws_gamelift.DescribeMatchmakingConfigurations({}, context)
Input
- input
object
- Limit PositiveInteger
- Names MatchmakingIdList
- NextToken NonZeroAndMaxString
- RuleSetName MatchmakingIdStringModel
Output
DescribeMatchmakingRuleSets
amazonaws_gamelift.DescribeMatchmakingRuleSets({}, context)
Input
- input
object
- Limit RuleSetLimit
- Names MatchmakingRuleSetNameList
- NextToken NonZeroAndMaxString
Output
DescribePlayerSessions
amazonaws_gamelift.DescribePlayerSessions({}, context)
Input
- input
object
- GameSessionId ArnStringModel
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- PlayerId NonZeroAndMaxString
- PlayerSessionId PlayerSessionId
- PlayerSessionStatusFilter NonZeroAndMaxString
Output
- output DescribePlayerSessionsOutput
DescribeRuntimeConfiguration
amazonaws_gamelift.DescribeRuntimeConfiguration({
"FleetId": ""
}, context)
Input
- input
object
- FleetId required FleetId
Output
DescribeScalingPolicies
amazonaws_gamelift.DescribeScalingPolicies({
"FleetId": ""
}, context)
Input
- input
object
- FleetId required FleetId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StatusFilter ScalingStatusType
Output
DescribeVpcPeeringAuthorizations
amazonaws_gamelift.DescribeVpcPeeringAuthorizations({}, context)
Input
- input
object
Output
DescribeVpcPeeringConnections
amazonaws_gamelift.DescribeVpcPeeringConnections({}, context)
Input
- input
object
- FleetId FleetId
Output
GetGameSessionLogUrl
amazonaws_gamelift.GetGameSessionLogUrl({
"GameSessionId": ""
}, context)
Input
- input
object
- GameSessionId required ArnStringModel
Output
- output GetGameSessionLogUrlOutput
GetInstanceAccess
amazonaws_gamelift.GetInstanceAccess({
"FleetId": "",
"InstanceId": ""
}, context)
Input
- input
object
- FleetId required FleetId
- InstanceId required InstanceId
Output
- output GetInstanceAccessOutput
ListAliases
amazonaws_gamelift.ListAliases({}, context)
Input
- input
object
- Limit PositiveInteger
- Name NonEmptyString
- NextToken NonEmptyString
- RoutingStrategyType RoutingStrategyType
Output
- output ListAliasesOutput
ListBuilds
amazonaws_gamelift.ListBuilds({}, context)
Input
- input
object
- Limit PositiveInteger
- NextToken NonEmptyString
- Status BuildStatus
Output
- output ListBuildsOutput
ListFleets
amazonaws_gamelift.ListFleets({}, context)
Input
- input
object
- BuildId BuildId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
Output
- output ListFleetsOutput
PutScalingPolicy
amazonaws_gamelift.PutScalingPolicy({
"Name": "",
"FleetId": "",
"ScalingAdjustment": 0,
"ScalingAdjustmentType": "",
"Threshold": 0,
"ComparisonOperator": "",
"EvaluationPeriods": 0,
"MetricName": ""
}, context)
Input
- input
object
- ComparisonOperator required ComparisonOperatorType
- EvaluationPeriods required PositiveInteger
- FleetId required FleetId
- MetricName required MetricName
- Name required NonZeroAndMaxString
- ScalingAdjustment required Integer
- ScalingAdjustmentType required ScalingAdjustmentType
- Threshold required Double
Output
- output PutScalingPolicyOutput
RequestUploadCredentials
amazonaws_gamelift.RequestUploadCredentials({
"BuildId": ""
}, context)
Input
- input
object
- BuildId required BuildId
Output
ResolveAlias
amazonaws_gamelift.ResolveAlias({
"AliasId": ""
}, context)
Input
- input
object
- AliasId required AliasId
Output
- output ResolveAliasOutput
SearchGameSessions
amazonaws_gamelift.SearchGameSessions({}, context)
Input
- input
object
- AliasId AliasId
- FilterExpression NonZeroAndMaxString
- FleetId FleetId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- SortExpression NonZeroAndMaxString
Output
- output SearchGameSessionsOutput
StartGameSessionPlacement
amazonaws_gamelift.StartGameSessionPlacement({
"PlacementId": "",
"GameSessionQueueName": "",
"MaximumPlayerSessionCount": 0
}, context)
Input
- input
object
- DesiredPlayerSessions DesiredPlayerSessionList
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionName NonZeroAndMaxString
- GameSessionQueueName required GameSessionQueueName
- MaximumPlayerSessionCount required WholeNumber
- PlacementId required IdStringModel
- PlayerLatencies PlayerLatencyList
Output
StartMatchBackfill
amazonaws_gamelift.StartMatchBackfill({
"ConfigurationName": "",
"GameSessionArn": "",
"Players": []
}, context)
Input
- input
object
- ConfigurationName required MatchmakingIdStringModel
- GameSessionArn required ArnStringModel
- Players required PlayerList
- TicketId MatchmakingIdStringModel
Output
- output StartMatchBackfillOutput
StartMatchmaking
amazonaws_gamelift.StartMatchmaking({
"ConfigurationName": "",
"Players": []
}, context)
Input
- input
object
- ConfigurationName required MatchmakingIdStringModel
- Players required PlayerList
- TicketId MatchmakingIdStringModel
Output
- output StartMatchmakingOutput
StopGameSessionPlacement
amazonaws_gamelift.StopGameSessionPlacement({
"PlacementId": ""
}, context)
Input
- input
object
- PlacementId required IdStringModel
Output
StopMatchmaking
amazonaws_gamelift.StopMatchmaking({
"TicketId": ""
}, context)
Input
- input
object
- TicketId required MatchmakingIdStringModel
Output
- output StopMatchmakingOutput
UpdateAlias
amazonaws_gamelift.UpdateAlias({
"AliasId": ""
}, context)
Input
- input
object
- AliasId required AliasId
- Description NonZeroAndMaxString
- Name NonBlankAndLengthConstraintString
- RoutingStrategy RoutingStrategy
Output
- output UpdateAliasOutput
UpdateBuild
amazonaws_gamelift.UpdateBuild({
"BuildId": ""
}, context)
Input
- input
object
- BuildId required BuildId
- Name NonZeroAndMaxString
- Version NonZeroAndMaxString
Output
- output UpdateBuildOutput
UpdateFleetAttributes
amazonaws_gamelift.UpdateFleetAttributes({
"FleetId": ""
}, context)
Input
- input
object
- Description NonZeroAndMaxString
- FleetId required FleetId
- MetricGroups MetricGroupList
- Name NonZeroAndMaxString
- NewGameSessionProtectionPolicy ProtectionPolicy
- ResourceCreationLimitPolicy ResourceCreationLimitPolicy
Output
- output UpdateFleetAttributesOutput
UpdateFleetCapacity
amazonaws_gamelift.UpdateFleetCapacity({
"FleetId": ""
}, context)
Input
- input
object
- DesiredInstances WholeNumber
- FleetId required FleetId
- MaxSize WholeNumber
- MinSize WholeNumber
Output
- output UpdateFleetCapacityOutput
UpdateFleetPortSettings
amazonaws_gamelift.UpdateFleetPortSettings({
"FleetId": ""
}, context)
Input
- input
object
- FleetId required FleetId
- InboundPermissionAuthorizations IpPermissionsList
- InboundPermissionRevocations IpPermissionsList
Output
UpdateGameSession
amazonaws_gamelift.UpdateGameSession({
"GameSessionId": ""
}, context)
Input
- input
object
- GameSessionId required ArnStringModel
- MaximumPlayerSessionCount WholeNumber
- Name NonZeroAndMaxString
- PlayerSessionCreationPolicy PlayerSessionCreationPolicy
- ProtectionPolicy ProtectionPolicy
Output
- output UpdateGameSessionOutput
UpdateGameSessionQueue
amazonaws_gamelift.UpdateGameSessionQueue({
"Name": ""
}, context)
Input
- input
object
- Destinations GameSessionQueueDestinationList
- Name required GameSessionQueueName
- PlayerLatencyPolicies PlayerLatencyPolicyList
- TimeoutInSeconds WholeNumber
Output
- output UpdateGameSessionQueueOutput
UpdateMatchmakingConfiguration
amazonaws_gamelift.UpdateMatchmakingConfiguration({
"Name": ""
}, context)
Input
- input
object
- AcceptanceRequired BooleanModel
- AcceptanceTimeoutSeconds MatchmakingAcceptanceTimeoutInteger
- AdditionalPlayerCount WholeNumber
- CustomEventData CustomEventData
- Description NonZeroAndMaxString
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionQueueArns QueueArnsList
- Name required MatchmakingIdStringModel
- NotificationTarget SnsArnStringModel
- RequestTimeoutSeconds MatchmakingRequestTimeoutInteger
- RuleSetName MatchmakingIdStringModel
Output
UpdateRuntimeConfiguration
amazonaws_gamelift.UpdateRuntimeConfiguration({
"FleetId": "",
"RuntimeConfiguration": {}
}, context)
Input
- input
object
- FleetId required FleetId
- RuntimeConfiguration required RuntimeConfiguration
Output
ValidateMatchmakingRuleSet
amazonaws_gamelift.ValidateMatchmakingRuleSet({
"RuleSetBody": ""
}, context)
Input
- input
object
- RuleSetBody required RuleSetBody
Output
Definitions
AcceptMatchInput
- AcceptMatchInput
object
: Represents the input for a request action.- AcceptanceType required AcceptanceType
- PlayerIds required StringList
- TicketId required MatchmakingIdStringModel
AcceptMatchOutput
- AcceptMatchOutput
object
AcceptanceType
- AcceptanceType
string
(values: ACCEPT, REJECT)
Alias
- Alias
object
:Properties describing a fleet alias.
Alias-related operations include:
-
CreateAlias
-
ListAliases
-
DescribeAlias
-
UpdateAlias
-
DeleteAlias
-
ResolveAlias
- AliasArn ArnStringModel
- AliasId AliasId
- CreationTime Timestamp
- Description FreeText
- LastUpdatedTime Timestamp
- Name NonBlankAndLengthConstraintString
- RoutingStrategy RoutingStrategy
-
AliasId
- AliasId
string
AliasList
- AliasList
array
- items Alias
ArnStringModel
- ArnStringModel
string
AttributeValue
- AttributeValue
object
: Values for use in Player attribute key:value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array or data map. EachAttributeValue
object can use only one of the available properties.- N DoubleObject
- S NonZeroAndMaxString
- SDM StringDoubleMap
- SL StringList
AwsCredentials
- AwsCredentials
object
: Temporary access credentials used for uploading game build files to Amazon GameLift. They are valid for a limited time. If they expire before you upload your game build, get a new set by calling RequestUploadCredentials.- AccessKeyId NonEmptyString
- SecretAccessKey NonEmptyString
- SessionToken NonEmptyString
BooleanModel
- BooleanModel
boolean
Build
- Build
object
:Properties describing a game build.
Build-related operations include:
-
CreateBuild
-
ListBuilds
-
DescribeBuild
-
UpdateBuild
-
DeleteBuild
- BuildId BuildId
- CreationTime Timestamp
- Name FreeText
- OperatingSystem OperatingSystem
- SizeOnDisk PositiveLong
- Status BuildStatus
- Version FreeText
-
BuildId
- BuildId
string
BuildList
- BuildList
array
- items Build
BuildStatus
- BuildStatus
string
(values: INITIALIZED, READY, FAILED)
ComparisonOperatorType
- ComparisonOperatorType
string
(values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold)
ConflictException
- ConflictException
object
: The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.- Message NonEmptyString
CreateAliasInput
- CreateAliasInput
object
: Represents the input for a request action.- Description NonZeroAndMaxString
- Name required NonBlankAndLengthConstraintString
- RoutingStrategy required RoutingStrategy
CreateAliasOutput
- CreateAliasOutput
object
: Represents the returned data in response to a request action.- Alias Alias
CreateBuildInput
- CreateBuildInput
object
: Represents the input for a request action.- Name NonZeroAndMaxString
- OperatingSystem OperatingSystem
- StorageLocation S3Location
- Version NonZeroAndMaxString
CreateBuildOutput
- CreateBuildOutput
object
: Represents the returned data in response to a request action.- Build Build
- StorageLocation S3Location
- UploadCredentials AwsCredentials
CreateFleetInput
- CreateFleetInput
object
: Represents the input for a request action.- BuildId required BuildId
- Description NonZeroAndMaxString
- EC2InboundPermissions IpPermissionsList
- EC2InstanceType required EC2InstanceType
- FleetType FleetType
- LogPaths StringList
- MetricGroups MetricGroupList
- Name required NonZeroAndMaxString
- NewGameSessionProtectionPolicy ProtectionPolicy
- PeerVpcAwsAccountId NonZeroAndMaxString
- PeerVpcId NonZeroAndMaxString
- ResourceCreationLimitPolicy ResourceCreationLimitPolicy
- RuntimeConfiguration RuntimeConfiguration
- ServerLaunchParameters NonZeroAndMaxString
- ServerLaunchPath NonZeroAndMaxString
CreateFleetOutput
- CreateFleetOutput
object
: Represents the returned data in response to a request action.- FleetAttributes FleetAttributes
CreateGameSessionInput
- CreateGameSessionInput
object
: Represents the input for a request action.- AliasId AliasId
- CreatorId NonZeroAndMaxString
- FleetId FleetId
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionId IdStringModel
- IdempotencyToken IdStringModel
- MaximumPlayerSessionCount required WholeNumber
- Name NonZeroAndMaxString
CreateGameSessionOutput
- CreateGameSessionOutput
object
: Represents the returned data in response to a request action.- GameSession GameSession
CreateGameSessionQueueInput
- CreateGameSessionQueueInput
object
: Represents the input for a request action.- Destinations GameSessionQueueDestinationList
- Name required GameSessionQueueName
- PlayerLatencyPolicies PlayerLatencyPolicyList
- TimeoutInSeconds WholeNumber
CreateGameSessionQueueOutput
- CreateGameSessionQueueOutput
object
: Represents the returned data in response to a request action.- GameSessionQueue GameSessionQueue
CreateMatchmakingConfigurationInput
- CreateMatchmakingConfigurationInput
object
: Represents the input for a request action.- AcceptanceRequired required BooleanModel
- AcceptanceTimeoutSeconds MatchmakingAcceptanceTimeoutInteger
- AdditionalPlayerCount WholeNumber
- CustomEventData CustomEventData
- Description NonZeroAndMaxString
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionQueueArns required QueueArnsList
- Name required MatchmakingIdStringModel
- NotificationTarget SnsArnStringModel
- RequestTimeoutSeconds required MatchmakingRequestTimeoutInteger
- RuleSetName required MatchmakingIdStringModel
CreateMatchmakingConfigurationOutput
- CreateMatchmakingConfigurationOutput
object
: Represents the returned data in response to a request action.- Configuration MatchmakingConfiguration
CreateMatchmakingRuleSetInput
- CreateMatchmakingRuleSetInput
object
: Represents the input for a request action.- Name required MatchmakingIdStringModel
- RuleSetBody required RuleSetBody
CreateMatchmakingRuleSetOutput
- CreateMatchmakingRuleSetOutput
object
: Represents the returned data in response to a request action.- RuleSet required MatchmakingRuleSet
CreatePlayerSessionInput
- CreatePlayerSessionInput
object
: Represents the input for a request action.- GameSessionId required ArnStringModel
- PlayerData PlayerData
- PlayerId required NonZeroAndMaxString
CreatePlayerSessionOutput
- CreatePlayerSessionOutput
object
: Represents the returned data in response to a request action.- PlayerSession PlayerSession
CreatePlayerSessionsInput
- CreatePlayerSessionsInput
object
: Represents the input for a request action.- GameSessionId required ArnStringModel
- PlayerDataMap PlayerDataMap
- PlayerIds required PlayerIdList
CreatePlayerSessionsOutput
- CreatePlayerSessionsOutput
object
: Represents the returned data in response to a request action.- PlayerSessions PlayerSessionList
CreateVpcPeeringAuthorizationInput
- CreateVpcPeeringAuthorizationInput
object
: Represents the input for a request action.- GameLiftAwsAccountId required NonZeroAndMaxString
- PeerVpcId required NonZeroAndMaxString
CreateVpcPeeringAuthorizationOutput
- CreateVpcPeeringAuthorizationOutput
object
: Represents the returned data in response to a request action.- VpcPeeringAuthorization VpcPeeringAuthorization
CreateVpcPeeringConnectionInput
- CreateVpcPeeringConnectionInput
object
: Represents the input for a request action.- FleetId required FleetId
- PeerVpcAwsAccountId required NonZeroAndMaxString
- PeerVpcId required NonZeroAndMaxString
CreateVpcPeeringConnectionOutput
- CreateVpcPeeringConnectionOutput
object
CustomEventData
- CustomEventData
string
DeleteAliasInput
- DeleteAliasInput
object
: Represents the input for a request action.- AliasId required AliasId
DeleteBuildInput
- DeleteBuildInput
object
: Represents the input for a request action.- BuildId required BuildId
DeleteFleetInput
- DeleteFleetInput
object
: Represents the input for a request action.- FleetId required FleetId
DeleteGameSessionQueueInput
- DeleteGameSessionQueueInput
object
: Represents the input for a request action.- Name required GameSessionQueueName
DeleteGameSessionQueueOutput
- DeleteGameSessionQueueOutput
object
DeleteMatchmakingConfigurationInput
- DeleteMatchmakingConfigurationInput
object
: Represents the input for a request action.- Name required MatchmakingIdStringModel
DeleteMatchmakingConfigurationOutput
- DeleteMatchmakingConfigurationOutput
object
DeleteScalingPolicyInput
- DeleteScalingPolicyInput
object
: Represents the input for a request action.- FleetId required FleetId
- Name required NonZeroAndMaxString
DeleteVpcPeeringAuthorizationInput
- DeleteVpcPeeringAuthorizationInput
object
: Represents the input for a request action.- GameLiftAwsAccountId required NonZeroAndMaxString
- PeerVpcId required NonZeroAndMaxString
DeleteVpcPeeringAuthorizationOutput
- DeleteVpcPeeringAuthorizationOutput
object
DeleteVpcPeeringConnectionInput
- DeleteVpcPeeringConnectionInput
object
: Represents the input for a request action.- FleetId required FleetId
- VpcPeeringConnectionId required NonZeroAndMaxString
DeleteVpcPeeringConnectionOutput
- DeleteVpcPeeringConnectionOutput
object
DescribeAliasInput
- DescribeAliasInput
object
: Represents the input for a request action.- AliasId required AliasId
DescribeAliasOutput
- DescribeAliasOutput
object
: Represents the returned data in response to a request action.- Alias Alias
DescribeBuildInput
- DescribeBuildInput
object
: Represents the input for a request action.- BuildId required BuildId
DescribeBuildOutput
- DescribeBuildOutput
object
: Represents the returned data in response to a request action.- Build Build
DescribeEC2InstanceLimitsInput
- DescribeEC2InstanceLimitsInput
object
: Represents the input for a request action.- EC2InstanceType EC2InstanceType
DescribeEC2InstanceLimitsOutput
- DescribeEC2InstanceLimitsOutput
object
: Represents the returned data in response to a request action.- EC2InstanceLimits EC2InstanceLimitList
DescribeFleetAttributesInput
- DescribeFleetAttributesInput
object
: Represents the input for a request action.- FleetIds FleetIdList
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
DescribeFleetAttributesOutput
- DescribeFleetAttributesOutput
object
: Represents the returned data in response to a request action.- FleetAttributes FleetAttributesList
- NextToken NonZeroAndMaxString
DescribeFleetCapacityInput
- DescribeFleetCapacityInput
object
: Represents the input for a request action.- FleetIds FleetIdList
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
DescribeFleetCapacityOutput
- DescribeFleetCapacityOutput
object
: Represents the returned data in response to a request action.- FleetCapacity FleetCapacityList
- NextToken NonZeroAndMaxString
DescribeFleetEventsInput
- DescribeFleetEventsInput
object
: Represents the input for a request action.- EndTime Timestamp
- FleetId required FleetId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StartTime Timestamp
DescribeFleetEventsOutput
- DescribeFleetEventsOutput
object
: Represents the returned data in response to a request action.- Events EventList
- NextToken NonZeroAndMaxString
DescribeFleetPortSettingsInput
- DescribeFleetPortSettingsInput
object
: Represents the input for a request action.- FleetId required FleetId
DescribeFleetPortSettingsOutput
- DescribeFleetPortSettingsOutput
object
: Represents the returned data in response to a request action.- InboundPermissions IpPermissionsList
DescribeFleetUtilizationInput
- DescribeFleetUtilizationInput
object
: Represents the input for a request action.- FleetIds FleetIdList
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
DescribeFleetUtilizationOutput
- DescribeFleetUtilizationOutput
object
: Represents the returned data in response to a request action.- FleetUtilization FleetUtilizationList
- NextToken NonZeroAndMaxString
DescribeGameSessionDetailsInput
- DescribeGameSessionDetailsInput
object
: Represents the input for a request action.- AliasId AliasId
- FleetId FleetId
- GameSessionId ArnStringModel
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StatusFilter NonZeroAndMaxString
DescribeGameSessionDetailsOutput
- DescribeGameSessionDetailsOutput
object
: Represents the returned data in response to a request action.- GameSessionDetails GameSessionDetailList
- NextToken NonZeroAndMaxString
DescribeGameSessionPlacementInput
- DescribeGameSessionPlacementInput
object
: Represents the input for a request action.- PlacementId required IdStringModel
DescribeGameSessionPlacementOutput
- DescribeGameSessionPlacementOutput
object
: Represents the returned data in response to a request action.- GameSessionPlacement GameSessionPlacement
DescribeGameSessionQueuesInput
- DescribeGameSessionQueuesInput
object
: Represents the input for a request action.- Limit PositiveInteger
- Names GameSessionQueueNameList
- NextToken NonZeroAndMaxString
DescribeGameSessionQueuesOutput
- DescribeGameSessionQueuesOutput
object
: Represents the returned data in response to a request action.- GameSessionQueues GameSessionQueueList
- NextToken NonZeroAndMaxString
DescribeGameSessionsInput
- DescribeGameSessionsInput
object
: Represents the input for a request action.- AliasId AliasId
- FleetId FleetId
- GameSessionId ArnStringModel
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StatusFilter NonZeroAndMaxString
DescribeGameSessionsOutput
- DescribeGameSessionsOutput
object
: Represents the returned data in response to a request action.- GameSessions GameSessionList
- NextToken NonZeroAndMaxString
DescribeInstancesInput
- DescribeInstancesInput
object
: Represents the input for a request action.- FleetId required FleetId
- InstanceId InstanceId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
DescribeInstancesOutput
- DescribeInstancesOutput
object
: Represents the returned data in response to a request action.- Instances InstanceList
- NextToken NonZeroAndMaxString
DescribeMatchmakingConfigurationsInput
- DescribeMatchmakingConfigurationsInput
object
: Represents the input for a request action.- Limit PositiveInteger
- Names MatchmakingIdList
- NextToken NonZeroAndMaxString
- RuleSetName MatchmakingIdStringModel
DescribeMatchmakingConfigurationsOutput
- DescribeMatchmakingConfigurationsOutput
object
: Represents the returned data in response to a request action.- Configurations MatchmakingConfigurationList
- NextToken NonZeroAndMaxString
DescribeMatchmakingInput
- DescribeMatchmakingInput
object
: Represents the input for a request action.- TicketIds required MatchmakingIdList
DescribeMatchmakingOutput
- DescribeMatchmakingOutput
object
: Represents the returned data in response to a request action.- TicketList MatchmakingTicketList
DescribeMatchmakingRuleSetsInput
- DescribeMatchmakingRuleSetsInput
object
: Represents the input for a request action.- Limit RuleSetLimit
- Names MatchmakingRuleSetNameList
- NextToken NonZeroAndMaxString
DescribeMatchmakingRuleSetsOutput
- DescribeMatchmakingRuleSetsOutput
object
: Represents the returned data in response to a request action.- NextToken NonZeroAndMaxString
- RuleSets required MatchmakingRuleSetList
DescribePlayerSessionsInput
- DescribePlayerSessionsInput
object
: Represents the input for a request action.- GameSessionId ArnStringModel
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- PlayerId NonZeroAndMaxString
- PlayerSessionId PlayerSessionId
- PlayerSessionStatusFilter NonZeroAndMaxString
DescribePlayerSessionsOutput
- DescribePlayerSessionsOutput
object
: Represents the returned data in response to a request action.- NextToken NonZeroAndMaxString
- PlayerSessions PlayerSessionList
DescribeRuntimeConfigurationInput
- DescribeRuntimeConfigurationInput
object
: Represents the input for a request action.- FleetId required FleetId
DescribeRuntimeConfigurationOutput
- DescribeRuntimeConfigurationOutput
object
: Represents the returned data in response to a request action.- RuntimeConfiguration RuntimeConfiguration
DescribeScalingPoliciesInput
- DescribeScalingPoliciesInput
object
: Represents the input for a request action.- FleetId required FleetId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- StatusFilter ScalingStatusType
DescribeScalingPoliciesOutput
- DescribeScalingPoliciesOutput
object
: Represents the returned data in response to a request action.- NextToken NonZeroAndMaxString
- ScalingPolicies ScalingPolicyList
DescribeVpcPeeringAuthorizationsInput
- DescribeVpcPeeringAuthorizationsInput
object
DescribeVpcPeeringAuthorizationsOutput
- DescribeVpcPeeringAuthorizationsOutput
object
- VpcPeeringAuthorizations VpcPeeringAuthorizationList
DescribeVpcPeeringConnectionsInput
- DescribeVpcPeeringConnectionsInput
object
: Represents the input for a request action.- FleetId FleetId
DescribeVpcPeeringConnectionsOutput
- DescribeVpcPeeringConnectionsOutput
object
: Represents the returned data in response to a request action.- VpcPeeringConnections VpcPeeringConnectionList
DesiredPlayerSession
- DesiredPlayerSession
object
: Player information for use when creating player sessions using a game session placement request with StartGameSessionPlacement.- PlayerData PlayerData
- PlayerId NonZeroAndMaxString
DesiredPlayerSessionList
- DesiredPlayerSessionList
array
- items DesiredPlayerSession
Double
- Double
number
DoubleObject
- DoubleObject
number
EC2InstanceCounts
- EC2InstanceCounts
object
: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.
Fleet-related operations include:
-
CreateFleet
-
ListFleets
-
Describe fleets:
-
DescribeFleetAttributes
-
DescribeFleetPortSettings
-
DescribeFleetUtilization
-
DescribeRuntimeConfiguration
-
DescribeFleetEvents
-
-
Update fleets:
-
UpdateFleetAttributes
-
UpdateFleetCapacity
-
UpdateFleetPortSettings
-
UpdateRuntimeConfiguration
-
-
Manage fleet capacity:
-
DescribeFleetCapacity
-
UpdateFleetCapacity
-
PutScalingPolicy (automatic scaling)
-
DescribeScalingPolicies (automatic scaling)
-
DeleteScalingPolicy (automatic scaling)
-
DescribeEC2InstanceLimits
-
-
DeleteFleet
- ACTIVE WholeNumber
- DESIRED WholeNumber
- IDLE WholeNumber
- MAXIMUM WholeNumber
- MINIMUM WholeNumber
- PENDING WholeNumber
- TERMINATING WholeNumber
-
EC2InstanceLimit
- EC2InstanceLimit
object
: Maximum number of instances allowed based on the Amazon Elastic Compute Cloud (Amazon EC2) instance type. Instance limits can be retrieved by calling DescribeEC2InstanceLimits.- CurrentInstances WholeNumber
- EC2InstanceType EC2InstanceType
- InstanceLimit WholeNumber
EC2InstanceLimitList
- EC2InstanceLimitList
array
- items EC2InstanceLimit
EC2InstanceType
- EC2InstanceType
string
(values: t2.micro, t2.small, t2.medium, t2.large, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, c4.large, c4.xlarge, c4.2xlarge, c4.4xlarge, c4.8xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, r4.large, r4.xlarge, r4.2xlarge, r4.4xlarge, r4.8xlarge, r4.16xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, m4.large, m4.xlarge, m4.2xlarge, m4.4xlarge, m4.10xlarge)
Event
- Event
object
: Log entry describing an event that involves Amazon GameLift resources (such as a fleet). In addition to tracking activity, event codes and messages can provide additional information for troubleshooting and debugging problems.- EventCode EventCode
- EventId NonZeroAndMaxString
- EventTime Timestamp
- Message NonEmptyString
- PreSignedLogUrl NonZeroAndMaxString
- ResourceId NonZeroAndMaxString
EventCode
- EventCode
string
(values: GENERIC_EVENT, FLEET_CREATED, FLEET_DELETED, FLEET_SCALING_EVENT, FLEET_STATE_DOWNLOADING, FLEET_STATE_VALIDATING, FLEET_STATE_BUILDING, FLEET_STATE_ACTIVATING, FLEET_STATE_ACTIVE, FLEET_STATE_ERROR, FLEET_INITIALIZATION_FAILED, FLEET_BINARY_DOWNLOAD_FAILED, FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND, FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE, FLEET_VALIDATION_TIMED_OUT, FLEET_ACTIVATION_FAILED, FLEET_ACTIVATION_FAILED_NO_INSTANCES, FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED, SERVER_PROCESS_INVALID_PATH, SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT, SERVER_PROCESS_PROCESS_READY_TIMEOUT, SERVER_PROCESS_CRASHED, SERVER_PROCESS_TERMINATED_UNHEALTHY, SERVER_PROCESS_FORCE_TERMINATED, SERVER_PROCESS_PROCESS_EXIT_TIMEOUT, GAME_SESSION_ACTIVATION_TIMEOUT, FLEET_CREATION_EXTRACTING_BUILD, FLEET_CREATION_RUNNING_INSTALLER, FLEET_CREATION_VALIDATING_RUNTIME_CONFIG, FLEET_VPC_PEERING_SUCCEEDED, FLEET_VPC_PEERING_FAILED, FLEET_VPC_PEERING_DELETED, INSTANCE_INTERRUPTED)
EventList
- EventList
array
- items Event
FleetAttributes
- FleetAttributes
object
:General properties describing a fleet.
Fleet-related operations include:
-
CreateFleet
-
ListFleets
-
Describe fleets:
-
DescribeFleetAttributes
-
DescribeFleetPortSettings
-
DescribeFleetUtilization
-
DescribeRuntimeConfiguration
-
DescribeFleetEvents
-
-
Update fleets:
-
UpdateFleetAttributes
-
UpdateFleetCapacity
-
UpdateFleetPortSettings
-
UpdateRuntimeConfiguration
-
-
Manage fleet capacity:
-
DescribeFleetCapacity
-
UpdateFleetCapacity
-
PutScalingPolicy (automatic scaling)
-
DescribeScalingPolicies (automatic scaling)
-
DeleteScalingPolicy (automatic scaling)
-
DescribeEC2InstanceLimits
-
-
DeleteFleet
- BuildId BuildId
- CreationTime Timestamp
- Description NonZeroAndMaxString
- FleetArn ArnStringModel
- FleetId FleetId
- FleetType FleetType
- InstanceType EC2InstanceType
- LogPaths StringList
- MetricGroups MetricGroupList
- Name NonZeroAndMaxString
- NewGameSessionProtectionPolicy ProtectionPolicy
- OperatingSystem OperatingSystem
- ResourceCreationLimitPolicy ResourceCreationLimitPolicy
- ServerLaunchParameters NonZeroAndMaxString
- ServerLaunchPath NonZeroAndMaxString
- Status FleetStatus
- TerminationTime Timestamp
-
FleetAttributesList
- FleetAttributesList
array
- items FleetAttributes
FleetCapacity
- FleetCapacity
object
: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.
Fleet-related operations include:
-
CreateFleet
-
ListFleets
-
Describe fleets:
-
DescribeFleetAttributes
-
DescribeFleetPortSettings
-
DescribeFleetUtilization
-
DescribeRuntimeConfiguration
-
DescribeFleetEvents
-
-
Update fleets:
-
UpdateFleetAttributes
-
UpdateFleetCapacity
-
UpdateFleetPortSettings
-
UpdateRuntimeConfiguration
-
-
Manage fleet capacity:
-
DescribeFleetCapacity
-
UpdateFleetCapacity
-
PutScalingPolicy (automatic scaling)
-
DescribeScalingPolicies (automatic scaling)
-
DeleteScalingPolicy (automatic scaling)
-
DescribeEC2InstanceLimits
-
-
DeleteFleet
- FleetId FleetId
- InstanceCounts EC2InstanceCounts
- InstanceType EC2InstanceType
-
FleetCapacityExceededException
- FleetCapacityExceededException
object
: The specified fleet has no available instances to fulfill aCreateGameSession
request. Clients can retry such requests immediately or after a waiting period.- Message NonEmptyString
FleetCapacityList
- FleetCapacityList
array
- items FleetCapacity
FleetId
- FleetId
string
FleetIdList
- FleetIdList
array
- items FleetId
FleetStatus
- FleetStatus
string
(values: NEW, DOWNLOADING, VALIDATING, BUILDING, ACTIVATING, ACTIVE, DELETING, ERROR, TERMINATED)
FleetType
- FleetType
string
(values: ON_DEMAND, SPOT)
FleetUtilization
- FleetUtilization
object
:Current status of fleet utilization, including the number of game and player sessions being hosted.
Fleet-related operations include:
-
CreateFleet
-
ListFleets
-
Describe fleets:
-
DescribeFleetAttributes
-
DescribeFleetPortSettings
-
DescribeFleetUtilization
-
DescribeRuntimeConfiguration
-
DescribeFleetEvents
-
-
Update fleets:
-
UpdateFleetAttributes
-
UpdateFleetCapacity
-
UpdateFleetPortSettings
-
UpdateRuntimeConfiguration
-
-
Manage fleet capacity:
-
DescribeFleetCapacity
-
UpdateFleetCapacity
-
PutScalingPolicy (automatic scaling)
-
DescribeScalingPolicies (automatic scaling)
-
DeleteScalingPolicy (automatic scaling)
-
DescribeEC2InstanceLimits
-
-
DeleteFleet
- ActiveGameSessionCount WholeNumber
- ActiveServerProcessCount WholeNumber
- CurrentPlayerSessionCount WholeNumber
- FleetId FleetId
- MaximumPlayerSessionCount WholeNumber
-
FleetUtilizationList
- FleetUtilizationList
array
- items FleetUtilization
Float
- Float
number
FreeText
- FreeText
string
GameProperty
- GameProperty
object
: Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session, such as to specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session; the server process uses the properties as appropriate. For more information, see the Amazon GameLift Developer Guide.- Key required GamePropertyKey
- Value required GamePropertyValue
GamePropertyKey
- GamePropertyKey
string
GamePropertyList
- GamePropertyList
array
- items GameProperty
GamePropertyValue
- GamePropertyValue
string
GameSession
- GameSession
object
:Properties describing a game session.
A game session in ACTIVE status can host players. When a game session ends, its status is set to
TERMINATED
.Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.
Game-session-related operations include:
-
CreateGameSession
-
DescribeGameSessions
-
DescribeGameSessionDetails
-
SearchGameSessions
-
UpdateGameSession
-
GetGameSessionLogUrl
-
Game session placements
-
StartGameSessionPlacement
-
DescribeGameSessionPlacement
-
StopGameSessionPlacement
-
- CreationTime Timestamp
- CreatorId NonZeroAndMaxString
- CurrentPlayerSessionCount WholeNumber
- FleetId FleetId
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionId NonZeroAndMaxString
- IpAddress IpAddress
- MatchmakerData MatchmakerData
- MaximumPlayerSessionCount WholeNumber
- Name NonZeroAndMaxString
- PlayerSessionCreationPolicy PlayerSessionCreationPolicy
- Port PortNumber
- Status GameSessionStatus
- StatusReason GameSessionStatusReason
- TerminationTime Timestamp
-
GameSessionActivationTimeoutSeconds
- GameSessionActivationTimeoutSeconds
integer
GameSessionConnectionInfo
- GameSessionConnectionInfo
object
: Connection information for the new game session that is created with matchmaking. (with StartMatchmaking). Once a match is set, the FlexMatch engine places the match and creates a new game session for it. This information, including the game session endpoint and player sessions for each player in the original matchmaking request, is added to the MatchmakingTicket, which can be retrieved by calling DescribeMatchmaking.- GameSessionArn ArnStringModel
- IpAddress StringModel
- MatchedPlayerSessions MatchedPlayerSessionList
- Port PositiveInteger
GameSessionData
- GameSessionData
string
GameSessionDetail
- GameSessionDetail
object
: A game session's properties plus the protection policy currently in force.- GameSession GameSession
- ProtectionPolicy ProtectionPolicy
GameSessionDetailList
- GameSessionDetailList
array
- items GameSessionDetail
GameSessionFullException
- GameSessionFullException
object
: The game instance is currently full and cannot allow the requested player(s) to join. Clients can retry such requests immediately or after a waiting period.- Message NonEmptyString
GameSessionList
- GameSessionList
array
- items GameSession
GameSessionPlacement
- GameSessionPlacement
object
:Object that describes a StartGameSessionPlacement request. This object includes the full details of the original request plus the current status and start/end time stamps.
Game session placement-related operations include:
-
StartGameSessionPlacement
-
DescribeGameSessionPlacement
-
StopGameSessionPlacement
- EndTime Timestamp
- GameProperties GamePropertyList
- GameSessionArn NonZeroAndMaxString
- GameSessionData GameSessionData
- GameSessionId NonZeroAndMaxString
- GameSessionName NonZeroAndMaxString
- GameSessionQueueName GameSessionQueueName
- GameSessionRegion NonZeroAndMaxString
- IpAddress IpAddress
- MatchmakerData MatchmakerData
- MaximumPlayerSessionCount WholeNumber
- PlacedPlayerSessions PlacedPlayerSessionList
- PlacementId IdStringModel
- PlayerLatencies PlayerLatencyList
- Port PortNumber
- StartTime Timestamp
- Status GameSessionPlacementState
-
GameSessionPlacementState
- GameSessionPlacementState
string
(values: PENDING, FULFILLED, CANCELLED, TIMED_OUT)
GameSessionQueue
- GameSessionQueue
object
:Configuration of a queue that is used to process game session placement requests. The queue configuration identifies several game features:
-
The destinations where a new game session can potentially be hosted. Amazon GameLift tries these destinations in an order based on either the queue's default order or player latency information, if provided in a placement request. With latency information, Amazon GameLift can place game sessions where the majority of players are reporting the lowest possible latency.
-
The length of time that placement requests can wait in the queue before timing out.
-
A set of optional latency policies that protect individual players from high latencies, preventing game sessions from being placed where any individual player is reporting latency higher than a policy's maximum.
Queue-related operations include:
-
CreateGameSessionQueue
-
DescribeGameSessionQueues
-
UpdateGameSessionQueue
-
DeleteGameSessionQueue
- Destinations GameSessionQueueDestinationList
- GameSessionQueueArn ArnStringModel
- Name GameSessionQueueName
- PlayerLatencyPolicies PlayerLatencyPolicyList
- TimeoutInSeconds WholeNumber
-
GameSessionQueueDestination
- GameSessionQueueDestination
object
:Fleet designated in a game session queue. Requests for new game sessions in the queue are fulfilled by starting a new game session on any destination configured for a queue.
Queue-related operations include:
-
CreateGameSessionQueue
-
DescribeGameSessionQueues
-
UpdateGameSessionQueue
-
DeleteGameSessionQueue
- DestinationArn ArnStringModel
-
GameSessionQueueDestinationList
- GameSessionQueueDestinationList
array
GameSessionQueueList
- GameSessionQueueList
array
- items GameSessionQueue
GameSessionQueueName
- GameSessionQueueName
string
GameSessionQueueNameList
- GameSessionQueueNameList
array
- items GameSessionQueueName
GameSessionStatus
- GameSessionStatus
string
(values: ACTIVE, ACTIVATING, TERMINATED, TERMINATING, ERROR)
GameSessionStatusReason
- GameSessionStatusReason
string
(values: INTERRUPTED)
GetGameSessionLogUrlInput
- GetGameSessionLogUrlInput
object
: Represents the input for a request action.- GameSessionId required ArnStringModel
GetGameSessionLogUrlOutput
- GetGameSessionLogUrlOutput
object
: Represents the returned data in response to a request action.- PreSignedUrl NonZeroAndMaxString
GetInstanceAccessInput
- GetInstanceAccessInput
object
: Represents the input for a request action.- FleetId required FleetId
- InstanceId required InstanceId
GetInstanceAccessOutput
- GetInstanceAccessOutput
object
: Represents the returned data in response to a request action.- InstanceAccess InstanceAccess
IdStringModel
- IdStringModel
string
IdempotentParameterMismatchException
- IdempotentParameterMismatchException
object
: A game session with this custom ID string already exists in this fleet. Resolve this conflict before retrying this request.- Message NonEmptyString
Instance
- Instance
object
: Properties that describe an instance of a virtual computing resource that hosts one or more game servers. A fleet may contain zero or more instances.- CreationTime Timestamp
- FleetId FleetId
- InstanceId InstanceId
- IpAddress IpAddress
- OperatingSystem OperatingSystem
- Status InstanceStatus
- Type EC2InstanceType
InstanceAccess
- InstanceAccess
object
: Information required to remotely connect to a fleet instance. Access is requested by calling GetInstanceAccess.- Credentials InstanceCredentials
- FleetId FleetId
- InstanceId InstanceId
- IpAddress IpAddress
- OperatingSystem OperatingSystem
InstanceCredentials
- InstanceCredentials
object
: Set of credentials required to remotely access a fleet instance. Access credentials are requested by calling GetInstanceAccess and returned in an InstanceAccess object.- Secret NonEmptyString
- UserName NonEmptyString
InstanceId
- InstanceId
string
InstanceList
- InstanceList
array
- items Instance
InstanceStatus
- InstanceStatus
string
(values: PENDING, ACTIVE, TERMINATING)
Integer
- Integer
integer
InternalServiceException
- InternalServiceException
object
: The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.- Message NonEmptyString
InvalidFleetStatusException
- InvalidFleetStatusException
object
: The requested operation would cause a conflict with the current state of a resource associated with the request and/or the fleet. Resolve the conflict before retrying.- Message NonEmptyString
InvalidGameSessionStatusException
- InvalidGameSessionStatusException
object
: The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Resolve the conflict before retrying.- Message NonEmptyString
InvalidRequestException
- InvalidRequestException
object
: One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.- Message NonEmptyString
IpAddress
- IpAddress
string
IpPermission
- IpPermission
object
: A range of IP addresses and port settings that allow inbound traffic to connect to server processes on Amazon GameLift. Each game session hosted on a fleet is assigned a unique combination of IP address and port number, which must fall into the fleet's allowed ranges. This combination is included in the GameSession object.- FromPort required PortNumber
- IpRange required NonBlankString
- Protocol required IpProtocol
- ToPort required PortNumber
IpPermissionsList
- IpPermissionsList
array
- items IpPermission
IpProtocol
- IpProtocol
string
(values: TCP, UDP)
LatencyMap
- LatencyMap
array
- items
object
- key NonEmptyString
- value PositiveInteger
- items
LimitExceededException
- LimitExceededException
object
: The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.- Message NonEmptyString
ListAliasesInput
- ListAliasesInput
object
: Represents the input for a request action.- Limit PositiveInteger
- Name NonEmptyString
- NextToken NonEmptyString
- RoutingStrategyType RoutingStrategyType
ListAliasesOutput
- ListAliasesOutput
object
: Represents the returned data in response to a request action.- Aliases AliasList
- NextToken NonEmptyString
ListBuildsInput
- ListBuildsInput
object
: Represents the input for a request action.- Limit PositiveInteger
- NextToken NonEmptyString
- Status BuildStatus
ListBuildsOutput
- ListBuildsOutput
object
: Represents the returned data in response to a request action.- Builds BuildList
- NextToken NonEmptyString
ListFleetsInput
- ListFleetsInput
object
: Represents the input for a request action.- BuildId BuildId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
ListFleetsOutput
- ListFleetsOutput
object
: Represents the returned data in response to a request action.- FleetIds FleetIdList
- NextToken NonZeroAndMaxString
MatchedPlayerSession
- MatchedPlayerSession
object
:Represents a new player session that is created as a result of a successful FlexMatch match. A successful match automatically creates new player sessions for every player ID in the original matchmaking request.
When players connect to the match's game session, they must include both player ID and player session ID in order to claim their assigned player slot.
- PlayerId NonZeroAndMaxString
- PlayerSessionId PlayerSessionId
MatchedPlayerSessionList
- MatchedPlayerSessionList
array
- items MatchedPlayerSession
MatchmakerData
- MatchmakerData
string
MatchmakingAcceptanceTimeoutInteger
- MatchmakingAcceptanceTimeoutInteger
integer
MatchmakingConfiguration
- MatchmakingConfiguration
object
: Guidelines for use with FlexMatch to match players into games. All matchmaking requests must specify a matchmaking configuration.- AcceptanceRequired BooleanModel
- AcceptanceTimeoutSeconds MatchmakingAcceptanceTimeoutInteger
- AdditionalPlayerCount WholeNumber
- CreationTime Timestamp
- CustomEventData CustomEventData
- Description NonZeroAndMaxString
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionQueueArns QueueArnsList
- Name MatchmakingIdStringModel
- NotificationTarget SnsArnStringModel
- RequestTimeoutSeconds MatchmakingRequestTimeoutInteger
- RuleSetName MatchmakingIdStringModel
MatchmakingConfigurationList
- MatchmakingConfigurationList
array
- items MatchmakingConfiguration
MatchmakingConfigurationStatus
- MatchmakingConfigurationStatus
string
(values: CANCELLED, COMPLETED, FAILED, PLACING, QUEUED, REQUIRES_ACCEPTANCE, SEARCHING, TIMED_OUT)
MatchmakingIdList
- MatchmakingIdList
array
- items MatchmakingIdStringModel
MatchmakingIdStringModel
- MatchmakingIdStringModel
string
MatchmakingRequestTimeoutInteger
- MatchmakingRequestTimeoutInteger
integer
MatchmakingRuleSet
- MatchmakingRuleSet
object
:Set of rule statements, used with FlexMatch, that determine how to build a certain kind of player match. Each rule set describes a type of group to be created and defines the parameters for acceptable player matches. Rule sets are used in MatchmakingConfiguration objects.
A rule set may define the following elements for a match. For detailed information and examples showing how to construct a rule set, see Build a FlexMatch Rule Set.
-
Teams -- Required. A rule set must define one or multiple teams for the match and set minimum and maximum team sizes. For example, a rule set might describe a 4x4 match that requires all eight slots to be filled.
-
Player attributes -- Optional. These attributes specify a set of player characteristics to evaluate when looking for a match. Matchmaking requests that use a rule set with player attributes must provide the corresponding attribute values. For example, an attribute might specify a player's skill or level.
-
Rules -- Optional. Rules define how to evaluate potential players for a match based on player attributes. A rule might specify minimum requirements for individual players, teams, or entire matches. For example, a rule might require each player to meet a certain skill level, each team to have at least one player in a certain role, or the match to have a minimum average skill level. or may describe an entire group--such as all teams must be evenly matched or have at least one player in a certain role.
-
Expansions -- Optional. Expansions allow you to relax the rules after a period of time when no acceptable matches are found. This feature lets you balance getting players into games in a reasonable amount of time instead of making them wait indefinitely for the best possible match. For example, you might use an expansion to increase the maximum skill variance between players after 30 seconds.
- CreationTime Timestamp
- RuleSetBody required RuleSetBody
- RuleSetName MatchmakingIdStringModel
-
MatchmakingRuleSetList
- MatchmakingRuleSetList
array
- items MatchmakingRuleSet
MatchmakingRuleSetNameList
- MatchmakingRuleSetNameList
array
- items MatchmakingIdStringModel
MatchmakingTicket
- MatchmakingTicket
object
: Ticket generated to track the progress of a matchmaking request. Each ticket is uniquely identified by a ticket ID, supplied by the requester, when creating a matchmaking request with StartMatchmaking. Tickets can be retrieved by calling DescribeMatchmaking with the ticket ID.- ConfigurationName MatchmakingIdStringModel
- EndTime Timestamp
- EstimatedWaitTime WholeNumber
- GameSessionConnectionInfo GameSessionConnectionInfo
- Players PlayerList
- StartTime Timestamp
- Status MatchmakingConfigurationStatus
- StatusMessage StringModel
- StatusReason StringModel
- TicketId MatchmakingIdStringModel
MatchmakingTicketList
- MatchmakingTicketList
array
- items MatchmakingTicket
MaxConcurrentGameSessionActivations
- MaxConcurrentGameSessionActivations
integer
MetricGroup
- MetricGroup
string
MetricGroupList
- MetricGroupList
array
- items MetricGroup
MetricName
- MetricName
string
(values: ActivatingGameSessions, ActiveGameSessions, ActiveInstances, AvailableGameSessions, AvailablePlayerSessions, CurrentPlayerSessions, IdleInstances, PercentAvailableGameSessions, PercentIdleInstances, QueueDepth, WaitTime)
NonBlankAndLengthConstraintString
- NonBlankAndLengthConstraintString
string
NonBlankString
- NonBlankString
string
NonEmptyString
- NonEmptyString
string
NonZeroAndMaxString
- NonZeroAndMaxString
string
NotFoundException
- NotFoundException
object
: A service resource associated with the request could not be found. Clients should not retry such requests.- Message NonEmptyString
OperatingSystem
- OperatingSystem
string
(values: WINDOWS_2012, AMAZON_LINUX)
PlacedPlayerSession
- PlacedPlayerSession
object
:Information about a player session that was created as part of a StartGameSessionPlacement request. This object contains only the player ID and player session ID. To retrieve full details on a player session, call DescribePlayerSessions with the player session ID.
Player-session-related operations include:
-
CreatePlayerSession
-
CreatePlayerSessions
-
DescribePlayerSessions
-
Game session placements
-
StartGameSessionPlacement
-
DescribeGameSessionPlacement
-
StopGameSessionPlacement
-
- PlayerId NonZeroAndMaxString
- PlayerSessionId PlayerSessionId
-
PlacedPlayerSessionList
- PlacedPlayerSessionList
array
- items PlacedPlayerSession
Player
- Player
object
: Represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and may have latency data. Team information is added after a match has been successfully completed.- LatencyInMs LatencyMap
- PlayerAttributes PlayerAttributeMap
- PlayerId NonZeroAndMaxString
- Team NonZeroAndMaxString
PlayerAttributeMap
- PlayerAttributeMap
array
- items
object
- key NonZeroAndMaxString
- value AttributeValue
- items
PlayerData
- PlayerData
string
PlayerDataMap
- PlayerDataMap
array
- items
object
- key NonZeroAndMaxString
- value PlayerData
- items
PlayerIdList
- PlayerIdList
array
- items NonZeroAndMaxString
PlayerLatency
- PlayerLatency
object
: Regional latency information for a player, used when requesting a new game session with StartGameSessionPlacement. This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified region. The relative difference between a player's latency values for multiple regions are used to determine which fleets are best suited to place a new game session for the player.- LatencyInMilliseconds Float
- PlayerId NonZeroAndMaxString
- RegionIdentifier NonZeroAndMaxString
PlayerLatencyList
- PlayerLatencyList
array
- items PlayerLatency
PlayerLatencyPolicy
- PlayerLatencyPolicy
object
:Queue setting that determines the highest latency allowed for individual players when placing a game session. When a latency policy is in force, a game session cannot be placed at any destination in a region where a player is reporting latency higher than the cap. Latency policies are only enforced when the placement request contains player latency information.
Queue-related operations include:
-
CreateGameSessionQueue
-
DescribeGameSessionQueues
-
UpdateGameSessionQueue
-
DeleteGameSessionQueue
- MaximumIndividualPlayerLatencyMilliseconds WholeNumber
- PolicyDurationSeconds WholeNumber
-
PlayerLatencyPolicyList
- PlayerLatencyPolicyList
array
- items PlayerLatencyPolicy
PlayerList
- PlayerList
array
- items Player
PlayerSession
- PlayerSession
object
:Properties describing a player session. Player session objects are created either by creating a player session for a specific game session, or as part of a game session placement. A player session represents either a player reservation for a game session (status
RESERVED
) or actual player activity in a game session (statusACTIVE
). A player session object (including player data) is automatically passed to a game session when the player connects to the game session and is validated.When a player disconnects, the player session status changes to
COMPLETED
. Once the session ends, the player session object is retained for 30 days and then removed.Player-session-related operations include:
-
CreatePlayerSession
-
CreatePlayerSessions
-
DescribePlayerSessions
-
Game session placements
-
StartGameSessionPlacement
-
DescribeGameSessionPlacement
-
StopGameSessionPlacement
-
- CreationTime Timestamp
- FleetId FleetId
- GameSessionId NonZeroAndMaxString
- IpAddress IpAddress
- PlayerData PlayerData
- PlayerId NonZeroAndMaxString
- PlayerSessionId PlayerSessionId
- Port PortNumber
- Status PlayerSessionStatus
- TerminationTime Timestamp
-
PlayerSessionCreationPolicy
- PlayerSessionCreationPolicy
string
(values: ACCEPT_ALL, DENY_ALL)
PlayerSessionId
- PlayerSessionId
string
PlayerSessionList
- PlayerSessionList
array
- items PlayerSession
PlayerSessionStatus
- PlayerSessionStatus
string
(values: RESERVED, ACTIVE, COMPLETED, TIMEDOUT)
PortNumber
- PortNumber
integer
PositiveInteger
- PositiveInteger
integer
PositiveLong
- PositiveLong
integer
ProtectionPolicy
- ProtectionPolicy
string
(values: NoProtection, FullProtection)
PutScalingPolicyInput
- PutScalingPolicyInput
object
: Represents the input for a request action.- ComparisonOperator required ComparisonOperatorType
- EvaluationPeriods required PositiveInteger
- FleetId required FleetId
- MetricName required MetricName
- Name required NonZeroAndMaxString
- ScalingAdjustment required Integer
- ScalingAdjustmentType required ScalingAdjustmentType
- Threshold required Double
PutScalingPolicyOutput
- PutScalingPolicyOutput
object
: Represents the returned data in response to a request action.- Name NonZeroAndMaxString
QueueArnsList
- QueueArnsList
array
- items ArnStringModel
RequestUploadCredentialsInput
- RequestUploadCredentialsInput
object
: Represents the input for a request action.- BuildId required BuildId
RequestUploadCredentialsOutput
- RequestUploadCredentialsOutput
object
: Represents the returned data in response to a request action.- StorageLocation S3Location
- UploadCredentials AwsCredentials
ResolveAliasInput
- ResolveAliasInput
object
: Represents the input for a request action.- AliasId required AliasId
ResolveAliasOutput
- ResolveAliasOutput
object
: Represents the returned data in response to a request action.- FleetId FleetId
ResourceCreationLimitPolicy
- ResourceCreationLimitPolicy
object
:Policy that limits the number of game sessions a player can create on the same fleet. This optional policy gives game owners control over how players can consume available game server resources. A resource creation policy makes the following statement: "An individual player can create a maximum number of new game sessions within a specified time period".
The policy is evaluated when a player tries to create a new game session. For example, with a policy of 10 new game sessions and a time period of 60 minutes, on receiving a
CreateGameSession
request, Amazon GameLift checks that the player (identified byCreatorId
) has created fewer than 10 game sessions in the past 60 minutes.- NewGameSessionsPerCreator WholeNumber
- PolicyPeriodInMinutes WholeNumber
RoutingStrategy
- RoutingStrategy
object
:Routing configuration for a fleet alias.
Fleet-related operations include:
-
CreateFleet
-
ListFleets
-
Describe fleets:
-
DescribeFleetAttributes
-
DescribeFleetPortSettings
-
DescribeFleetUtilization
-
DescribeRuntimeConfiguration
-
DescribeFleetEvents
-
-
Update fleets:
-
UpdateFleetAttributes
-
UpdateFleetCapacity
-
UpdateFleetPortSettings
-
UpdateRuntimeConfiguration
-
-
Manage fleet capacity:
-
DescribeFleetCapacity
-
UpdateFleetCapacity
-
PutScalingPolicy (automatic scaling)
-
DescribeScalingPolicies (automatic scaling)
-
DeleteScalingPolicy (automatic scaling)
-
DescribeEC2InstanceLimits
-
-
DeleteFleet
- FleetId FleetId
- Message FreeText
- Type RoutingStrategyType
-
RoutingStrategyType
- RoutingStrategyType
string
(values: SIMPLE, TERMINAL)
RuleSetBody
- RuleSetBody
string
RuleSetLimit
- RuleSetLimit
integer
RuntimeConfiguration
- RuntimeConfiguration
object
:A collection of server process configurations that describe what processes to run on each instance in a fleet. All fleets must have a run-time configuration. Each instance in the fleet launches the server processes specified in the run-time configuration and launches new ones as existing processes end. Each instance regularly checks for an updated run-time configuration and follows the new instructions.
The run-time configuration enables the instances in a fleet to run multiple processes simultaneously. Potential scenarios are as follows: (1) Run multiple processes of a single game server executable to maximize usage of your hosting resources. (2) Run one or more processes of different build executables, such as your game server executable and a related program, or two or more different versions of a game server. (3) Run multiple processes of a single game server but with different launch parameters, for example to run one process on each instance in debug mode.
A Amazon GameLift instance is limited to 50 processes running simultaneously. A run-time configuration must specify fewer than this limit. To calculate the total number of processes specified in a run-time configuration, add the values of the
ConcurrentExecutions
parameter for eachServerProcess
object in the run-time configuration.Fleet-related operations include:
-
CreateFleet
-
ListFleets
-
Describe fleets:
-
DescribeFleetAttributes
-
DescribeFleetPortSettings
-
DescribeFleetUtilization
-
DescribeRuntimeConfiguration
-
DescribeFleetEvents
-
-
Update fleets:
-
UpdateFleetAttributes
-
UpdateFleetCapacity
-
UpdateFleetPortSettings
-
UpdateRuntimeConfiguration
-
-
Manage fleet capacity:
-
DescribeFleetCapacity
-
UpdateFleetCapacity
-
PutScalingPolicy (automatic scaling)
-
DescribeScalingPolicies (automatic scaling)
-
DeleteScalingPolicy (automatic scaling)
-
DescribeEC2InstanceLimits
-
-
DeleteFleet
- GameSessionActivationTimeoutSeconds GameSessionActivationTimeoutSeconds
- MaxConcurrentGameSessionActivations MaxConcurrentGameSessionActivations
- ServerProcesses ServerProcessList
-
S3Location
- S3Location
object
: Location in Amazon Simple Storage Service (Amazon S3) where build files can be stored for access by Amazon GameLift. This location is specified in a CreateBuild request. For more details, see the Create a Build with Files in Amazon S3.- Bucket NonEmptyString
- Key NonEmptyString
- RoleArn NonEmptyString
ScalingAdjustmentType
- ScalingAdjustmentType
string
(values: ChangeInCapacity, ExactCapacity, PercentChangeInCapacity)
ScalingPolicy
- ScalingPolicy
object
:Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
Fleet-related operations include:
-
CreateFleet
-
ListFleets
-
Describe fleets:
-
DescribeFleetAttributes
-
DescribeFleetPortSettings
-
DescribeFleetUtilization
-
DescribeRuntimeConfiguration
-
DescribeFleetEvents
-
-
Update fleets:
-
UpdateFleetAttributes
-
UpdateFleetCapacity
-
UpdateFleetPortSettings
-
UpdateRuntimeConfiguration
-
-
Manage fleet capacity:
-
DescribeFleetCapacity
-
UpdateFleetCapacity
-
PutScalingPolicy (automatic scaling)
-
DescribeScalingPolicies (automatic scaling)
-
DeleteScalingPolicy (automatic scaling)
-
DescribeEC2InstanceLimits
-
-
DeleteFleet
- ComparisonOperator ComparisonOperatorType
- EvaluationPeriods PositiveInteger
- FleetId FleetId
- MetricName MetricName
- Name NonZeroAndMaxString
- ScalingAdjustment Integer
- ScalingAdjustmentType ScalingAdjustmentType
- Status ScalingStatusType
- Threshold Double
-
ScalingPolicyList
- ScalingPolicyList
array
- items ScalingPolicy
ScalingStatusType
- ScalingStatusType
string
(values: ACTIVE, UPDATE_REQUESTED, UPDATING, DELETE_REQUESTED, DELETING, DELETED, ERROR)
SearchGameSessionsInput
- SearchGameSessionsInput
object
: Represents the input for a request action.- AliasId AliasId
- FilterExpression NonZeroAndMaxString
- FleetId FleetId
- Limit PositiveInteger
- NextToken NonZeroAndMaxString
- SortExpression NonZeroAndMaxString
SearchGameSessionsOutput
- SearchGameSessionsOutput
object
: Represents the returned data in response to a request action.- GameSessions GameSessionList
- NextToken NonZeroAndMaxString
ServerProcess
- ServerProcess
object
: A set of instructions for launching server processes on each instance in a fleet. Each instruction set identifies the location of the server executable, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet'sRuntimeConfiguration
.- ConcurrentExecutions required PositiveInteger
- LaunchPath required NonZeroAndMaxString
- Parameters NonZeroAndMaxString
ServerProcessList
- ServerProcessList
array
- items ServerProcess
SnsArnStringModel
- SnsArnStringModel
string
StartGameSessionPlacementInput
- StartGameSessionPlacementInput
object
: Represents the input for a request action.- DesiredPlayerSessions DesiredPlayerSessionList
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionName NonZeroAndMaxString
- GameSessionQueueName required GameSessionQueueName
- MaximumPlayerSessionCount required WholeNumber
- PlacementId required IdStringModel
- PlayerLatencies PlayerLatencyList
StartGameSessionPlacementOutput
- StartGameSessionPlacementOutput
object
: Represents the returned data in response to a request action.- GameSessionPlacement GameSessionPlacement
StartMatchBackfillInput
- StartMatchBackfillInput
object
: Represents the input for a request action.- ConfigurationName required MatchmakingIdStringModel
- GameSessionArn required ArnStringModel
- Players required PlayerList
- TicketId MatchmakingIdStringModel
StartMatchBackfillOutput
- StartMatchBackfillOutput
object
: Represents the returned data in response to a request action.- MatchmakingTicket MatchmakingTicket
StartMatchmakingInput
- StartMatchmakingInput
object
: Represents the input for a request action.- ConfigurationName required MatchmakingIdStringModel
- Players required PlayerList
- TicketId MatchmakingIdStringModel
StartMatchmakingOutput
- StartMatchmakingOutput
object
: Represents the returned data in response to a request action.- MatchmakingTicket MatchmakingTicket
StopGameSessionPlacementInput
- StopGameSessionPlacementInput
object
: Represents the input for a request action.- PlacementId required IdStringModel
StopGameSessionPlacementOutput
- StopGameSessionPlacementOutput
object
: Represents the returned data in response to a request action.- GameSessionPlacement GameSessionPlacement
StopMatchmakingInput
- StopMatchmakingInput
object
: Represents the input for a request action.- TicketId required MatchmakingIdStringModel
StopMatchmakingOutput
- StopMatchmakingOutput
object
StringDoubleMap
- StringDoubleMap
array
- items
object
- key NonZeroAndMaxString
- value DoubleObject
- items
StringList
- StringList
array
- items NonZeroAndMaxString
StringModel
- StringModel
string
TerminalRoutingStrategyException
- TerminalRoutingStrategyException
object
: 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 routing strategy itself. Such requests should only be retried if the routing strategy for the specified alias is modified.- Message NonEmptyString
Timestamp
- Timestamp
string
UnauthorizedException
- UnauthorizedException
object
: The client failed authentication. Clients should not retry such requests.- Message NonEmptyString
UnsupportedRegionException
- UnsupportedRegionException
object
: The requested operation is not supported in the region specified.- Message NonEmptyString
UpdateAliasInput
- UpdateAliasInput
object
: Represents the input for a request action.- AliasId required AliasId
- Description NonZeroAndMaxString
- Name NonBlankAndLengthConstraintString
- RoutingStrategy RoutingStrategy
UpdateAliasOutput
- UpdateAliasOutput
object
: Represents the returned data in response to a request action.- Alias Alias
UpdateBuildInput
- UpdateBuildInput
object
: Represents the input for a request action.- BuildId required BuildId
- Name NonZeroAndMaxString
- Version NonZeroAndMaxString
UpdateBuildOutput
- UpdateBuildOutput
object
: Represents the returned data in response to a request action.- Build Build
UpdateFleetAttributesInput
- UpdateFleetAttributesInput
object
: Represents the input for a request action.- Description NonZeroAndMaxString
- FleetId required FleetId
- MetricGroups MetricGroupList
- Name NonZeroAndMaxString
- NewGameSessionProtectionPolicy ProtectionPolicy
- ResourceCreationLimitPolicy ResourceCreationLimitPolicy
UpdateFleetAttributesOutput
- UpdateFleetAttributesOutput
object
: Represents the returned data in response to a request action.- FleetId FleetId
UpdateFleetCapacityInput
- UpdateFleetCapacityInput
object
: Represents the input for a request action.- DesiredInstances WholeNumber
- FleetId required FleetId
- MaxSize WholeNumber
- MinSize WholeNumber
UpdateFleetCapacityOutput
- UpdateFleetCapacityOutput
object
: Represents the returned data in response to a request action.- FleetId FleetId
UpdateFleetPortSettingsInput
- UpdateFleetPortSettingsInput
object
: Represents the input for a request action.- FleetId required FleetId
- InboundPermissionAuthorizations IpPermissionsList
- InboundPermissionRevocations IpPermissionsList
UpdateFleetPortSettingsOutput
- UpdateFleetPortSettingsOutput
object
: Represents the returned data in response to a request action.- FleetId FleetId
UpdateGameSessionInput
- UpdateGameSessionInput
object
: Represents the input for a request action.- GameSessionId required ArnStringModel
- MaximumPlayerSessionCount WholeNumber
- Name NonZeroAndMaxString
- PlayerSessionCreationPolicy PlayerSessionCreationPolicy
- ProtectionPolicy ProtectionPolicy
UpdateGameSessionOutput
- UpdateGameSessionOutput
object
: Represents the returned data in response to a request action.- GameSession GameSession
UpdateGameSessionQueueInput
- UpdateGameSessionQueueInput
object
: Represents the input for a request action.- Destinations GameSessionQueueDestinationList
- Name required GameSessionQueueName
- PlayerLatencyPolicies PlayerLatencyPolicyList
- TimeoutInSeconds WholeNumber
UpdateGameSessionQueueOutput
- UpdateGameSessionQueueOutput
object
: Represents the returned data in response to a request action.- GameSessionQueue GameSessionQueue
UpdateMatchmakingConfigurationInput
- UpdateMatchmakingConfigurationInput
object
: Represents the input for a request action.- AcceptanceRequired BooleanModel
- AcceptanceTimeoutSeconds MatchmakingAcceptanceTimeoutInteger
- AdditionalPlayerCount WholeNumber
- CustomEventData CustomEventData
- Description NonZeroAndMaxString
- GameProperties GamePropertyList
- GameSessionData GameSessionData
- GameSessionQueueArns QueueArnsList
- Name required MatchmakingIdStringModel
- NotificationTarget SnsArnStringModel
- RequestTimeoutSeconds MatchmakingRequestTimeoutInteger
- RuleSetName MatchmakingIdStringModel
UpdateMatchmakingConfigurationOutput
- UpdateMatchmakingConfigurationOutput
object
: Represents the returned data in response to a request action.- Configuration MatchmakingConfiguration
UpdateRuntimeConfigurationInput
- UpdateRuntimeConfigurationInput
object
: Represents the input for a request action.- FleetId required FleetId
- RuntimeConfiguration required RuntimeConfiguration
UpdateRuntimeConfigurationOutput
- UpdateRuntimeConfigurationOutput
object
: Represents the returned data in response to a request action.- RuntimeConfiguration RuntimeConfiguration
ValidateMatchmakingRuleSetInput
- ValidateMatchmakingRuleSetInput
object
: Represents the input for a request action.- RuleSetBody required RuleSetBody
ValidateMatchmakingRuleSetOutput
- ValidateMatchmakingRuleSetOutput
object
: Represents the returned data in response to a request action.- Valid BooleanModel
VpcPeeringAuthorization
- VpcPeeringAuthorization
object
:Represents an authorization for a VPC peering connection between the VPC for an Amazon GameLift fleet and another VPC on an account you have access to. This authorization must exist and be valid for the peering connection to be established. Authorizations are valid for 24 hours after they are issued.
VPC peering connection operations include:
-
CreateVpcPeeringAuthorization
-
DescribeVpcPeeringAuthorizations
-
DeleteVpcPeeringAuthorization
-
CreateVpcPeeringConnection
-
DescribeVpcPeeringConnections
-
DeleteVpcPeeringConnection
- CreationTime Timestamp
- ExpirationTime Timestamp
- GameLiftAwsAccountId NonZeroAndMaxString
- PeerVpcAwsAccountId NonZeroAndMaxString
- PeerVpcId NonZeroAndMaxString
-
VpcPeeringAuthorizationList
- VpcPeeringAuthorizationList
array
- items VpcPeeringAuthorization
VpcPeeringConnection
- VpcPeeringConnection
object
:Represents a peering connection between a VPC on one of your AWS accounts and the VPC for your Amazon GameLift fleets. This record may be for an active peering connection or a pending connection that has not yet been established.
VPC peering connection operations include:
-
CreateVpcPeeringAuthorization
-
DescribeVpcPeeringAuthorizations
-
DeleteVpcPeeringAuthorization
-
CreateVpcPeeringConnection
-
DescribeVpcPeeringConnections
-
DeleteVpcPeeringConnection
- FleetId FleetId
- GameLiftVpcId NonZeroAndMaxString
- IpV4CidrBlock NonZeroAndMaxString
- PeerVpcId NonZeroAndMaxString
- Status VpcPeeringConnectionStatus
- VpcPeeringConnectionId NonZeroAndMaxString
-
VpcPeeringConnectionList
- VpcPeeringConnectionList
array
- items VpcPeeringConnection
VpcPeeringConnectionStatus
- VpcPeeringConnectionStatus
object
: Represents status information for a VPC peering connection. Status is associated with a VpcPeeringConnection object. Status codes and messages are provided from EC2 (see VpcPeeringConnectionStateReason). Connection status information is also communicated as a fleet Event.- Code NonZeroAndMaxString
- Message NonZeroAndMaxString
WholeNumber
- WholeNumber
integer