models.gamelift-2015-10-01-model.json Maven / Gradle / Ivy
Show all versions of aws-java-sdk-gamelift Show documentation
{
"version":"2.0",
"metadata":{
"apiVersion":"2015-10-01",
"endpointPrefix":"gamelift",
"jsonVersion":"1.1",
"serviceFullName":"Amazon GameLift",
"signatureVersion":"v4",
"targetPrefix":"GameLift",
"protocol":"json"
},
"documentation":"Amazon GameLift Service 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. For more information about the GameLift service, including a feature overview, getting started guide, and tutorial, see the accompanying Amazon GameLift Developer Guide.
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 use the Amazon GameLift console.
Managing Game and Player Sessions Through GameLift
Call these actions from your game clients and/or services to create and manage multiplayer game sessions.
- Game sessions
- Player sessions
- Other actions:
Setting Up Game Servers
Use these administrative actions to configure GameLift to host your game servers. When configuring GameLift, you'll need to (1) configure a build for your game and provide build files, and (2) set up one or more fleets to host game sessions.
- Build actions:
- Fleet actions:
- Alias actions:
- Scaling policy actions:
",
"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. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please 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. Please 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. Such requests can be retried by clients, 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. Please 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. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please 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. Please 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. Such requests can be retried by clients, 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 is in an INITIALIZED state, you can upload your game build.
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 for more details on the CLI and the upload process.) Call the CreateBuild action only if you have your own Amazon Simple Storage Service (Amazon S3) client and need to manually upload your build files.
To create a new build, 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 (but not visible to players). If successful, this action returns the newly created build record along with an 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. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"ConflictException",
"exception":true,
"documentation":"The requested operation would cause a conflict with the current state of a service resource associated with the request. Please resolve the conflict before retrying this request.
"
},
{
"shape":"LimitExceededException",
"exception":true,
"documentation":"The requested operation would cause the resource to exceed the allowed service limit. Please resolve the issue before retrying.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
}
],
"documentation":"Creates a new fleet to host game servers. A fleet consists of a set of Amazon Elastic Compute Cloud (Amazon EC2) instances of a certain type, which defines the CPU, memory, storage, and networking capacity of each host in the fleet. See Amazon EC2 Instance Types for more information. Each instance in the fleet hosts a game server created from the specified game build. Once a fleet is in an ACTIVE state, it can begin hosting game sessions.
To create a new fleet, provide a name and the EC2 instance type for the new fleet, and specify the build and server launch path. Builds must be in a READY state before they can be used to build fleets. When configuring the new fleet, you can optionally (1) provide a set of launch parameters to be passed to a game server when activated; (2) limit incoming traffic to a specified range of IP addresses and port numbers; (3) set game session protection for all instances in the fleet, and (4) configure Amazon GameLift to store game session logs by specifying the path to the logs stored in your game server files. If the call is successful, Amazon GameLift performs the following tasks:
- Creates a fleet record and sets the state to NEW.
- Sets the fleet's capacity to 1 \"desired\" and 1 \"active\" EC2 instance count.
- Creates an EC2 instance and begins the process of initializing the fleet and activating a game server on the instance.
- Begins writing events to the fleet event log, which can be accessed in the GameLift console.
Once a fleet is created, use the following actions to change certain fleet properties (server launch parameters and log paths cannot be changed):
- UpdateFleetAttributes -- Update fleet metadata, including name and description.
- UpdateFleetCapacity -- Increase or decrease the number of instances you want the fleet to maintain.
- UpdateFleetPortSettings -- Change the IP addresses and ports that allow access to incoming traffic.
"
},
"CreateGameSession":{
"name":"CreateGameSession",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{
"shape":"CreateGameSessionInput",
"documentation":"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. Please 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. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
},
{
"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. Please 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 TerminalRoutingStrategy 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. Please correct the invalid parameters before retrying.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"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 activates the server initialization process in your game server. A fleet must be in an ACTIVE state before a game session can be created for 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. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
},
{
"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. Such requests should not be retried by clients 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 TerminalRoutingStrategy 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. Please correct the invalid parameters before retrying.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
}
],
"documentation":"Adds a player to a game session and creates a player session record. A game session must be in an ACTIVE state, 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. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
},
{
"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. Such requests should not be retried by clients 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 TerminalRoutingStrategy 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. Please correct the invalid parameters before retrying.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
}
],
"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 state, 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. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
}
],
"documentation":"Deletes an alias. This action removes all record of the alias; game clients attempting to access a game server 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. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please 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, but you can no longer create new fleets for 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. Such requests should not be retried by clients.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"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. Please resolve the conflict before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please 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. Please resolve the conflict 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. Such requests can be retried by clients, 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. Please correct the invalid parameters before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
}
],
"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. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
}
],
"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. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
}
],
"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. Please correct the invalid parameters before retrying.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
}
],
"documentation":"Retrieves the following information for the specified EC2 instance type:
- maximum number of instances allowed per AWS account (service limit)
- current usage level for the AWS account
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. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
}
],
"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 all 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. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
}
],
"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 all 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. Such requests should not be retried by clients.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
}
],
"documentation":"Retrieves entries from the fleet 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. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
}
],
"documentation":"Retrieves the port settings for a fleet. Port settings are used to limit incoming traffic access to game servers in the fleet. To get a fleet's port settings, specify a fleet ID. If successful, an IpPermission object is returned for the requested fleet ID. If the requested fleet has been deleted, the result set will be 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. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
}
],
"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 all 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. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
},
{
"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 TerminalRoutingStrategy 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. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
},
{
"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 TerminalRoutingStrategy 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. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
}
],
"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.
"
},
"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. Such requests can be retried by clients, 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. Please correct the invalid parameters before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
}
],
"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. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please 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. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
}
],
"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. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
}
],
"documentation":"Retrieves build records for all builds associated with an AWS account. You can filter the result set by build status. 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. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
}
],
"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. Such requests can be retried by clients, 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. Please correct the invalid parameters before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
}
],
"documentation":"Creates or updates a scaling policy for a fleet. An active scaling policy prompts 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. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
}
],
"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 state of that build changes to READY. Once this happens, you must create a brand new build.
"
},
"ResolveAlias":{
"name":"ResolveAlias",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{
"shape":"ResolveAliasInput",
"documentation":"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. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"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 TerminalRoutingStrategy 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. Such requests can be retried by clients, either immediately or after a back-off period.
"
}
],
"documentation":"Retrieves the fleet ID that a specified alias is currently pointing to.
"
},
"UpdateAlias":{
"name":"UpdateAlias",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{
"shape":"UpdateAliasInput",
"documentation":"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. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
}
],
"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. Such requests should not be retried without valid authentication credentials.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"NotFoundException",
"exception":true,
"documentation":"A service resource associated with the request could not be found. Such requests should not be retried by clients.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
}
],
"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. Such requests should not be retried by clients.
"
},
{
"shape":"ConflictException",
"exception":true,
"documentation":"The requested operation would cause a conflict with the current state of a service resource associated with the request. Please resolve the conflict before retrying this request.
"
},
{
"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. Please resolve the conflict before retrying.
"
},
{
"shape":"LimitExceededException",
"exception":true,
"documentation":"The requested operation would cause the resource to exceed the allowed service limit. Please resolve the issue before retrying.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
}
],
"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. Such requests should not be retried by clients.
"
},
{
"shape":"ConflictException",
"exception":true,
"documentation":"The requested operation would cause a conflict with the current state of a service resource associated with the request. Please resolve the conflict before retrying this request.
"
},
{
"shape":"LimitExceededException",
"exception":true,
"documentation":"The requested operation would cause the resource to exceed the allowed service limit. Please 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. Please resolve the conflict before retrying.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
}
],
"documentation":"Updates capacity settings for a fleet. Use this action to specify the number of EC2 instances (hosts) 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 auto-scaling (see PutScalingPolicy), you may want to specify a minimum and/or maximum capacity. If you don't provide these boundaries, auto-scaling can set capacity anywhere between zero and the service limits.
To update fleet capacity, specify the fleet ID and the desired number of instances. 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 will occur.
"
},
"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. Such requests should not be retried by clients.
"
},
{
"shape":"ConflictException",
"exception":true,
"documentation":"The requested operation would cause a conflict with the current state of a service resource associated with the request. Please resolve the conflict before retrying this request.
"
},
{
"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. Please resolve the conflict before retrying.
"
},
{
"shape":"LimitExceededException",
"exception":true,
"documentation":"The requested operation would cause the resource to exceed the allowed service limit. Please resolve the issue before retrying.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please correct the invalid parameters before retrying.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
}
],
"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.
"
},
"UpdateGameSession":{
"name":"UpdateGameSession",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{
"shape":"UpdateGameSessionInput",
"documentation":"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. Such requests should not be retried by clients.
"
},
{
"shape":"ConflictException",
"exception":true,
"documentation":"The requested operation would cause a conflict with the current state of a service resource associated with the request. Please resolve the conflict before retrying this request.
"
},
{
"shape":"InternalServiceException",
"exception":true,
"fault":true,
"documentation":"The service encountered an unrecoverable internal failure while processing the request. Such requests can be retried by clients, either immediately or after a back-off period.
"
},
{
"shape":"UnauthorizedException",
"exception":true,
"documentation":"The client failed authentication. Such requests should not be retried without valid authentication credentials.
"
},
{
"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. Such requests should not be retried by clients without resolving the conflict.
"
},
{
"shape":"InvalidRequestException",
"exception":true,
"documentation":"One or more parameters specified as part of the request are invalid. Please 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.
"
}
},
"shapes":{
"Alias":{
"type":"structure",
"members":{
"AliasId":{
"shape":"AliasId",
"documentation":"Unique identifier for a fleet alias.
"
},
"Name":{
"shape":"FreeText",
"documentation":"Descriptive label associated with this alias. Alias names do not need to be unique.
"
},
"Description":{
"shape":"FreeText",
"documentation":"Human-readable description of the alias.
"
},
"RoutingStrategy":{"shape":"RoutingStrategy"},
"CreationTime":{
"shape":"Timestamp",
"documentation":"Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"Time stamp indicating when this object was last modified. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
"
}
},
"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 this 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 states include:
- INITIALIZED: A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this state. When a build is successfully created, the build state is set to this value.
- READY: The game build has been successfully uploaded. You can now create new fleets for this build.
- FAILED: The game build upload failed. You cannot create new fleets for this build.
"
},
"SizeOnDisk":{
"shape":"PositiveLong",
"documentation":"File size of the uploaded game build, expressed in bytes. When the build state is INITIALIZED, this value is 0.
"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
"
}
},
"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. Please resolve the conflict before retrying this request.
"
},
"CreateAliasInput":{
"type":"structure",
"required":[
"Name",
"RoutingStrategy"
],
"members":{
"Name":{
"shape":"NonZeroAndMaxString",
"documentation":"Descriptive label associated with this alias. Alias names do not need to be unique.
"
},
"Description":{
"shape":"NonZeroAndMaxString",
"documentation":"Human-readable description of the 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 this build. Build names do not need to be unique. A build name can be changed later using UpdateBuild.
"
},
"Version":{
"shape":"NonZeroAndMaxString",
"documentation":"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.
"
},
"StorageLocation":{"shape":"S3Location"}
},
"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.
"
},
"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.
"
},
"CreateFleetInput":{
"type":"structure",
"required":[
"Name",
"BuildId",
"ServerLaunchPath",
"EC2InstanceType"
],
"members":{
"Name":{
"shape":"NonZeroAndMaxString",
"documentation":"Descriptive label associated with this fleet. Fleet names do not need to be unique.
"
},
"Description":{
"shape":"NonZeroAndMaxString",
"documentation":"Human-readable description of the fleet.
"
},
"BuildId":{
"shape":"BuildId",
"documentation":"Unique identifier for the build you want the new fleet to use.
"
},
"ServerLaunchPath":{
"shape":"NonZeroAndMaxString",
"documentation":"Path to the launch executable for the game server. A game server is built into a C:\\game drive. This value must be expressed as C:\\game\\[launchpath]. Example: If, when built, your game server files are in a folder called \"MyGame\", your log path should be C:\\game\\MyGame\\server.exe.
"
},
"ServerLaunchParameters":{
"shape":"NonZeroAndMaxString",
"documentation":"Parameters required to launch your game server. These parameters should be expressed as a string of command-line parameters. Example: \"+sv_port 33435 +start_lobby\".
"
},
"LogPaths":{
"shape":"StringList",
"documentation":"Path to game-session log files generated by your game server. Once a game session has been terminated, Amazon GameLift captures and stores the logs on Amazon S3. Use the GameLift console to access the stored logs.
"
},
"EC2InstanceType":{
"shape":"EC2InstanceType",
"documentation":"Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each.
"
},
"EC2InboundPermissions":{
"shape":"IpPermissionsList",
"documentation":"Access limits for incoming traffic. Setting these values limits game server access to incoming traffic using specified IP ranges and port numbers. Some ports in a range may be restricted. You can provide one or more sets of permissions for the fleet.
"
},
"NewGameSessionProtectionPolicy":{
"shape":"ProtectionPolicy",
"documentation":"Game session protection policy to apply to all instances created in this fleet. If this parameter is not set, new instances in this fleet will default to no protection. Protection can be set for individual instances using UpdateGameSession.
- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
"
}
},
"documentation":"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 this 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 your game server.
"
}
},
"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 this 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 for the build 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":"Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each. Leave this parameter blank to retrieve limits for all types.
"
}
},
"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. Leave this parameter empty to retrieve attributes for all fleets.
"
},
"Limit":{
"shape":"PositiveInteger",
"documentation":"Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
"
},
"NextToken":{
"shape":"NonZeroAndMaxString",
"documentation":"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.
"
},
"Limit":{
"shape":"PositiveInteger",
"documentation":"Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
"
},
"NextToken":{
"shape":"NonZeroAndMaxString",
"documentation":"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 an integer representing the number of seconds since the Unix epoch (Unix time).
"
},
"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 an integer representing the number of seconds since the Unix epoch (Unix time).
"
},
"Limit":{
"shape":"PositiveInteger",
"documentation":"Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
"
},
"NextToken":{
"shape":"NonZeroAndMaxString",
"documentation":"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. Leave this parameter empty to retrieve utilization data for all fleets.
"
},
"Limit":{
"shape":"PositiveInteger",
"documentation":"Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
"
},
"NextToken":{
"shape":"NonZeroAndMaxString",
"documentation":"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 states include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).
"
},
"Limit":{
"shape":"PositiveInteger",
"documentation":"Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
"
},
"NextToken":{
"shape":"NonZeroAndMaxString",
"documentation":"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 states include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).
"
},
"Limit":{
"shape":"PositiveInteger",
"documentation":"Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
"
},
"NextToken":{
"shape":"NonZeroAndMaxString",
"documentation":"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 states include:
- RESERVED: The player session request has been received, but the player has not yet connected to the game server and/or been validated.
- ACTIVE: The player has been validated by the game server and is currently connected.
- COMPLETED: The player connection has been dropped.
- TIMEDOUT: A player session request was received, but the player did not connect and/or was not validated within the time-out limit (60 seconds).
"
},
"Limit":{
"shape":"PositiveInteger",
"documentation":"Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages. If a player session ID is specified, this parameter is ignored.
"
},
"NextToken":{
"shape":"NonZeroAndMaxString",
"documentation":"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.
"
},
"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":"Game session status to filter results on. A scaling policy is only in force when in an Active state.
- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: A request to delete the scaling policy has been received.
- DELETING: The scaling policy is being deleted.
- DELETED: The scaling policy has been deleted.
- ERROR: An error occurred in creating the policy. It should be removed and recreated.
"
},
"Limit":{
"shape":"PositiveInteger",
"documentation":"Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
"
},
"NextToken":{
"shape":"NonZeroAndMaxString",
"documentation":"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":"Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each.
"
},
"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 an integer representing the number of seconds since the Unix epoch (Unix time).
"
}
},
"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 this fleet. Fleet names do not need to be unique.
"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"Time stamp indicating when this object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
"
},
"TerminationTime":{
"shape":"Timestamp",
"documentation":"Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
"
},
"Status":{
"shape":"FleetStatus",
"documentation":"Current status of the fleet. Possible fleet states include:
- NEW: A new fleet has been defined and hosts allocated.
- DOWNLOADING/VALIDATING/BUILDING/ACTIVATING: The new fleet is being set up with the game build, and new hosts are being started.
- ACTIVE: Hosts can now accept game sessions.
- ERROR: An error occurred when downloading, validating, building, or activating the fleet.
- DELETING: Hosts are responding to a delete fleet request.
- TERMINATED: The fleet no longer exists.
"
},
"BuildId":{
"shape":"BuildId",
"documentation":"Unique identifier for a build.
"
},
"ServerLaunchPath":{
"shape":"NonZeroAndMaxString",
"documentation":"Path to the launch executable for the game server. A game server is built into a C:\\game drive. This value must be expressed as C:\\game\\[launchpath]. Example: If, when built, your game server files are in a folder called \"MyGame\", your log path should be C:\\game\\MyGame\\server.exe.
"
},
"ServerLaunchParameters":{
"shape":"NonZeroAndMaxString",
"documentation":"Parameters required to launch your game server. These parameters should be expressed as a string of command-line parameters. Example: \"+sv_port 33435 +start_lobby\".
"
},
"LogPaths":{
"shape":"StringList",
"documentation":"Path to game-session log files generated by your game server. Once a game session has been terminated, Amazon GameLift captures and stores the logs on Amazon S3. Use the GameLift console to access the stored logs.
"
},
"NewGameSessionProtectionPolicy":{
"shape":"ProtectionPolicy",
"documentation":"Type of game session protection to set for all new instances started in the fleet.
- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
"
}
},
"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":"Type of EC2 instances used in the fleet. EC2 instance types define the CPU, memory, storage, and networking capacity of the fleetaposs hosts. Amazon GameLift supports the EC2 instance types listed below. See Amazon EC2 Instance Types for detailed descriptions of each.
"
},
"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.
"
},
"ActiveGameSessionCount":{
"shape":"WholeNumber",
"documentation":"Number of active game sessions currently being hosted on fleet game servers.
"
},
"CurrentPlayerSessionCount":{
"shape":"WholeNumber",
"documentation":"Number of active player sessions currently being hosted on fleet game servers.
"
},
"MaximumPlayerSessionCount":{
"shape":"WholeNumber",
"documentation":"Maximum players allowed across all game sessions currently hosted 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 your game server requires to set up sessions. This object allows you to pass in any set of data needed for your game. For more information, see the Amazon GameLift Developer Guide.
"
},
"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 this 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 object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
"
},
"TerminationTime":{
"shape":"Timestamp",
"documentation":"Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
"
},
"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 state to have player sessions.
"
},
"GameProperties":{
"shape":"GamePropertyList",
"documentation":"Set of custom properties for the game session.
"
},
"IpAddress":{
"shape":"IpAddress",
"documentation":"IP address of the game session.
"
},
"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.
- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
"
}
},
"documentation":"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. Such requests can be retried by clients, 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. Please 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. Such requests should not be retried by clients 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. Please 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.
"
},
"IpRange":{
"shape":"NonBlankString",
"documentation":"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]\".
"
},
"Protocol":{
"shape":"IpProtocol",
"documentation":"Network communication protocol used by the fleet.
"
}
},
"documentation":"IP addresses and port settings used to limit access by incoming traffic (players) to a fleet. Permissions specify a range of IP addresses and port settings that must be used to gain access to a game server on a fleet machine.
"
},
"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. Please 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:
- SIMPLE: The alias resolves to one specific fleet. Use this type when routing to active fleets.
- TERMINAL: The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.
"
},
"Name":{
"shape":"NonEmptyString",
"documentation":"Descriptive label associated with this alias. Alias names do not need to be unique.
"
},
"Limit":{
"shape":"PositiveInteger",
"documentation":"Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
"
},
"NextToken":{
"shape":"NonEmptyString",
"documentation":"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 state to filter results on. Use this parameter to retrieve builds in a certain state. To retrieve all builds, leave this parameter empty. Possible build states include:
- INITIALIZED: A new build has been defined, but no files have been uploaded. You cannot create fleets for builds that are in this state. When a build is successfully created, the build state is set to this value.
- READY: The game build has been successfully uploaded. You can now create new fleets for this build.
- FAILED: The game build upload failed. You cannot create new fleets for this build.
"
},
"Limit":{
"shape":"PositiveInteger",
"documentation":"Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.
"
},
"NextToken":{
"shape":"NonEmptyString",
"documentation":"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. You can use this parameter with NextToken to get results as a set of sequential pages.
"
},
"NextToken":{
"shape":"NonZeroAndMaxString",
"documentation":"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. Such requests should not be retried by clients.
"
},
"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 object was created. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
"
},
"TerminationTime":{
"shape":"Timestamp",
"documentation":"Time stamp indicating when this fleet was terminated. Format is an integer representing the number of seconds since the Unix epoch (Unix time).
"
},
"Status":{
"shape":"PlayerSessionStatus",
"documentation":"Current status of the player session. Possible player session states include:
- RESERVED: The player session request has been received, but the player has not yet connected to the game server and/or been validated.
- ACTIVE: The player has been validated by the game server and is currently connected.
- COMPLETED: The player connection has been dropped.
- TIMEDOUT: A player session request was received, but the player did not connect and/or was not validated within the time-out limit (60 seconds).
"
},
"IpAddress":{
"shape":"IpAddress",
"documentation":"Game session IP address. All player sessions reference the game session location.
"
}
},
"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 this 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):
- ChangeInCapacity: add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
- ExactCapacity: set the instance count to the scaling adjustment value.
- PercentChangeInCapacity: increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down; for example, a value of \"-10\" scales the fleet down by 10%.
"
},
"Threshold":{
"shape":"Double",
"documentation":"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 Service-defined metric that is used to trigger an adjustment.
- ActivatingGameSessions: number of game sessions in the process of being created (game session status = ACTIVATING).
- ActiveGameSessions: number of game sessions currently running (game session status = ACTIVE).
- CurrentPlayerSessions: number of active or reserved player sessions (player session status = ACTIVE or RESERVED).
- AvailablePlayerSessions: number of player session slots currently available in active game sessions across the fleet, calculated by subtracting a game session's current player session count from its maximum player session count. This number includes game sessions that are not currently accepting players (game session PlayerSessionCreationPolicy = DENY_ALL).
- ActiveInstances: number of instances currently running a game session.
- IdleInstances: number of instances not currently running a game session.
"
}
},
"documentation":"Represents the input for a request action.
"
},
"PutScalingPolicyOutput":{
"type":"structure",
"members":{
"Name":{
"shape":"NonZeroAndMaxString",
"documentation":"Descriptive label associated with this 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:
- SIMPLE: The alias resolves to one specific fleet. Use this type when routing to active fleets.
- TERMINAL: The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the RoutingStrategy message embedded.
"
},
"FleetId":{
"shape":"FleetId",
"documentation":"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"
]
},
"S3Location":{
"type":"structure",
"members":{
"Bucket":{
"shape":"NonEmptyString",
"documentation":"Amazon S3 bucket identifier.
"
},
"Key":{
"shape":"NonEmptyString",
"documentation":"Amazon S3 bucket key.
"
},
"RoleArn":{"shape":"NonEmptyString"}
},
"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 this 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 state.
- ACTIVE: The scaling policy is currently in force.
- UPDATEREQUESTED: A request to update the scaling policy has been received.
- UPDATING: A change is being made to the scaling policy.
- DELETEREQUESTED: A request to delete the scaling policy has been received.
- DELETING: The scaling policy is being deleted.
- DELETED: The scaling policy has been deleted.
- ERROR: An error occurred in creating the policy. It should be removed and recreated.
"
},
"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):
- ChangeInCapacity: add (or subtract) the scaling adjustment value from the current instance count. Positive values scale up while negative values scale down.
- ExactCapacity: set the instance count to the scaling adjustment value.
- PercentChangeInCapacity: increase or reduce the current instance count by the scaling adjustment, read as a percentage. Positive values scale up while negative values scale down.
"
},
"ComparisonOperator":{
"shape":"ComparisonOperatorType",
"documentation":"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.
- ActivatingGameSessions: number of game sessions in the process of being created (game session status = ACTIVATING).
- ActiveGameSessions: number of game sessions currently running (game session status = ACTIVE).
- CurrentPlayerSessions: number of active or reserved player sessions (player session status = ACTIVE or RESERVED).
- AvailablePlayerSessions: number of player session slots currently available in active game sessions across the fleet, calculated by subtracting a game session's current player session count from its maximum player session count. This number does include game sessions that are not currently accepting players (game session PlayerSessionCreationPolicy = DENY_ALL).
- ActiveInstances: number of instances currently running a game session.
- IdleInstances: number of instances not currently running a game session.
"
}
},
"documentation":"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"
]
},
"StringList":{
"type":"list",
"member":{"shape":"NonZeroAndMaxString"}
},
"TerminalRoutingStrategyException":{
"type":"structure",
"members":{
"Message":{"shape":"NonEmptyString"}
},
"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 TerminalRoutingStrategy 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. Such requests should not be retried without valid authentication credentials.
"
},
"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 this alias. Alias names do not need to be unique.
"
},
"Description":{
"shape":"NonZeroAndMaxString",
"documentation":"Human-readable description of the 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 for the build you want to update.
"
},
"Name":{
"shape":"NonZeroAndMaxString",
"documentation":"Descriptive label associated with this 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 this fleet. Fleet names do not need to be unique.
"
},
"Description":{
"shape":"NonZeroAndMaxString",
"documentation":"Human-readable description of the fleet.
"
},
"NewGameSessionProtectionPolicy":{
"shape":"ProtectionPolicy",
"documentation":"Game session protection policy to apply to all new instances created in this fleet. Instances that already exist will not be affected. You can set protection for individual instances using UpdateGameSession.
- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
"
}
},
"documentation":"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 this 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.
- NoProtection: The game session can be terminated during a scale-down event.
- FullProtection: If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
"
}
},
"documentation":"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.
"
},
"WholeNumber":{
"type":"integer",
"min":0
}
},
"examples":{
}
}