Welcome to the Amazon GameLift API Reference. Amazon GameLift is a managed Amazon Web Services (AWS) service for developers who need a scalable, server-based solution for multiplayer games. Amazon GameLift provides setup and deployment of game servers, and handles infrastructure scaling and session management.
This reference describes the low-level service API for GameLift. You can call this API directly or use the AWS SDK for your preferred language. The AWS SDK includes a set of high-level GameLift actions multiplayer game sessions. Alternatively, you can use the AWS command-line interface (CLI) tool, which includes commands for GameLift. For administrative actions, you can also use the Amazon GameLift console.
More Resources
Manage Games and Players Through GameLift
Call these actions from your game clients and/or services to create and manage multiplayer game sessions and player sessions.
Set Up and Manage Game Servers
Use these administrative actions to configure GameLift to host your game servers. When setting up GameLift, you'll need to (1) configure a build for your game and upload build files, and (2) set up one or more fleets to host game sessions. Once you've created and activated a fleet, you can assign aliases to it, scale capacity, track performance and utilization, etc.
To view changes to the API, see the GameLift Document History page.
", "operations":{ "CreateAlias":{ "name":"CreateAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateAliasInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"CreateAliasOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"ConflictException", "exception":true, "documentation":"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.
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"LimitExceededException", "exception":true, "documentation":"The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
" } ], "documentation":"Creates an alias for a fleet. You can use an alias to anonymize your fleet by referencing an alias instead of a specific fleet when you create game sessions. Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. Use a simple alias to point to an active fleet. Use a terminal alias to display a message to incoming traffic instead of routing players to an active fleet. This option is useful when a game server is no longer supported but you want to provide better messaging than a standard 404 error.
To create a fleet alias, specify an alias name, routing strategy, and optional description. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. To reassign the alias to another fleet ID, call UpdateAlias.
" }, "CreateBuild":{ "name":"CreateBuild", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateBuildInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"CreateBuildOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"ConflictException", "exception":true, "documentation":"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.
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" } ], "documentation":"Initializes a new build record and generates information required to upload a game build to Amazon GameLift. Once the build record has been created and its status is INITIALIZED, you can upload your game build.
Do not use this API action unless you are using your own Amazon Simple Storage Service (Amazon S3) client and need to manually upload your build files. Instead, to create a build, use the CLI command upload-build, which creates a new build record and uploads the build files in one step. (See the Amazon GameLift Developer Guide help on packaging and uploading your build.)
To create a new build, identify the operating system of the game server binaries. All game servers in a build must use the same operating system. Optionally, specify a build name and version; this metadata is stored with other properties in the build record and is displayed in the GameLift console (it is not visible to players). If successful, this action returns the newly created build record along with the Amazon S3 storage location and AWS account credentials. Use the location and credentials to upload your game build.
" }, "CreateFleet":{ "name":"CreateFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreateFleetInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"CreateFleetOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"ConflictException", "exception":true, "documentation":"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.
" }, { "shape":"LimitExceededException", "exception":true, "documentation":"The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" } ], "documentation":"Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can run multiple server processes to host game sessions. You configure a fleet to create instances with certain hardware specifications (see Amazon EC2 Instance Types for more information), and deploy a specified game build to each instance. A newly created fleet passes through several statuses; once it reaches the ACTIVE status, it can begin hosting game sessions.
To create a new fleet, provide a fleet name, an EC2 instance type, and a build ID of the game build to deploy. You can also configure the new fleet with the following settings: (1) a runtime configuration describing what server processes to run on each instance in the fleet (required to create fleet), (2) access permissions for inbound traffic, (3) fleet-wide game session protection, and (4) the location of default log files for GameLift to upload and store.
If the CreateFleet call is successful, Amazon GameLift performs the following tasks:
NEW (followed by other statuses as the fleet is activated).ACTIVE once one server process in the fleet is ready to host a game session.After a fleet is created, use the following actions to change fleet properties and configuration:
Represents the input for a request action.
" }, "output":{ "shape":"CreateGameSessionOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"ConflictException", "exception":true, "documentation":"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.
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidFleetStatusException", "exception":true, "documentation":"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.
" }, { "shape":"TerminalRoutingStrategyException", "exception":true, "documentation":"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.
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"FleetCapacityExceededException", "exception":true, "documentation":"The specified fleet has no available instances to fulfill a request to create a new game session. Such requests should only be retried once the fleet capacity has been increased.
" } ], "documentation":"Creates a multiplayer game session for players. This action creates a game session record and assigns the new session to an instance in the specified fleet, which initializes a new server process to host the game session. A fleet must be in an ACTIVE status before a game session can be created in it.
To create a game session, specify either a fleet ID or an alias ID and indicate the maximum number of players the game session allows. You can also provide a name and a set of properties for your game (optional). If successful, a GameSession object is returned containing session properties, including an IP address. By default, newly created game sessions are set to accept adding any new players to the game session. Use UpdateGameSession to change the creation policy.
" }, "CreatePlayerSession":{ "name":"CreatePlayerSession", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreatePlayerSessionInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"CreatePlayerSessionOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidGameSessionStatusException", "exception":true, "documentation":"The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Clients should not retry such requests without resolving the conflict.
" }, { "shape":"GameSessionFullException", "exception":true, "documentation":"The game instance is currently full and cannot allow the requested player(s) to join. This exception occurs in response to a CreatePlayerSession request.
" }, { "shape":"TerminalRoutingStrategyException", "exception":true, "documentation":"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.
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" } ], "documentation":"Adds a player to a game session and creates a player session record. A game session must be in an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot before players can be added to the session.
To create a player session, specify a game session ID and player ID. If successful, the player is added to the game session and a new PlayerSession object is returned.
" }, "CreatePlayerSessions":{ "name":"CreatePlayerSessions", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"CreatePlayerSessionsInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"CreatePlayerSessionsOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidGameSessionStatusException", "exception":true, "documentation":"The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Clients should not retry such requests without resolving the conflict.
" }, { "shape":"GameSessionFullException", "exception":true, "documentation":"The game instance is currently full and cannot allow the requested player(s) to join. This exception occurs in response to a CreatePlayerSession request.
" }, { "shape":"TerminalRoutingStrategyException", "exception":true, "documentation":"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.
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" } ], "documentation":"Adds a group of players to a game session. Similar to CreatePlayerSession, this action allows you to add multiple players in a single call, which is useful for games that provide party and/or matchmaking features. A game session must be in an ACTIVE status, have a creation policy of ALLOW_ALL, and have an open player slot before players can be added to the session.
To create player sessions, specify a game session ID and a list of player IDs. If successful, the players are added to the game session and a set of new PlayerSession objects is returned.
" }, "DeleteAlias":{ "name":"DeleteAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteAliasInput", "documentation":"Represents the input for a request action.
" }, "errors":[ { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" } ], "documentation":"Deletes an alias. This action removes all record of the alias; game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.
" }, "DeleteBuild":{ "name":"DeleteBuild", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteBuildInput", "documentation":"Represents the input for a request action.
" }, "errors":[ { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" } ], "documentation":"Deletes a build. This action permanently deletes the build record and any uploaded build files.
To delete a build, specify its ID. Deleting a build does not affect the status of any active fleets using the build, but you can no longer create new fleets with the deleted build.
" }, "DeleteFleet":{ "name":"DeleteFleet", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteFleetInput", "documentation":"Represents the input for a request action.
" }, "errors":[ { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"InvalidFleetStatusException", "exception":true, "documentation":"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.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" } ], "documentation":"Deletes everything related to a fleet. Before deleting a fleet, you must set the fleet's desired capacity to zero. See UpdateFleetCapacity.
This action removes the fleet's resources and the fleet record. Once a fleet is deleted, you can no longer use that fleet.
" }, "DeleteScalingPolicy":{ "name":"DeleteScalingPolicy", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DeleteScalingPolicyInput", "documentation":"Represents the input for a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" } ], "documentation":"Deletes a fleet scaling policy. This action means that the policy is no longer in force and removes all record of it. To delete a scaling policy, specify both the scaling policy name and the fleet ID it is associated with.
" }, "DescribeAlias":{ "name":"DescribeAlias", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeAliasInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"DescribeAliasOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" } ], "documentation":"Retrieves properties for a specified alias. To get the alias, specify an alias ID. If successful, an Alias object is returned.
" }, "DescribeBuild":{ "name":"DescribeBuild", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeBuildInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"DescribeBuildOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" } ], "documentation":"Retrieves properties for a build. To get a build record, specify a build ID. If successful, an object containing the build properties is returned.
" }, "DescribeEC2InstanceLimits":{ "name":"DescribeEC2InstanceLimits", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeEC2InstanceLimitsInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"DescribeEC2InstanceLimitsOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" } ], "documentation":"Retrieves the following information for the specified EC2 instance type:
Service limits vary depending on region. Available regions for GameLift can be found in the AWS Management Console for GameLift (see the drop-down list in the upper right corner).
" }, "DescribeFleetAttributes":{ "name":"DescribeFleetAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeFleetAttributesInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"DescribeFleetAttributesOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" } ], "documentation":"Retrieves fleet properties, including metadata, status, and configuration, for one or more fleets. You can request attributes for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetAttributes object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Represents the input for a request action.
" }, "output":{ "shape":"DescribeFleetCapacityOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" } ], "documentation":"Retrieves the current status of fleet capacity for one or more fleets. This information includes the number of instances that have been requested for the fleet and the number currently active. You can request capacity for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetCapacity object is returned for each requested fleet ID. When specifying a list of fleet IDs, attribute objects are returned only for fleets that currently exist.
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Represents the input for a request action.
" }, "output":{ "shape":"DescribeFleetEventsOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" } ], "documentation":"Retrieves entries from the specified fleet's event log. You can specify a time range to limit the result set. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of event log entries matching the request are returned.
" }, "DescribeFleetPortSettings":{ "name":"DescribeFleetPortSettings", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeFleetPortSettingsInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"DescribeFleetPortSettingsOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" } ], "documentation":"Retrieves the inbound connection permissions for a fleet. Connection permissions include a range of IP addresses and port settings that incoming traffic can use to access server processes in the fleet. To get a fleet's inbound connection permissions, specify a fleet ID. If successful, a collection of IpPermission objects is returned for the requested fleet ID. If the requested fleet has been deleted, the result set is empty.
" }, "DescribeFleetUtilization":{ "name":"DescribeFleetUtilization", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeFleetUtilizationInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"DescribeFleetUtilizationOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" } ], "documentation":"Retrieves utilization statistics for one or more fleets. You can request utilization data for all fleets, or specify a list of one or more fleet IDs. When requesting multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a FleetUtilization object is returned for each requested fleet ID. When specifying a list of fleet IDs, utilization objects are returned only for fleets that currently exist.
Some API actions may limit the number of fleet IDs allowed in one request. If a request exceeds this limit, the request fails and the error message includes the maximum allowed.
Represents the input for a request action.
" }, "output":{ "shape":"DescribeGameSessionDetailsOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"TerminalRoutingStrategyException", "exception":true, "documentation":"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.
" } ], "documentation":"Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.
To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionDetail object is returned for each session matching the request.
" }, "DescribeGameSessions":{ "name":"DescribeGameSessions", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeGameSessionsInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"DescribeGameSessionsOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"TerminalRoutingStrategyException", "exception":true, "documentation":"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.
" } ], "documentation":"Retrieves properties for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId to request properties for a specific game session; (2) provide a FleetId or an AliasId to request properties for all game sessions running on a fleet.
To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession object is returned for each session matching the request.
" }, "DescribePlayerSessions":{ "name":"DescribePlayerSessions", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribePlayerSessionsInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"DescribePlayerSessionsOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" } ], "documentation":"Retrieves properties for one or more player sessions. This action can be used in several ways: (1) provide a PlayerSessionId parameter to request properties for a specific player session; (2) provide a GameSessionId parameter to request properties for all player sessions in the specified game session; (3) provide a PlayerId parameter to request properties for all player sessions of a specified player.
To get game session record(s), specify only one of the following: a player session ID, a game session ID, or a player ID. You can filter this request by player session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a PlayerSession object is returned for each session matching the request.
" }, "DescribeRuntimeConfiguration":{ "name":"DescribeRuntimeConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeRuntimeConfigurationInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"DescribeRuntimeConfigurationOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" } ], "documentation":"Retrieves the current runtime configuration for the specified fleet. The runtime configuration tells GameLift how to launch server processes on instances in the fleet.
" }, "DescribeScalingPolicies":{ "name":"DescribeScalingPolicies", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"DescribeScalingPoliciesInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"DescribeScalingPoliciesOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" } ], "documentation":"Retrieves all scaling policies applied to a fleet.
To get a fleet's scaling policies, specify the fleet ID. You can filter this request by policy status, such as to retrieve only active scaling policies. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, set of ScalingPolicy objects is returned for the fleet.
" }, "GetGameSessionLogUrl":{ "name":"GetGameSessionLogUrl", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"GetGameSessionLogUrlInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"GetGameSessionLogUrlOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" } ], "documentation":"Retrieves the location of stored game session logs for a specified game session. When a game session is terminated, Amazon GameLift automatically stores the logs in Amazon S3. Use this URL to download the logs.
See the AWS Service Limits page for maximum log file sizes. Log files that exceed this limit are not saved.
Represents the input for a request action.
" }, "output":{ "shape":"ListAliasesOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" } ], "documentation":"Retrieves a collection of alias records for this AWS account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.
Aliases are not listed in any particular order.
Represents the input for a request action.
" }, "output":{ "shape":"ListBuildsOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" } ], "documentation":"Retrieves build records for all builds associated with the AWS account in use. You can limit results to builds that are in a specific status by using the Status parameter. Use the pagination parameters to retrieve results in a set of sequential pages.
Build records are not listed in any particular order.
Represents the input for a request action.
" }, "output":{ "shape":"ListFleetsOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" } ], "documentation":"Retrieves a collection of fleet records for this AWS account. You can filter the result set by build ID. Use the pagination parameters to retrieve results in sequential pages.
Fleet records are not listed in any particular order.
Represents the input for a request action.
" }, "output":{ "shape":"PutScalingPolicyOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" } ], "documentation":"Creates or updates a scaling policy for a fleet. An active scaling policy prompts Amazon GameLift to track a certain metric for a fleet and automatically change the fleet's capacity in specific circumstances. Each scaling policy contains one rule statement. Fleets can have multiple scaling policies in force simultaneously.
A scaling policy rule statement has the following structure:
If [MetricName] is [ComparisonOperator] [Threshold] for [EvaluationPeriods] minutes, then [ScalingAdjustmentType] to/by [ScalingAdjustment].
For example, this policy: \"If the number of idle instances exceeds 20 for more than 15 minutes, then reduce the fleet capacity by 10 instances\" could be implemented as the following rule statement:
If [IdleInstances] is [GreaterThanOrEqualToThreshold] [20] for [15] minutes, then [ChangeInCapacity] by [-10].
To create or update a scaling policy, specify a unique combination of name and fleet ID, and set the rule values. All parameters for this action are required. If successful, the policy name is returned. Scaling policies cannot be suspended or made inactive. To stop enforcing a scaling policy, call DeleteScalingPolicy.
" }, "RequestUploadCredentials":{ "name":"RequestUploadCredentials", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"RequestUploadCredentialsInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"RequestUploadCredentialsOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" } ], "documentation":"Retrieves a fresh set of upload credentials and the assigned Amazon S3 storage location for a specific build. Valid credentials are required to upload your game build files to Amazon S3.
Call this action only if you need credentials for a build created with CreateBuild. This is a rare situation; in most cases, builds are created using the CLI command upload-build, which creates a build record and also uploads build files.
Upload credentials are returned when you create the build, but they have a limited lifespan. You can get fresh credentials and use them to re-upload game files until the status of that build changes to READY. Once this happens, you must create a brand new build.
Represents the input for a request action.
" }, "output":{ "shape":"ResolveAliasOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"TerminalRoutingStrategyException", "exception":true, "documentation":"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.
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" } ], "documentation":"Retrieves the fleet ID that a specified alias is currently pointing to.
" }, "SearchGameSessions":{ "name":"SearchGameSessions", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"SearchGameSessionsInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"SearchGameSessionsOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"TerminalRoutingStrategyException", "exception":true, "documentation":"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.
" } ], "documentation":"Retrieves a list of game sessions in a fleet that match a set of search criteria and sorts them in a specified order. Currently game session searches are limited to a single fleet. Search results include only game sessions that are in ACTIVE status.
You can search or sort by the following game session attributes:
true or false. It is highly recommended that all search requests include this filter attribute to optimize search performance and return only sessions that players can join. To search or sort, specify either a fleet ID or an alias ID, and provide a search filter expression, a sort expression, or both. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a collection of GameSession objects matching the request is returned.
Returned values for playerSessionCount and hasAvailablePlayerSessions change quickly as players join sessions and others drop out. Results should be considered a snapshot in time. Be sure to refresh search results often, and handle sessions that fill up before a player can join.
Represents the input for a request action.
" }, "output":{ "shape":"UpdateAliasOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" } ], "documentation":"Updates properties for an alias. To update properties, specify the alias ID to be updated and provide the information to be changed. To reassign an alias to another fleet, provide an updated routing strategy. If successful, the updated alias record is returned.
" }, "UpdateBuild":{ "name":"UpdateBuild", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"UpdateBuildInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"UpdateBuildOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" } ], "documentation":"Updates metadata in a build record, including the build name and version. To update the metadata, specify the build ID to update and provide the new values. If successful, a build object containing the updated metadata is returned.
" }, "UpdateFleetAttributes":{ "name":"UpdateFleetAttributes", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"UpdateFleetAttributesInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"UpdateFleetAttributesOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"ConflictException", "exception":true, "documentation":"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.
" }, { "shape":"InvalidFleetStatusException", "exception":true, "documentation":"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.
" }, { "shape":"LimitExceededException", "exception":true, "documentation":"The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" } ], "documentation":"Updates fleet properties, including name and description, for a fleet. To update metadata, specify the fleet ID and the property values you want to change. If successful, the fleet ID for the updated fleet is returned.
" }, "UpdateFleetCapacity":{ "name":"UpdateFleetCapacity", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"UpdateFleetCapacityInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"UpdateFleetCapacityOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"ConflictException", "exception":true, "documentation":"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.
" }, { "shape":"LimitExceededException", "exception":true, "documentation":"The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
" }, { "shape":"InvalidFleetStatusException", "exception":true, "documentation":"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.
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" } ], "documentation":"Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) that you want this fleet to contain. Before calling this action, you may want to call DescribeEC2InstanceLimits to get the maximum capacity based on the fleet's EC2 instance type.
If you're using autoscaling (see PutScalingPolicy), you may want to specify a minimum and/or maximum capacity. If you don't provide these, autoscaling can set capacity anywhere between zero and the service limits.
To update fleet capacity, specify the fleet ID and the number of instances you want the fleet to host. If successful, Amazon GameLift starts or terminates instances so that the fleet's active instance count matches the desired instance count. You can view a fleet's current capacity information by calling DescribeFleetCapacity. If the desired instance count is higher than the instance type's limit, the \"Limit Exceeded\" exception occurs.
" }, "UpdateFleetPortSettings":{ "name":"UpdateFleetPortSettings", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"UpdateFleetPortSettingsInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"UpdateFleetPortSettingsOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"ConflictException", "exception":true, "documentation":"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.
" }, { "shape":"InvalidFleetStatusException", "exception":true, "documentation":"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.
" }, { "shape":"LimitExceededException", "exception":true, "documentation":"The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" } ], "documentation":"Updates port settings for a fleet. To update settings, specify the fleet ID to be updated and list the permissions you want to update. List the permissions you want to add in InboundPermissionAuthorizations, and permissions you want to remove in InboundPermissionRevocations. Permissions to be removed must match existing fleet permissions. If successful, the fleet ID for the updated fleet is returned.
Represents the input for a request action.
" }, "output":{ "shape":"UpdateGameSessionOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"ConflictException", "exception":true, "documentation":"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.
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"InvalidGameSessionStatusException", "exception":true, "documentation":"The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Clients should not retry such requests without resolving the conflict.
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" } ], "documentation":"Updates game session properties. This includes the session name, maximum player count, protection policy, which controls whether or not an active game session can be terminated during a scale-down event, and the player session creation policy, which controls whether or not new players can join the session. To update a game session, specify the game session ID and the values you want to change. If successful, an updated GameSession object is returned.
" }, "UpdateRuntimeConfiguration":{ "name":"UpdateRuntimeConfiguration", "http":{ "method":"POST", "requestUri":"/" }, "input":{ "shape":"UpdateRuntimeConfigurationInput", "documentation":"Represents the input for a request action.
" }, "output":{ "shape":"UpdateRuntimeConfigurationOutput", "documentation":"Represents the returned data in response to a request action.
" }, "errors":[ { "shape":"UnauthorizedException", "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, { "shape":"NotFoundException", "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, { "shape":"InternalServiceException", "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, { "shape":"InvalidRequestException", "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, { "shape":"InvalidFleetStatusException", "exception":true, "documentation":"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.
" } ], "documentation":"Updates the current runtime configuration for the specified fleet, which tells GameLift how to launch server processes on instances in the fleet. You can update a fleet's runtime configuration at any time after the fleet is created; it does not need to be in an ACTIVE status.
To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration object with the updated collection of server process configurations.
Each instance in a GameLift fleet checks regularly for an updated runtime configuration and changes how it launches server processes to comply with the latest version. Existing server processes are not affected by the update; they continue to run until they end, while GameLift simply adds new server processes to fit the current runtime configuration. As a result, the runtime configuration changes are applied gradually as existing processes shut down and new processes are launched in GameLift's normal process recycling activity.
" } }, "shapes":{ "Alias":{ "type":"structure", "members":{ "AliasId":{ "shape":"AliasId", "documentation":"Unique identifier for a fleet alias.
" }, "Name":{ "shape":"FreeText", "documentation":"Descriptive label associated with an alias. Alias names do not need to be unique.
" }, "Description":{ "shape":"FreeText", "documentation":"Human-readable description of an alias.
" }, "RoutingStrategy":{"shape":"RoutingStrategy"}, "CreationTime":{ "shape":"Timestamp", "documentation":"Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\".
" }, "LastUpdatedTime":{ "shape":"Timestamp", "documentation":"Time stamp indicating when this data object was last modified. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\".
" } }, "documentation":"Properties describing a fleet alias.
" }, "AliasId":{ "type":"string", "pattern":"^alias-\\S+" }, "AliasList":{ "type":"list", "member":{"shape":"Alias"} }, "AwsCredentials":{ "type":"structure", "members":{ "AccessKeyId":{ "shape":"NonEmptyString", "documentation":"Access key for an AWS account.
" }, "SecretAccessKey":{ "shape":"NonEmptyString", "documentation":"Secret key for an AWS account.
" }, "SessionToken":{ "shape":"NonEmptyString", "documentation":"Token specific to a build ID.
" } }, "sensitive":true, "documentation":"AWS access credentials required to upload game build files to Amazon GameLift. These credentials are generated with CreateBuild, and are valid for a limited time. If they expire before you upload your game build, get a new set by calling RequestUploadCredentials.
" }, "Build":{ "type":"structure", "members":{ "BuildId":{ "shape":"BuildId", "documentation":"Unique identifier for a build.
" }, "Name":{ "shape":"FreeText", "documentation":"Descriptive label associated with a build. Build names do not need to be unique. It can be set using CreateBuild or UpdateBuild.
" }, "Version":{ "shape":"FreeText", "documentation":"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.
" }, "Status":{ "shape":"BuildStatus", "documentation":"Current status of the build.
Possible build statuses include the following:
File size of the uploaded game build, expressed in bytes. When the build status is INITIALIZED, this value is 0.
Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\".
" } }, "documentation":"Properties describing a game build.
" }, "BuildId":{ "type":"string", "pattern":"^build-\\S+" }, "BuildList":{ "type":"list", "member":{"shape":"Build"} }, "BuildStatus":{ "type":"string", "enum":[ "INITIALIZED", "READY", "FAILED" ] }, "ComparisonOperatorType":{ "type":"string", "enum":[ "GreaterThanOrEqualToThreshold", "GreaterThanThreshold", "LessThanThreshold", "LessThanOrEqualToThreshold" ] }, "ConflictException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "exception":true, "documentation":"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.
" }, "CreateAliasInput":{ "type":"structure", "required":[ "Name", "RoutingStrategy" ], "members":{ "Name":{ "shape":"NonZeroAndMaxString", "documentation":"Descriptive label associated with an alias. Alias names do not need to be unique.
" }, "Description":{ "shape":"NonZeroAndMaxString", "documentation":"Human-readable description of an alias.
" }, "RoutingStrategy":{ "shape":"RoutingStrategy", "documentation":"Object specifying the fleet and routing type to use for the alias.
" } }, "documentation":"Represents the input for a request action.
" }, "CreateAliasOutput":{ "type":"structure", "members":{ "Alias":{ "shape":"Alias", "documentation":"Object containing the newly created alias record.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "CreateBuildInput":{ "type":"structure", "members":{ "Name":{ "shape":"NonZeroAndMaxString", "documentation":"Descriptive label associated with a build. Build names do not need to be unique. A build name can be changed later using UpdateBuild.
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.
Operating system that the game server binaries are built to run on. This value determines the type of fleet resources that you can use for this build.
" } }, "documentation":"Represents the input for a request action.
" }, "CreateBuildOutput":{ "type":"structure", "members":{ "Build":{ "shape":"Build", "documentation":"Set of properties for the newly created build.
" }, "UploadCredentials":{ "shape":"AwsCredentials", "documentation":"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.
Amazon S3 path and key, identifying where the game build files are stored.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "CreateFleetInput":{ "type":"structure", "required":[ "Name", "BuildId", "EC2InstanceType" ], "members":{ "Name":{ "shape":"NonZeroAndMaxString", "documentation":"Descriptive label associated with a fleet. Fleet names do not need to be unique.
" }, "Description":{ "shape":"NonZeroAndMaxString", "documentation":"Human-readable description of a fleet.
" }, "BuildId":{ "shape":"BuildId", "documentation":"Unique identifier of the build to be deployed on the new fleet. The build must have been successfully uploaded to GameLift and be in a READY status. This fleet setting cannot be changed once the fleet is created.
This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.)
This parameter is no longer used. Instead, specify server launch parameters in the RuntimeConfiguration parameter. (Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.)
Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, GameLift will automatically upload logs stored on each instance at C:\\game\\logs. Use the GameLift console to access stored logs.
Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
" }, "EC2InboundPermissions":{ "shape":"IpPermissionsList", "documentation":"Range of IP addresses and port settings that permit inbound traffic to access server processes running on the fleet. If no inbound permissions are set, including both IP address range and port range, the server processes in the fleet cannot accept connections. You can specify one or more sets of permissions for a fleet.
" }, "NewGameSessionProtectionPolicy":{ "shape":"ProtectionPolicy", "documentation":"Game session protection policy to apply to all instances in this fleet. If this parameter is not set, instances in this fleet default to no protection. You can change a fleet's protection policy using UpdateFleetAttributes, but this change will only affect sessions created after the policy change. You can also set protection for individual instances using UpdateGameSession.
ACTIVE status, it cannot be terminated during a scale-down event.Instructions for launching server processes on each instance in the fleet. The runtime configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance. A CreateFleet request must include a runtime configuration with at least one server process configuration; otherwise the request will fail with an invalid request exception. (This parameter replaces the parameters ServerLaunchPath and ServerLaunchParameters; requests that contain values for these parameters instead of a runtime configuration will continue to work.)
Represents the input for a request action.
" }, "CreateFleetOutput":{ "type":"structure", "members":{ "FleetAttributes":{ "shape":"FleetAttributes", "documentation":"Properties for the newly created fleet.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "CreateGameSessionInput":{ "type":"structure", "required":["MaximumPlayerSessionCount"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.
" }, "AliasId":{ "shape":"AliasId", "documentation":"Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.
" }, "MaximumPlayerSessionCount":{ "shape":"WholeNumber", "documentation":"Maximum number of players that can be connected simultaneously to the game session.
" }, "Name":{ "shape":"NonZeroAndMaxString", "documentation":"Descriptive label associated with a game session. Session names do not need to be unique.
" }, "GameProperties":{ "shape":"GamePropertyList", "documentation":"Set of properties used to administer a game session. These properties are passed to the server process hosting it.
" } }, "documentation":"Represents the input for a request action.
" }, "CreateGameSessionOutput":{ "type":"structure", "members":{ "GameSession":{ "shape":"GameSession", "documentation":"Object containing the newly created game session record.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "CreatePlayerSessionInput":{ "type":"structure", "required":[ "GameSessionId", "PlayerId" ], "members":{ "GameSessionId":{ "shape":"GameSessionId", "documentation":"Unique identifier for a game session. Specify the game session you want to add a player to.
" }, "PlayerId":{ "shape":"NonZeroAndMaxString", "documentation":"Unique identifier for the player to be added.
" } }, "documentation":"Represents the input for a request action.
" }, "CreatePlayerSessionOutput":{ "type":"structure", "members":{ "PlayerSession":{ "shape":"PlayerSession", "documentation":"Object containing the newly created player session record.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "CreatePlayerSessionsInput":{ "type":"structure", "required":[ "GameSessionId", "PlayerIds" ], "members":{ "GameSessionId":{ "shape":"GameSessionId", "documentation":"Unique identifier for a game session.
" }, "PlayerIds":{ "shape":"PlayerIdList", "documentation":"List of unique identifiers for the players to be added.
" } }, "documentation":"Represents the input for a request action.
" }, "CreatePlayerSessionsOutput":{ "type":"structure", "members":{ "PlayerSessions":{ "shape":"PlayerSessionList", "documentation":"Collection of player session objects created for the added players.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "DeleteAliasInput":{ "type":"structure", "required":["AliasId"], "members":{ "AliasId":{ "shape":"AliasId", "documentation":"Unique identifier for a fleet alias. Specify the alias you want to delete.
" } }, "documentation":"Represents the input for a request action.
" }, "DeleteBuildInput":{ "type":"structure", "required":["BuildId"], "members":{ "BuildId":{ "shape":"BuildId", "documentation":"Unique identifier for the build you want to delete.
" } }, "documentation":"Represents the input for a request action.
" }, "DeleteFleetInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for the fleet you want to delete.
" } }, "documentation":"Represents the input for a request action.
" }, "DeleteScalingPolicyInput":{ "type":"structure", "required":[ "Name", "FleetId" ], "members":{ "Name":{ "shape":"NonZeroAndMaxString", "documentation":"Descriptive label associated with a scaling policy. Policy names do not need to be unique.
" }, "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for a fleet.
" } }, "documentation":"Represents the input for a request action.
" }, "DescribeAliasInput":{ "type":"structure", "required":["AliasId"], "members":{ "AliasId":{ "shape":"AliasId", "documentation":"Unique identifier for a fleet alias. Specify the alias you want to retrieve.
" } }, "documentation":"Represents the input for a request action.
" }, "DescribeAliasOutput":{ "type":"structure", "members":{ "Alias":{ "shape":"Alias", "documentation":"Object containing the requested alias.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "DescribeBuildInput":{ "type":"structure", "required":["BuildId"], "members":{ "BuildId":{ "shape":"BuildId", "documentation":"Unique identifier of the build that you want to retrieve properties for.
" } }, "documentation":"Represents the input for a request action.
" }, "DescribeBuildOutput":{ "type":"structure", "members":{ "Build":{ "shape":"Build", "documentation":"Set of properties describing the requested build.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "DescribeEC2InstanceLimitsInput":{ "type":"structure", "members":{ "EC2InstanceType":{ "shape":"EC2InstanceType", "documentation":"Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions. Leave this parameter blank to retrieve limits for all types.
" } }, "documentation":"Represents the input for a request action.
" }, "DescribeEC2InstanceLimitsOutput":{ "type":"structure", "members":{ "EC2InstanceLimits":{ "shape":"EC2InstanceLimitList", "documentation":"Object containing the maximum number of instances for the specified instance type.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "DescribeFleetAttributesInput":{ "type":"structure", "members":{ "FleetIds":{ "shape":"FleetIdList", "documentation":"Unique identifiers for the fleet(s) that you want to retrieve attributes for. To request attributes for all fleets, leave this parameter empty.
" }, "Limit":{ "shape":"PositiveInteger", "documentation":"Maximum number of results to return. 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.
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.
" } }, "documentation":"Represents the input for a request action.
" }, "DescribeFleetAttributesOutput":{ "type":"structure", "members":{ "FleetAttributes":{ "shape":"FleetAttributesList", "documentation":"Collection of objects containing attribute metadata for each requested fleet ID.
" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"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.
Represents the returned data in response to a request action.
" }, "DescribeFleetCapacityInput":{ "type":"structure", "members":{ "FleetIds":{ "shape":"FleetIdList", "documentation":"Unique identifier for the fleet(s) you want to retrieve capacity information for. To request capacity information for all fleets, leave this parameter empty.
" }, "Limit":{ "shape":"PositiveInteger", "documentation":"Maximum number of results to return. 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.
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.
" } }, "documentation":"Represents the input for a request action.
" }, "DescribeFleetCapacityOutput":{ "type":"structure", "members":{ "FleetCapacity":{ "shape":"FleetCapacityList", "documentation":"Collection of objects containing capacity information for each requested fleet ID. Leave this parameter empty to retrieve capacity information for all fleets.
" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"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.
Represents the returned data in response to a request action.
" }, "DescribeFleetEventsInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for the fleet to get event logs for.
" }, "StartTime":{ "shape":"Timestamp", "documentation":"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 a number expressed in Unix time as milliseconds (ex: \"1469498468.057\".
" }, "EndTime":{ "shape":"Timestamp", "documentation":"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 a number expressed in Unix time as milliseconds (ex: \"1469498468.057\".
" }, "Limit":{ "shape":"PositiveInteger", "documentation":"Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } }, "documentation":"Represents the input for a request action.
" }, "DescribeFleetEventsOutput":{ "type":"structure", "members":{ "Events":{ "shape":"EventList", "documentation":"Collection of objects containing event log entries for the specified fleet.
" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"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.
Represents the returned data in response to a request action.
" }, "DescribeFleetPortSettingsInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for the fleet you want to retrieve port settings for.
" } }, "documentation":"Represents the input for a request action.
" }, "DescribeFleetPortSettingsOutput":{ "type":"structure", "members":{ "InboundPermissions":{ "shape":"IpPermissionsList", "documentation":"Object containing port settings for the requested fleet ID.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "DescribeFleetUtilizationInput":{ "type":"structure", "members":{ "FleetIds":{ "shape":"FleetIdList", "documentation":"Unique identifier for the fleet(s) you want to retrieve utilization data for. To request utilization data for all fleets, leave this parameter empty.
" }, "Limit":{ "shape":"PositiveInteger", "documentation":"Maximum number of results to return. 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.
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.
" } }, "documentation":"Represents the input for a request action.
" }, "DescribeFleetUtilizationOutput":{ "type":"structure", "members":{ "FleetUtilization":{ "shape":"FleetUtilizationList", "documentation":"Collection of objects containing utilization information for each requested fleet ID.
" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"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.
Represents the returned data in response to a request action.
" }, "DescribeGameSessionDetailsInput":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.
" }, "GameSessionId":{ "shape":"GameSessionId", "documentation":"Unique identifier for a game session. Specify the game session to retrieve information on.
" }, "AliasId":{ "shape":"AliasId", "documentation":"Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.
" }, "StatusFilter":{ "shape":"NonZeroAndMaxString", "documentation":"Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).
Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } }, "documentation":"Represents the input for a request action.
" }, "DescribeGameSessionDetailsOutput":{ "type":"structure", "members":{ "GameSessionDetails":{ "shape":"GameSessionDetailList", "documentation":"Collection of objects containing game session properties and the protection policy currently in force for each session matching the request.
" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"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.
Represents the returned data in response to a request action.
" }, "DescribeGameSessionsInput":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.
" }, "GameSessionId":{ "shape":"GameSessionId", "documentation":"Unique identifier for a game session. Specify the game session to retrieve information on.
" }, "AliasId":{ "shape":"AliasId", "documentation":"Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.
" }, "StatusFilter":{ "shape":"NonZeroAndMaxString", "documentation":"Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING, and TERMINATING (the last two are transitory).
Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } }, "documentation":"Represents the input for a request action.
" }, "DescribeGameSessionsOutput":{ "type":"structure", "members":{ "GameSessions":{ "shape":"GameSessionList", "documentation":"Collection of objects containing game session properties for each session matching the request.
" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"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.
Represents the returned data in response to a request action.
" }, "DescribePlayerSessionsInput":{ "type":"structure", "members":{ "GameSessionId":{ "shape":"GameSessionId", "documentation":"Unique identifier for a game session.
" }, "PlayerId":{ "shape":"NonZeroAndMaxString", "documentation":"Unique identifier for a player.
" }, "PlayerSessionId":{ "shape":"PlayerSessionId", "documentation":"Unique identifier for a player session.
" }, "PlayerSessionStatusFilter":{ "shape":"NonZeroAndMaxString", "documentation":"Player session status to filter results on.
Possible player session statuses include the following:
Maximum number of results to return. 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.
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.
" } }, "documentation":"Represents the input for a request action.
" }, "DescribePlayerSessionsOutput":{ "type":"structure", "members":{ "PlayerSessions":{ "shape":"PlayerSessionList", "documentation":"Collection of objects containing properties for each player session that matches the request.
" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"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.
Represents the returned data in response to a request action.
" }, "DescribeRuntimeConfigurationInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier of the fleet to get the runtime configuration for.
" } }, "documentation":"Represents the input for a request action.
" }, "DescribeRuntimeConfigurationOutput":{ "type":"structure", "members":{ "RuntimeConfiguration":{ "shape":"RuntimeConfiguration", "documentation":"Instructions describing how server processes should be launched and maintained on each instance in the fleet.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "DescribeScalingPoliciesInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for a fleet. Specify the fleet to retrieve scaling policies for.
" }, "StatusFilter":{ "shape":"ScalingStatusType", "documentation":"Scaling policy status to filter results on. A scaling policy is only in force when in an ACTIVE status.
Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } }, "documentation":"Represents the input for a request action.
" }, "DescribeScalingPoliciesOutput":{ "type":"structure", "members":{ "ScalingPolicies":{ "shape":"ScalingPolicyList", "documentation":"Collection of objects containing the scaling policies matching the request.
" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"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.
Represents the returned data in response to a request action.
" }, "Double":{"type":"double"}, "EC2InstanceCounts":{ "type":"structure", "members":{ "DESIRED":{ "shape":"WholeNumber", "documentation":"Ideal number of active instances in the fleet.
" }, "MINIMUM":{ "shape":"WholeNumber", "documentation":"Minimum value allowed for the fleet's instance count.
" }, "MAXIMUM":{ "shape":"WholeNumber", "documentation":"Maximum value allowed for the fleet's instance count.
" }, "PENDING":{ "shape":"WholeNumber", "documentation":"Number of instances in the fleet that are starting but not yet active.
" }, "ACTIVE":{ "shape":"WholeNumber", "documentation":"Actual number of active instances in the fleet.
" }, "IDLE":{ "shape":"WholeNumber", "documentation":"Number of active instances in the fleet that are not currently hosting a game session.
" }, "TERMINATING":{ "shape":"WholeNumber", "documentation":"Number of instances in the fleet that are no longer active but haven't yet been terminated.
" } }, "documentation":"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.
" }, "EC2InstanceLimit":{ "type":"structure", "members":{ "EC2InstanceType":{ "shape":"EC2InstanceType", "documentation":"Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
" }, "CurrentInstances":{ "shape":"WholeNumber", "documentation":"Number of instances of the specified type that are currently in use by this AWS account.
" }, "InstanceLimit":{ "shape":"WholeNumber", "documentation":"Number of instances allowed.
" } }, "documentation":"Maximum number of instances allowed based on the Amazon Elastic Compute Cloud (Amazon EC2) instance type. Instance limits can be retrieved by calling DescribeEC2InstanceLimits.
" }, "EC2InstanceLimitList":{ "type":"list", "member":{"shape":"EC2InstanceLimit"} }, "EC2InstanceType":{ "type":"string", "enum":[ "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", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge" ] }, "Event":{ "type":"structure", "members":{ "EventId":{ "shape":"NonZeroAndMaxString", "documentation":"Unique identifier for a fleet event.
" }, "ResourceId":{ "shape":"NonZeroAndMaxString", "documentation":"Unique identifier for the resource, such as a fleet ID.
" }, "EventCode":{ "shape":"EventCode", "documentation":"Type of event being logged.
" }, "Message":{ "shape":"NonEmptyString", "documentation":"Additional information related to the event.
" }, "EventTime":{ "shape":"Timestamp", "documentation":"Time stamp indicating when this event occurred. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\".
" } }, "documentation":"Log entry describing an event involving an Amazon GameLift resource (such as a fleet).
" }, "EventCode":{ "type":"string", "enum":[ "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" ] }, "EventList":{ "type":"list", "member":{"shape":"Event"} }, "FleetAttributes":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for a fleet.
" }, "Description":{ "shape":"NonZeroAndMaxString", "documentation":"Human-readable description of the fleet.
" }, "Name":{ "shape":"NonZeroAndMaxString", "documentation":"Descriptive label associated with a fleet. Fleet names do not need to be unique.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\".
" }, "TerminationTime":{ "shape":"Timestamp", "documentation":"Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\".
" }, "Status":{ "shape":"FleetStatus", "documentation":"Current status of the fleet.
Possible fleet statuses include the following:
Unique identifier for a build.
" }, "ServerLaunchPath":{ "shape":"NonZeroAndMaxString", "documentation":"Path to a game server executable in the fleet's build, specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16). Server launch paths for fleets created after this date are specified in the fleet's RuntimeConfiguration.
Game server launch parameters specified for fleets created prior to 2016-08-04 (or AWS SDK v. 0.12.16). Server launch parameters for fleets created after this date are specified in the fleet's RuntimeConfiguration.
Location of default log files. When a server process is shut down, Amazon GameLift captures and stores any log files in this location. These logs are in addition to game session logs; see more on game session logs in the Amazon GameLift Developer Guide. If no default log path for a fleet is specified, GameLift will automatically upload logs stored on each instance at C:\\game\\logs. Use the GameLift console to access stored logs.
Type of game session protection to set for all new instances started in the fleet.
ACTIVE status, it cannot be terminated during a scale-down event.Operating system of the fleet's computing resources. A fleet's operating system depends on the OS specified for the build that is deployed on this fleet.
" } }, "documentation":"General properties describing a fleet.
" }, "FleetAttributesList":{ "type":"list", "member":{"shape":"FleetAttributes"} }, "FleetCapacity":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for a fleet.
" }, "InstanceType":{ "shape":"EC2InstanceType", "documentation":"Name of an EC2 instance type that is supported in Amazon GameLift. A fleet instance type determines the computing resources of each instance in the fleet, including CPU, memory, storage, and networking capacity. GameLift supports the following EC2 instance types. See Amazon EC2 Instance Types for detailed descriptions.
" }, "InstanceCounts":{ "shape":"EC2InstanceCounts", "documentation":"Current status of fleet capacity.
" } }, "documentation":"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.
" }, "FleetCapacityExceededException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "exception":true, "documentation":"The specified fleet has no available instances to fulfill a request to create a new game session. Such requests should only be retried once the fleet capacity has been increased.
" }, "FleetCapacityList":{ "type":"list", "member":{"shape":"FleetCapacity"} }, "FleetId":{ "type":"string", "pattern":"^fleet-\\S+" }, "FleetIdList":{ "type":"list", "member":{"shape":"FleetId"}, "min":1 }, "FleetStatus":{ "type":"string", "enum":[ "NEW", "DOWNLOADING", "VALIDATING", "BUILDING", "ACTIVATING", "ACTIVE", "DELETING", "ERROR", "TERMINATED" ] }, "FleetUtilization":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for a fleet.
" }, "ActiveServerProcessCount":{ "shape":"WholeNumber", "documentation":"Number of server processes in an ACTIVE status currently running across all instances in the fleet
Number of active game sessions currently being hosted on all instances in the fleet.
" }, "CurrentPlayerSessionCount":{ "shape":"WholeNumber", "documentation":"Number of active player sessions currently being hosted on all instances in the fleet.
" }, "MaximumPlayerSessionCount":{ "shape":"WholeNumber", "documentation":"Maximum players allowed across all game sessions currently being hosted on all instances in the fleet.
" } }, "documentation":"Current status of fleet utilization, including the number of game and player sessions being hosted.
" }, "FleetUtilizationList":{ "type":"list", "member":{"shape":"FleetUtilization"} }, "FreeText":{"type":"string"}, "GameProperty":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{"shape":"GamePropertyKey"}, "Value":{"shape":"GamePropertyValue"} }, "documentation":"Set of key-value pairs containing information a server process requires to set up a game session. This object allows you to pass in any set of data needed for your game. For more information, see the Amazon GameLift Developer Guide.
" }, "GamePropertyKey":{ "type":"string", "max":32 }, "GamePropertyList":{ "type":"list", "member":{"shape":"GameProperty"}, "max":16 }, "GamePropertyValue":{ "type":"string", "max":96 }, "GameSession":{ "type":"structure", "members":{ "GameSessionId":{ "shape":"GameSessionId", "documentation":"Unique identifier for a game session.
" }, "Name":{ "shape":"NonZeroAndMaxString", "documentation":"Descriptive label associated with a game session. Session names do not need to be unique.
" }, "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for a fleet.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\".
" }, "TerminationTime":{ "shape":"Timestamp", "documentation":"Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\".
" }, "CurrentPlayerSessionCount":{ "shape":"WholeNumber", "documentation":"Number of players currently in the game session.
" }, "MaximumPlayerSessionCount":{ "shape":"WholeNumber", "documentation":"Maximum number of players allowed in the game session.
" }, "Status":{ "shape":"GameSessionStatus", "documentation":"Current status of the game session. A game session must be in an ACTIVE status to have player sessions.
Set of custom properties for the game session.
" }, "IpAddress":{ "shape":"IpAddress", "documentation":"IP address of the game session. To connect to a GameLift server process, an app needs both the IP address and port number.
" }, "Port":{ "shape":"PortNumber", "documentation":"Port number for the game session. To connect to a GameLift server process, an app needs both the IP address and port number.
" }, "PlayerSessionCreationPolicy":{ "shape":"PlayerSessionCreationPolicy", "documentation":"Indicates whether or not the game session is accepting new players.
" } }, "documentation":"Properties describing a game session.
" }, "GameSessionDetail":{ "type":"structure", "members":{ "GameSession":{"shape":"GameSession"}, "ProtectionPolicy":{ "shape":"ProtectionPolicy", "documentation":"Current status of protection for the game session.
ACTIVE status, it cannot be terminated during a scale-down event.A game session's properties and the protection policy currently in force.
" }, "GameSessionDetailList":{ "type":"list", "member":{"shape":"GameSessionDetail"} }, "GameSessionFullException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "exception":true, "documentation":"The game instance is currently full and cannot allow the requested player(s) to join. This exception occurs in response to a CreatePlayerSession request.
" }, "GameSessionId":{ "type":"string", "pattern":"^(gamei-|gsess-)\\S+" }, "GameSessionList":{ "type":"list", "member":{"shape":"GameSession"} }, "GameSessionStatus":{ "type":"string", "enum":[ "ACTIVE", "ACTIVATING", "TERMINATED", "TERMINATING" ] }, "GetGameSessionLogUrlInput":{ "type":"structure", "required":["GameSessionId"], "members":{ "GameSessionId":{ "shape":"GameSessionId", "documentation":"Unique identifier for a game session. Specify the game session you want to get logs for.
" } }, "documentation":"Represents the input for a request action.
" }, "GetGameSessionLogUrlOutput":{ "type":"structure", "members":{ "PreSignedUrl":{ "shape":"NonZeroAndMaxString", "documentation":"Location of the requested game session logs, available for download.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "Integer":{"type":"integer"}, "InternalServiceException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "exception":true, "fault":true, "documentation":"The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests, either immediately or after a back-off period.
" }, "InvalidFleetStatusException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "exception":true, "documentation":"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.
" }, "InvalidGameSessionStatusException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "exception":true, "documentation":"The requested operation would cause a conflict with the current state of a resource associated with the request and/or the game instance. Clients should not retry such requests without resolving the conflict.
" }, "InvalidRequestException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "exception":true, "documentation":"One or more parameters specified as part of the request are invalid. Correct the invalid parameters before retrying.
" }, "IpAddress":{"type":"string"}, "IpPermission":{ "type":"structure", "required":[ "FromPort", "ToPort", "IpRange", "Protocol" ], "members":{ "FromPort":{ "shape":"PortNumber", "documentation":"Starting value for a range of allowed port numbers.
" }, "ToPort":{ "shape":"PortNumber", "documentation":"Ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be higher than FromPort.
Range of allowed IP addresses. This value must be expressed in CIDR notation. Example: \"000.000.000.000/[subnet mask]\" or optionally the shortened version \"0.0.0.0/[subnet mask]\".
Network communication protocol used by the fleet.
" } }, "documentation":"A range of IP addresses and port settings that allow inbound traffic to connect to server processes on 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.
" }, "IpPermissionsList":{ "type":"list", "member":{"shape":"IpPermission"}, "max":50 }, "IpProtocol":{ "type":"string", "enum":[ "TCP", "UDP" ] }, "LimitExceededException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "exception":true, "documentation":"The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue before retrying.
" }, "ListAliasesInput":{ "type":"structure", "members":{ "RoutingStrategyType":{ "shape":"RoutingStrategyType", "documentation":"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 the following:
Descriptive label associated with an alias. Alias names do not need to be unique.
" }, "Limit":{ "shape":"PositiveInteger", "documentation":"Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } }, "documentation":"Represents the input for a request action.
" }, "ListAliasesOutput":{ "type":"structure", "members":{ "Aliases":{ "shape":"AliasList", "documentation":"Collection of alias records that match the list request.
" }, "NextToken":{ "shape":"NonEmptyString", "documentation":"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.
Represents the returned data in response to a request action.
" }, "ListBuildsInput":{ "type":"structure", "members":{ "Status":{ "shape":"BuildStatus", "documentation":"Build status to filter results by. To retrieve all builds, leave this parameter empty.
Possible build statuses include the following:
Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } }, "documentation":"Represents the input for a request action.
" }, "ListBuildsOutput":{ "type":"structure", "members":{ "Builds":{ "shape":"BuildList", "documentation":"Collection of build records that match the request.
" }, "NextToken":{ "shape":"NonEmptyString", "documentation":"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.
Represents the returned data in response to a request action.
" }, "ListFleetsInput":{ "type":"structure", "members":{ "BuildId":{ "shape":"BuildId", "documentation":"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.
" }, "Limit":{ "shape":"PositiveInteger", "documentation":"Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
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.
" } }, "documentation":"Represents the input for a request action.
" }, "ListFleetsOutput":{ "type":"structure", "members":{ "FleetIds":{ "shape":"FleetIdList", "documentation":"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.
" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"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.
Represents the returned data in response to a request action.
" }, "MetricName":{ "type":"string", "enum":[ "ActivatingGameSessions", "ActiveGameSessions", "ActiveInstances", "AvailablePlayerSessions", "CurrentPlayerSessions", "IdleInstances" ] }, "NonBlankString":{ "type":"string", "pattern":"[^\\s]+" }, "NonEmptyString":{ "type":"string", "min":1 }, "NonZeroAndMaxString":{ "type":"string", "min":1, "max":1024 }, "NotFoundException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "exception":true, "documentation":"A service resource associated with the request could not be found. Clients should not retry such requests
" }, "OperatingSystem":{ "type":"string", "enum":[ "WINDOWS_2012", "AMAZON_LINUX" ] }, "PlayerIdList":{ "type":"list", "member":{"shape":"NonZeroAndMaxString"}, "min":1, "max":25 }, "PlayerSession":{ "type":"structure", "members":{ "PlayerSessionId":{ "shape":"PlayerSessionId", "documentation":"Unique identifier for a player session.
" }, "PlayerId":{ "shape":"NonZeroAndMaxString", "documentation":"Unique identifier for a player.
" }, "GameSessionId":{ "shape":"GameSessionId", "documentation":"Unique identifier for a game session.
" }, "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for a fleet.
" }, "CreationTime":{ "shape":"Timestamp", "documentation":"Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\".
" }, "TerminationTime":{ "shape":"Timestamp", "documentation":"Time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (ex: \"1469498468.057\".
" }, "Status":{ "shape":"PlayerSessionStatus", "documentation":"Current status of the player session.
Possible player session statuses include the following:
Game session IP address. All player sessions reference the game session location.
" }, "Port":{ "shape":"PortNumber", "documentation":"Port number for the game session. To connect to a GameLift server process, an app needs both the IP address and port number.
" } }, "documentation":"Properties describing a player session.
" }, "PlayerSessionCreationPolicy":{ "type":"string", "enum":[ "ACCEPT_ALL", "DENY_ALL" ] }, "PlayerSessionId":{ "type":"string", "pattern":"^psess-\\S+" }, "PlayerSessionList":{ "type":"list", "member":{"shape":"PlayerSession"} }, "PlayerSessionStatus":{ "type":"string", "enum":[ "RESERVED", "ACTIVE", "COMPLETED", "TIMEDOUT" ] }, "PortNumber":{ "type":"integer", "min":1025, "max":60000 }, "PositiveInteger":{ "type":"integer", "min":1 }, "PositiveLong":{ "type":"long", "min":1 }, "ProtectionPolicy":{ "type":"string", "enum":[ "NoProtection", "FullProtection" ] }, "PutScalingPolicyInput":{ "type":"structure", "required":[ "Name", "FleetId", "ScalingAdjustment", "ScalingAdjustmentType", "Threshold", "ComparisonOperator", "EvaluationPeriods", "MetricName" ], "members":{ "Name":{ "shape":"NonZeroAndMaxString", "documentation":"Descriptive label associated with a scaling policy. Policy names do not need to be unique. A fleet can have only one scaling policy with the same name.
" }, "FleetId":{ "shape":"FleetId", "documentation":"Unique identity for the fleet to scale with this policy.
" }, "ScalingAdjustment":{ "shape":"Integer", "documentation":"Amount of adjustment to make, based on the scaling adjustment type.
" }, "ScalingAdjustmentType":{ "shape":"ScalingAdjustmentType", "documentation":"Type of adjustment to make to a fleet's instance count (see FleetCapacity):
Metric value used to trigger a scaling event.
" }, "ComparisonOperator":{ "shape":"ComparisonOperatorType", "documentation":"Comparison operator to use when measuring the metric against the threshold value.
" }, "EvaluationPeriods":{ "shape":"PositiveInteger", "documentation":"Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
" }, "MetricName":{ "shape":"MetricName", "documentation":"Name of the Amazon GameLift-defined metric that is used to trigger an adjustment.
ACTIVATING).ACTIVE).ACTIVE or RESERVED). PlayerSessionCreationPolicy = DENY_ALL).Represents the input for a request action.
" }, "PutScalingPolicyOutput":{ "type":"structure", "members":{ "Name":{ "shape":"NonZeroAndMaxString", "documentation":"Descriptive label associated with a scaling policy. Policy names do not need to be unique.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "RequestUploadCredentialsInput":{ "type":"structure", "required":["BuildId"], "members":{ "BuildId":{ "shape":"BuildId", "documentation":"Unique identifier for the build you want to get credentials for.
" } }, "documentation":"Represents the input for a request action.
" }, "RequestUploadCredentialsOutput":{ "type":"structure", "members":{ "UploadCredentials":{ "shape":"AwsCredentials", "documentation":"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.
" }, "StorageLocation":{ "shape":"S3Location", "documentation":"Amazon S3 path and key, identifying where the game build files are stored.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "ResolveAliasInput":{ "type":"structure", "required":["AliasId"], "members":{ "AliasId":{ "shape":"AliasId", "documentation":"Unique identifier for the alias you want to resolve.
" } }, "documentation":"Represents the input for a request action.
" }, "ResolveAliasOutput":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Fleet ID associated with the requested alias.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "RoutingStrategy":{ "type":"structure", "members":{ "Type":{ "shape":"RoutingStrategyType", "documentation":"Type of routing strategy.
Possible routing types include the following:
Unique identifier for a fleet.
" }, "Message":{ "shape":"FreeText", "documentation":"Message text to be used with a terminal routing strategy.
" } }, "documentation":"Routing configuration for a fleet alias.
" }, "RoutingStrategyType":{ "type":"string", "enum":[ "SIMPLE", "TERMINAL" ] }, "RuntimeConfiguration":{ "type":"structure", "members":{ "ServerProcesses":{ "shape":"ServerProcessList", "documentation":"Collection of server process configurations describing what server processes to run on each instance in a fleet
" } }, "documentation":"Collection of server process configurations that describe what processes should be run on each instance in a fleet. An instance can launch and maintain multiple server processes based on the runtime configuration; it regularly checks for an updated runtime configuration and starts new server processes to match the latest version.
The key purpose of a runtime configuration with multiple server process configurations is to be able to run more than one kind of game server in a single fleet. You can include configurations for more than one server executable in order to run two or more different programs to run on the same instance. This option might be useful, for example, to run more than one version of your game server on the same fleet. Another option is to specify configurations for the same server executable but with different launch parameters.
A GameLift instance is limited to 50 processes running simultaneously. To calculate the total number of processes specified in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the runtime configuration.
Amazon S3 bucket identifier.
" }, "Key":{ "shape":"NonEmptyString", "documentation":"Amazon S3 bucket key.
" }, "RoleArn":{ "shape":"NonEmptyString", "documentation":"Amazon resource number for the cross-account access role that allows GameLift access to the S3 bucket.
" } }, "documentation":"Location in Amazon Simple Storage Service (Amazon S3) where a build's files are stored. This location is assigned in response to a CreateBuild call, and is always in the same region as the service used to create the build. For more details see the Amazon S3 documentation.
" }, "ScalingAdjustmentType":{ "type":"string", "enum":[ "ChangeInCapacity", "ExactCapacity", "PercentChangeInCapacity" ] }, "ScalingPolicy":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identity for the fleet associated with this scaling policy.
" }, "Name":{ "shape":"NonZeroAndMaxString", "documentation":"Descriptive label associated with a scaling policy. Policy names do not need to be unique.
" }, "Status":{ "shape":"ScalingStatusType", "documentation":"Current status of the scaling policy. The scaling policy is only in force when in an ACTIVE status.
Amount of adjustment to make, based on the scaling adjustment type.
" }, "ScalingAdjustmentType":{ "shape":"ScalingAdjustmentType", "documentation":"Type of adjustment to make to a fleet's instance count (see FleetCapacity):
Comparison operator to use when measuring a metric against the threshold value.
" }, "Threshold":{ "shape":"Double", "documentation":"Metric value used to trigger a scaling event.
" }, "EvaluationPeriods":{ "shape":"PositiveInteger", "documentation":"Length of time (in minutes) the metric must be at or beyond the threshold before a scaling event is triggered.
" }, "MetricName":{ "shape":"MetricName", "documentation":"Name of the GameLift-defined metric that is used to trigger an adjustment.
ACTIVATING).ACTIVE).ACTIVE or RESERVED). PlayerSessionCreationPolicy = DENY_ALL).Rule that controls how a fleet is scaled. Scaling policies are uniquely identified by the combination of name and fleet ID.
" }, "ScalingPolicyList":{ "type":"list", "member":{"shape":"ScalingPolicy"} }, "ScalingStatusType":{ "type":"string", "enum":[ "ACTIVE", "UPDATE_REQUESTED", "UPDATING", "DELETE_REQUESTED", "DELETING", "DELETED", "ERROR" ] }, "SearchGameSessionsInput":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.
" }, "AliasId":{ "shape":"AliasId", "documentation":"Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.
" }, "FilterExpression":{ "shape":"NonZeroAndMaxString", "documentation":"String containing the search criteria for the session search. If no filter expression is included, the request returns results for all game sessions in the fleet that are in ACTIVE status.
A filter expression can contain one or multiple conditions. Each condition consists of the following:
gameSessionName, gameSessionId, creationTimeMillis, playerSessionCount, maximumSessions, hasAvailablePlayerSessions.=, <>, <, >, <=, >=. = and <>. For example, the following filter expression searches on gameSessionName: \"FilterExpression\": \"gameSessionName = 'Matt\\\\'s Awesome Game 1'\". To chain multiple conditions in a single expression, use the logical keywords AND, OR, and NOT and parentheses as needed. For example: x AND y AND NOT z, NOT (x OR y).
Session search evaluates conditions from left to right using the following precedence rules:
=, <>, <, >, <=, >= For example, this filter expression retrieves game sessions hosting at least ten players that have an open player slot: \"maximumSessions>=10 AND hasAvailablePlayerSessions=true\".
Instructions on how to sort the search results. If no sort expression is included, the request returns results in random order. A sort expression consists of the following elements:
gameSessionName, gameSessionId, creationTimeMillis, playerSessionCount, maximumSessions, hasAvailablePlayerSessions.ASC (ascending) and DESC (descending).For example, this sort expression returns the oldest active sessions first: \"SortExpression\": \"creationTimeMillis ASC\". Results with a null value for the sort operand are returned at the end of the list.
Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. The maximum number of results returned is 20, even if this value is not set or is set higher than 20.
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.
" } }, "documentation":"Represents the input for a request action.
" }, "SearchGameSessionsOutput":{ "type":"structure", "members":{ "GameSessions":{ "shape":"GameSessionList", "documentation":"Collection of objects containing game session properties for each session matching the request.
" }, "NextToken":{ "shape":"NonZeroAndMaxString", "documentation":"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.
Represents the returned data in response to a request action.
" }, "ServerProcess":{ "type":"structure", "required":[ "LaunchPath", "ConcurrentExecutions" ], "members":{ "LaunchPath":{ "shape":"NonZeroAndMaxString", "documentation":"Location in the game build of the server executable. All game builds are installed on instances at the root C:\\game\\..., so an executable file located at MyGame\\latest\\server.exe has a launch path of \"C:\\game\\MyGame\\latest\\server.exe\".
Optional list of parameters to pass to the server executable on launch.
" }, "ConcurrentExecutions":{ "shape":"PositiveInteger", "documentation":"Number of server processes using this configuration to run concurrently on an instance.
" } }, "documentation":"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's RuntimeConfiguration.
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.
" }, "Timestamp":{"type":"timestamp"}, "UnauthorizedException":{ "type":"structure", "members":{ "Message":{"shape":"NonEmptyString"} }, "exception":true, "documentation":"The client failed authentication. Clients should not retry such requests
" }, "UpdateAliasInput":{ "type":"structure", "required":["AliasId"], "members":{ "AliasId":{ "shape":"AliasId", "documentation":"Unique identifier for a fleet alias. Specify the alias you want to update.
" }, "Name":{ "shape":"NonZeroAndMaxString", "documentation":"Descriptive label associated with an alias. Alias names do not need to be unique.
" }, "Description":{ "shape":"NonZeroAndMaxString", "documentation":"Human-readable description of an alias.
" }, "RoutingStrategy":{ "shape":"RoutingStrategy", "documentation":"Object specifying the fleet and routing type to use for the alias.
" } }, "documentation":"Represents the input for a request action.
" }, "UpdateAliasOutput":{ "type":"structure", "members":{ "Alias":{ "shape":"Alias", "documentation":"Object containing the updated alias configuration.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "UpdateBuildInput":{ "type":"structure", "required":["BuildId"], "members":{ "BuildId":{ "shape":"BuildId", "documentation":"Unique identifier of the build you want to update.
" }, "Name":{ "shape":"NonZeroAndMaxString", "documentation":"Descriptive label associated with a build. Build names do not need to be unique.
" }, "Version":{ "shape":"NonZeroAndMaxString", "documentation":"Version associated with this build. Version strings do not need to be unique to a build.
" } }, "documentation":"Represents the input for a request action.
" }, "UpdateBuildOutput":{ "type":"structure", "members":{ "Build":{ "shape":"Build", "documentation":"Object containing the updated build record.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "UpdateFleetAttributesInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for the fleet you want to update attribute metadata for.
" }, "Name":{ "shape":"NonZeroAndMaxString", "documentation":"Descriptive label associated with a fleet. Fleet names do not need to be unique.
" }, "Description":{ "shape":"NonZeroAndMaxString", "documentation":"Human-readable description of a fleet.
" }, "NewGameSessionProtectionPolicy":{ "shape":"ProtectionPolicy", "documentation":"Game session protection policy to apply to all new instances created in this fleet. Instances that already exist are not affected. You can set protection for individual instances using UpdateGameSession.
ACTIVE status, it cannot be terminated during a scale-down event.Represents the input for a request action.
" }, "UpdateFleetAttributesOutput":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for the updated fleet.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "UpdateFleetCapacityInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for the fleet you want to update capacity for.
" }, "DesiredInstances":{ "shape":"WholeNumber", "documentation":"Number of EC2 instances you want this fleet to host.
" }, "MinSize":{ "shape":"WholeNumber", "documentation":"Minimum value allowed for the fleet's instance count. Default if not set is 0.
" }, "MaxSize":{ "shape":"WholeNumber", "documentation":"Maximum value allowed for the fleet's instance count. Default if not set is 1.
" } }, "documentation":"Represents the input for a request action.
" }, "UpdateFleetCapacityOutput":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for the updated fleet.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "UpdateFleetPortSettingsInput":{ "type":"structure", "required":["FleetId"], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for the fleet you want to update port settings for.
" }, "InboundPermissionAuthorizations":{ "shape":"IpPermissionsList", "documentation":"Collection of port settings to be added to the fleet record.
" }, "InboundPermissionRevocations":{ "shape":"IpPermissionsList", "documentation":"Collection of port settings to be removed from the fleet record.
" } }, "documentation":"Represents the input for a request action.
" }, "UpdateFleetPortSettingsOutput":{ "type":"structure", "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier for the updated fleet.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "UpdateGameSessionInput":{ "type":"structure", "required":["GameSessionId"], "members":{ "GameSessionId":{ "shape":"GameSessionId", "documentation":"Unique identifier for a game session. Specify the game session you want to update.
" }, "MaximumPlayerSessionCount":{ "shape":"WholeNumber", "documentation":"Maximum number of players that can be simultaneously connected to the game session.
" }, "Name":{ "shape":"NonZeroAndMaxString", "documentation":"Descriptive label associated with a game session. Session names do not need to be unique.
" }, "PlayerSessionCreationPolicy":{ "shape":"PlayerSessionCreationPolicy", "documentation":"Policy determining whether or not the game session accepts new players.
" }, "ProtectionPolicy":{ "shape":"ProtectionPolicy", "documentation":"Game session protection policy to apply to this game session only.
ACTIVE status, it cannot be terminated during a scale-down event.Represents the input for a request action.
" }, "UpdateGameSessionOutput":{ "type":"structure", "members":{ "GameSession":{ "shape":"GameSession", "documentation":"Object containing the updated game session metadata.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "UpdateRuntimeConfigurationInput":{ "type":"structure", "required":[ "FleetId", "RuntimeConfiguration" ], "members":{ "FleetId":{ "shape":"FleetId", "documentation":"Unique identifier of the fleet to update runtime configuration for.
" }, "RuntimeConfiguration":{ "shape":"RuntimeConfiguration", "documentation":"Instructions for launching server processes on each instance in the fleet. The runtime configuration for a fleet has a collection of server process configurations, one for each type of server process to run on an instance. A server process configuration specifies the location of the server executable, launch parameters, and the number of concurrent processes with that configuration to maintain on each instance.
" } }, "documentation":"Represents the input for a request action.
" }, "UpdateRuntimeConfigurationOutput":{ "type":"structure", "members":{ "RuntimeConfiguration":{ "shape":"RuntimeConfiguration", "documentation":"The runtime configuration currently in force. If the update was successful, this object matches the one in the request.
" } }, "documentation":"Represents the returned data in response to a request action.
" }, "WholeNumber":{ "type":"integer", "min":0 } }, "examples":{ } }