openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 292 kB

JSON

{"openapi":"3.0.0","info":{"version":"2015-10-01","x-release":"v4","title":"Amazon GameLift","description":"<fullname>Amazon GameLift Service</fullname> Amazon GameLift is a managed service for developers who need a scalable, dedicated server solution for their multiplayer games. Use Amazon GameLift for these tasks: (1) set up computing resources and deploy your game servers, (2) run game sessions and get players into games, (3) automatically scale your resources to meet player demand and manage costs, and (4) track in-depth metrics on game server performance and player usage. The Amazon GameLift service API includes two important function sets: <ul> <li> Manage game sessions and player access -- Retrieve information on available game sessions; create new game sessions; send player requests to join a game session. </li> <li> Configure and manage game server resources -- Manage builds, fleets, queues, and aliases; set auto-scaling policies; retrieve logs and metrics. </li> </ul> This reference guide describes the low-level service API for Amazon GameLift. You can use the API functionality with these tools: <ul> <li> The Amazon Web Services software development kit (<a href=\"http://aws.amazon.com/tools/#sdk\">AWS SDK</a>) is available in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-supported.html#gamelift-supported-clients\">multiple languages</a> including C++ and C#. Use the SDK to access the API programmatically from an application, such as a game client. </li> <li> The <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/\">AWS command-line interface</a> (CLI) tool is primarily useful for handling administrative actions, such as setting up and managing Amazon GameLift settings and resources. You can use the AWS CLI to manage all of your AWS services. </li> <li> The <a href=\"https://console.aws.amazon.com/gamelift/home\">AWS Management Console</a> for Amazon GameLift provides a web interface to manage your Amazon GameLift settings and resources. The console includes a dashboard for tracking key resources, including builds and fleets, and displays usage and performance metrics for your games as customizable graphs. </li> <li> Amazon GameLift Local is a tool for testing your game's integration with Amazon GameLift before deploying it on the service. This tools supports a subset of key API actions, which can be called from either the AWS CLI or programmatically. See <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing-local.html\">Testing an Integration</a>. </li> </ul> Learn more <ul> <li> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/\"> Developer Guide</a> -- Read about Amazon GameLift features and how to use them. </li> <li> <a href=\"https://gamedev.amazon.com/forums/tutorials\">Tutorials</a> -- Get started fast with walkthroughs and sample projects. </li> <li> <a href=\"https://gamedev.amazon.com/blogs/gamedev/\">GameDev Blog</a> -- Stay up to date with new features and techniques. </li> <li> <a href=\"https://gamedev.amazon.com/forums/spaces/123/gamelift-discussion.html\">GameDev Forums</a> -- Connect with the GameDev community. </li> <li> <a href=\"https://aws.amazon.com/releasenotes/Amazon-GameLift/\">Release notes</a> and <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/doc-history.html\">document history</a> -- Stay current with updates to the Amazon GameLift service, SDKs, and documentation. </li> </ul> API SUMMARY This list offers a functional overview of the Amazon GameLift service API. Managing Games and Players Use these actions to start new game sessions, find existing game sessions, track game session status and other information, and enable player access to game sessions. <ul> <li> Discover existing game sessions <ul> <li> <a>SearchGameSessions</a> -- Retrieve all available game sessions or search for game sessions that match a set of criteria. </li> </ul> </li> <li> Start new game sessions <ul> <li> Start new games with Queues to find the best available hosting resources across multiple regions, minimize player latency, and balance game session activity for efficiency and cost effectiveness. <ul> <li> <a>StartGameSessionPlacement</a> -- Request a new game session placement and add one or more players to it. </li> <li> <a>DescribeGameSessionPlacement</a> -- Get details on a placement request, including status. </li> <li> <a>StopGameSessionPlacement</a> -- Cancel a placement request. </li> </ul> </li> <li> <a>CreateGameSession</a> -- Start a new game session on a specific fleet. Available in Amazon GameLift Local. </li> </ul> </li> <li> Match players to game sessions with FlexMatch matchmaking <ul> <li> <a>StartMatchmaking</a> -- Request matchmaking for one players or a group who want to play together. </li> <li> <a>StartMatchBackfill</a> - Request additional player matches to fill empty slots in an existing game session. </li> <li> <a>DescribeMatchmaking</a> -- Get details on a matchmaking request, including status. </li> <li> <a>AcceptMatch</a> -- Register that a player accepts a proposed match, for matches that require player acceptance. </li> <li> <a>StopMatchmaking</a> -- Cancel a matchmaking request. </li> </ul> </li> <li> Manage game session data <ul> <li> <a>DescribeGameSessions</a> -- Retrieve metadata for one or more game sessions, including length of time active and current player count. Available in Amazon GameLift Local. </li> <li> <a>DescribeGameSessionDetails</a> -- Retrieve metadata and the game session protection setting for one or more game sessions. </li> <li> <a>UpdateGameSession</a> -- Change game session settings, such as maximum player count and join policy. </li> <li> <a>GetGameSessionLogUrl</a> -- Get the location of saved logs for a game session. </li> </ul> </li> <li> Manage player sessions <ul> <li> <a>CreatePlayerSession</a> -- Send a request for a player to join a game session. Available in Amazon GameLift Local. </li> <li> <a>CreatePlayerSessions</a> -- Send a request for multiple players to join a game session. Available in Amazon GameLift Local. </li> <li> <a>DescribePlayerSessions</a> -- Get details on player activity, including status, playing time, and player data. Available in Amazon GameLift Local. </li> </ul> </li> </ul> Setting Up and Managing Game Servers When setting up Amazon GameLift resources for your game, you first <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html\">create a game build</a> and upload it to Amazon GameLift. You can then use these actions to configure and manage a fleet of resources to run your game servers, scale capacity to meet player demand, access performance and utilization metrics, and more. <ul> <li> Manage game builds <ul> <li> <a>CreateBuild</a> -- Create a new build using files stored in an Amazon S3 bucket. To create a build and upload files from a local path, use the AWS CLI command <code>upload-build</code>. </li> <li> <a>ListBuilds</a> -- Get a list of all builds uploaded to a Amazon GameLift region. </li> <li> <a>DescribeBuild</a> -- Retrieve information associated with a build. </li> <li> <a>UpdateBuild</a> -- Change build metadata, including build name and version. </li> <li> <a>DeleteBuild</a> -- Remove a build from Amazon GameLift. </li> </ul> </li> <li> Manage fleets <ul> <li> <a>CreateFleet</a> -- Configure and activate a new fleet to run a build's game servers. </li> <li> <a>ListFleets</a> -- Get a list of all fleet IDs in a Amazon GameLift region (all statuses). </li> <li> <a>DeleteFleet</a> -- Terminate a fleet that is no longer running game servers or hosting players. </li> <li> View / update fleet configurations. <ul> <li> <a>DescribeFleetAttributes</a> / <a>UpdateFleetAttributes</a> -- View or change a fleet's metadata and settings for game session protection and resource creation limits. </li> <li> <a>DescribeFleetPortSettings</a> / <a>UpdateFleetPortSettings</a> -- View or change the inbound permissions (IP address and port setting ranges) allowed for a fleet. </li> <li> <a>DescribeRuntimeConfiguration</a> / <a>UpdateRuntimeConfiguration</a> -- View or change what server processes (and how many) to run on each instance in a fleet. </li> </ul> </li> </ul> </li> <li> Control fleet capacity <ul> <li> <a>DescribeEC2InstanceLimits</a> -- Retrieve maximum number of instances allowed for the current AWS account and the current usage level. </li> <li> <a>DescribeFleetCapacity</a> / <a>UpdateFleetCapacity</a> -- Retrieve the capacity settings and the current number of instances in a fleet; adjust fleet capacity settings to scale up or down. </li> <li> Autoscale -- Manage auto-scaling rules and apply them to a fleet. <ul> <li> <a>PutScalingPolicy</a> -- Create a new auto-scaling policy, or update an existing one. </li> <li> <a>DescribeScalingPolicies</a> -- Retrieve an existing auto-scaling policy. </li> <li> <a>DeleteScalingPolicy</a> -- Delete an auto-scaling policy and stop it from affecting a fleet's capacity. </li> <li> <a>StartFleetActions</a> -- Restart a fleet's auto-scaling policies. </li> <li> <a>StopFleetActions</a> -- Suspend a fleet's auto-scaling policies. </li> </ul> </li> </ul> </li> <li> Manage game session queues <ul> <li> <a>CreateGameSessionQueue</a> -- Create a queue for processing requests for new game sessions. </li> <li> <a>DescribeGameSessionQueues</a> -- Retrieve game session queues defined in a Amazon GameLift region. </li> <li> <a>UpdateGameSessionQueue</a> -- Change the configuration of a game session queue. </li> <li> <a>DeleteGameSessionQueue</a> -- Remove a game session queue from the region. </li> </ul> </li> <li> Manage FlexMatch resources <ul> <li> <a>CreateMatchmakingConfiguration</a> -- Create a matchmaking configuration with instructions for building a player group and placing in a new game session. </li> <li> <a>DescribeMatchmakingConfigurations</a> -- Retrieve matchmaking configurations defined a Amazon GameLift region. </li> <li> <a>UpdateMatchmakingConfiguration</a> -- Change settings for matchmaking configuration. queue. </li> <li> <a>DeleteMatchmakingConfiguration</a> -- Remove a matchmaking configuration from the region. </li> <li> <a>CreateMatchmakingRuleSet</a> -- Create a set of rules to use when searching for player matches. </li> <li> <a>DescribeMatchmakingRuleSets</a> -- Retrieve matchmaking rule sets defined in a Amazon GameLift region. </li> <li> <a>ValidateMatchmakingRuleSet</a> -- Verify syntax for a set of matchmaking rules. </li> <li> <a>DeleteMatchmakingRuleSet</a> -- Remove a matchmaking rule set from the region. </li> </ul> </li> <li> Access fleet activity statistics <ul> <li> <a>DescribeFleetUtilization</a> -- Get current data on the number of server processes, game sessions, and players currently active on a fleet. </li> <li> <a>DescribeFleetEvents</a> -- Get a fleet's logged events for a specified time span. </li> <li> <a>DescribeGameSessions</a> -- Retrieve metadata associated with one or more game sessions, including length of time active and current player count. </li> </ul> </li> <li> Remotely access an instance <ul> <li> <a>DescribeInstances</a> -- Get information on each instance in a fleet, including instance ID, IP address, and status. </li> <li> <a>GetInstanceAccess</a> -- Request access credentials needed to remotely connect to a specified instance in a fleet. </li> </ul> </li> <li> Manage fleet aliases <ul> <li> <a>CreateAlias</a> -- Define a new alias and optionally assign it to a fleet. </li> <li> <a>ListAliases</a> -- Get all fleet aliases defined in a Amazon GameLift region. </li> <li> <a>DescribeAlias</a> -- Retrieve information on an existing alias. </li> <li> <a>UpdateAlias</a> -- Change settings for a alias, such as redirecting it from one fleet to another. </li> <li> <a>DeleteAlias</a> -- Remove an alias from the region. </li> <li> <a>ResolveAlias</a> -- Get the fleet ID that a specified alias points to. </li> </ul> </li> <li> Manage VPC peering connections for fleets <ul> <li> <a>CreateVpcPeeringAuthorization</a> -- Authorize a peering connection to one of your VPCs. </li> <li> <a>DescribeVpcPeeringAuthorizations</a> -- Retrieve valid peering connection authorizations. </li> <li> <a>DeleteVpcPeeringAuthorization</a> -- Delete a peering connection authorization. </li> <li> <a>CreateVpcPeeringConnection</a> -- Establish a peering connection between the VPC for a Amazon GameLift fleet and one of your VPCs. </li> <li> <a>DescribeVpcPeeringConnections</a> -- Retrieve information on active or pending VPC peering connections with a Amazon GameLift fleet. </li> <li> <a>DeleteVpcPeeringConnection</a> -- Delete a VPC peering connection with a Amazon GameLift fleet. </li> </ul> </li> </ul>","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"gamelift","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/gamelift-2015-10-01.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-direct":true}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://aws.amazon.com/gamelift/"},"x-hasEquivalentPaths":true,"security":[{"hmac":[]}],"paths":{"/":{"post":{"operationId":"AcceptMatch","description":"Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit. When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status <code>REQUIRES_ACCEPTANCE</code>. This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error. To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status <code>PLACING</code>, where a new game session is created for the match. If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where all players accepted the match, the ticket status is returned to <code>SEARCHING</code> to find a new match. For tickets where one or more players failed to accept the match, the ticket status is set to <code>FAILED</code>, and processing is terminated. A new matchmaking request for these players can be submitted as needed. <ul> <li> <a>StartMatchmaking</a> </li> <li> <a>DescribeMatchmaking</a> </li> <li> <a>StopMatchmaking</a> </li> <li> <a>AcceptMatch</a> </li> <li> <a>StartMatchBackfill</a> </li> </ul>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptMatchOutput"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"483":{"description":"UnsupportedRegionException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedRegionException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptMatchInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateAlias":{"post":{"operationId":"CreateAlias","description":"Creates an alias for a fleet. In most situations, you can use an alias ID in place of a fleet ID. By using a fleet alias instead of a specific fleet ID, you can switch gameplay and players to a new fleet without changing your game client or other game components. For example, for games in production, using an alias allows you to seamlessly redirect your player base to a new game server update. Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A simple alias points to an active fleet. A terminal alias is used to display messaging or link to a URL instead of routing players to an active fleet. For example, you might use a terminal alias when a game version is no longer supported and you want to direct players to an upgrade site. To create a fleet alias, specify an alias name, routing strategy, and optional description. Each simple alias can point to only one fleet, but a fleet can have multiple aliases. If successful, a new alias record is returned, including an alias ID, which you can reference when creating a game session. You can reassign an alias to another fleet by calling <code>UpdateAlias</code>. <ul> <li> <a>CreateAlias</a> </li> <li> <a>ListAliases</a> </li> <li> <a>DescribeAlias</a> </li> <li> <a>UpdateAlias</a> </li> <li> <a>DeleteAlias</a> </li> <li> <a>ResolveAlias</a> </li> </ul>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAliasOutput"}}}},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAliasInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateBuild":{"post":{"operationId":"CreateBuild","description":"Creates a new Amazon GameLift build record for your game server binary files and points to the location of your game server build files in an Amazon Simple Storage Service (Amazon S3) location. Game server binaries must be combined into a <code>.zip</code> file for use with Amazon GameLift. See <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html\">Uploading Your Game</a> for more information. <important> To create new builds quickly and easily, use the AWS CLI command <a href=\"https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html\">upload-build</a> . This helper command uploads your build and creates a new build record in one step, and automatically handles the necessary permissions. See <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html\"> Upload Build Files to Amazon GameLift</a> for more help. </important> The <code>CreateBuild</code> operation should be used only when you need to manually upload your build files, as in the following scenarios: <ul> <li> Store a build file in an Amazon S3 bucket under your own AWS account. To use this option, you must first give Amazon GameLift access to that Amazon S3 bucket. See <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build\"> Create a Build with Files in Amazon S3</a> for detailed help. To create a new build record using files in your Amazon S3 bucket, call <code>CreateBuild</code> and specify a build name, operating system, and the storage location of your game build. </li> <li> Upload a build file directly to Amazon GameLift's Amazon S3 account. To use this option, you first call <code>CreateBuild</code> with a build name and operating system. This action creates a new build record and returns an Amazon S3 storage location (bucket and key only) and temporary access credentials. Use the credentials to manually upload your build file to the storage location (see the Amazon S3 topic <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html\">Uploading Objects</a>). You can upload files to a location only once. </li> </ul> If successful, this operation creates a new build record with a unique build ID and places it in <code>INITIALIZED</code> status. You can use <a>DescribeBuild</a> to check the status of your build. A build must be in <code>READY</code> status before it can be used to create fleets. <ul> <li> <a>CreateBuild</a> </li> <li> <a>ListBuilds</a> </li> <li> <a>DescribeBuild</a> </li> <li> <a>UpdateBuild</a> </li> <li> <a>DeleteBuild</a> </li> </ul>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBuildOutput"}}}},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBuildInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateFleet":{"post":{"operationId":"CreateFleet","description":"Creates a new fleet to run your game servers. A fleet is a set of Amazon Elastic Compute Cloud (Amazon EC2) instances, each of which can run multiple server processes to host game sessions. You set up a fleet to use instances with certain hardware specifications (see <a href=\"http://aws.amazon.com/ec2/instance-types/\">Amazon EC2 Instance Types</a>), and deploy your game build to the fleet. To create a new fleet, you must provide the following: (1) a fleet name, (2) an EC2 instance type, (3) the build ID for your game build, and (4) a run-time configuration, which specifies the server processes to run on each instance in the fleet. If fleet type is not set, the new fleet will use on-demand instances by default. If the <code>CreateFleet</code> call is successful, Amazon GameLift performs the following tasks. You can track the process of a fleet by checking the fleet status or by monitoring fleet creation events: <ul> <li> Creates a fleet record. Status: <code>NEW</code>. </li> <li> Begins writing events to the fleet event log, which can be accessed in the Amazon GameLift console. Sets the fleet's target capacity to 1 (desired instances), which triggers Amazon GameLift to start one new EC2 instance. </li> <li> Downloads the game build to the new instance and installs it. Statuses: <code>DOWNLOADING</code>, <code>VALIDATING</code>, <code>BUILDING</code>. </li> <li> Starts launching server processes on the instance. If the fleet is configured to run multiple server processes per instance, Amazon GameLift staggers each launch by a few seconds. Status: <code>ACTIVATING</code>. </li> <li> Sets the fleet's status to <code>ACTIVE</code> as soon as one server process is ready to host a game session. </li> </ul> Learn more See Amazon GameLift Developer Guide topics in <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html\"> Working with Fleets</a>. Related operations <ul> <li> <a>CreateFleet</a> </li> <li> <a>ListFleets</a> </li> <li> <a>DeleteFleet</a> </li> <li> Describe fleets: <ul> <li> <a>DescribeFleetAttributes</a> </li> <li> <a>DescribeFleetCapacity</a> </li> <li> <a>DescribeFleetPortSettings</a> </li> <li> <a>DescribeFleetUtilization</a> </li> <li> <a>DescribeRuntimeConfiguration</a> </li> <li> <a>DescribeEC2InstanceLimits</a> </li> <li> <a>DescribeFleetEvents</a> </li> </ul> </li> <li> Update fleets: <ul> <li> <a>UpdateFleetAttributes</a> </li> <li> <a>UpdateFleetCapacity</a> </li> <li> <a>UpdateFleetPortSettings</a> </li> <li> <a>UpdateRuntimeConfiguration</a> </li> </ul> </li> <li> Manage fleet actions: <ul> <li> <a>StartFleetActions</a> </li> <li> <a>StopFleetActions</a> </li> </ul> </li> </ul>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFleetOutput"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"481":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"484":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"485":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFleetInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateGameSession":{"post":{"operationId":"CreateGameSession","description":"Creates a multiplayer game session for players. This action creates a game session record and assigns an available server process in the specified fleet to host the game session. A fleet must have an <code>ACTIVE</code> status before a game session can be created in it. To create a game session, specify either fleet ID or alias ID and indicate a maximum number of players to allow in the game session. You can also provide a name and game-specific properties for this game session. If successful, a <a>GameSession</a> object is returned containing the game session properties and other settings you specified. Idempotency tokens. You can add a token that uniquely identifies game session requests. This is useful for ensuring that game session requests are idempotent. Multiple requests with the same idempotency token are processed only once; subsequent requests return the original result. All response values are the same with the exception of game session status, which may change. Resource creation limits. If you are creating a game session on a fleet with a resource creation limit policy in force, then you must specify a creator ID. Without this ID, Amazon GameLift has no way to evaluate the policy for this new game session request. Player acceptance policy. By default, newly created game sessions are open to new players. You can restrict new player access by using <a>UpdateGameSession</a> to change the game session's player session creation policy. Game session logs. Logs are retained for all active game sessions for 14 days. To access the logs, call <a>GetGameSessionLogUrl</a> to download the log files. Available in Amazon GameLift Local. <ul> <li> <a>CreateGameSession</a> </li> <li> <a>DescribeGameSessions</a> </li> <li> <a>DescribeGameSessionDetails</a> </li> <li> <a>SearchGameSessions</a> </li> <li> <a>UpdateGameSession</a> </li> <li> <a>GetGameSessionLogUrl</a> </li> <li> Game session placements <ul> <li> <a>StartGameSessionPlacement</a> </li> <li> <a>DescribeGameSessionPlacement</a> </li> <li> <a>StopGameSessionPlacement</a> </li> </ul> </li> </ul>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGameSessionOutput"}}}},"480":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"481":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"InvalidFleetStatusException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidFleetStatusException"}}}},"484":{"description":"TerminalRoutingStrategyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalRoutingStrategyException"}}}},"485":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"486":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"487":{"description":"FleetCapacityExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetCapacityExceededException"}}}},"488":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"489":{"description":"IdempotentParameterMismatchException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdempotentParameterMismatchException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGameSessionInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateGameSessionQueue":{"post":{"operationId":"CreateGameSessionQueue","description":"Establishes a new queue for processing requests to place new game sessions. A queue identifies where new game sessions can be hosted -- by specifying a list of destinations (fleets or aliases) -- and how long requests can wait in the queue before timing out. You can set up a queue to try to place game sessions on fleets in multiple regions. To add placement requests to a queue, call <a>StartGameSessionPlacement</a> and reference the queue name. Destination order. When processing a request for a game session, Amazon GameLift tries each destination in order until it finds one with available resources to host the new game session. A queue's default order is determined by how destinations are listed. The default order is overridden when a game session placement request provides player latency information. Player latency information enables Amazon GameLift to prioritize destinations where players report the lowest average latency, as a result placing the new game session where the majority of players will have the best possible gameplay experience. Player latency policies. For placement requests containing player latency information, use player latency policies to protect individual players from very high latencies. With a latency cap, even when a destination can deliver a low latency for most players, the game is not placed where any individual player is reporting latency higher than a policy's maximum. A queue can have multiple latency policies, which are enforced consecutively starting with the policy with the lowest latency cap. Use multiple policies to gradually relax latency controls; for example, you might set a policy with a low latency cap for the first 60 seconds, a second policy with a higher cap for the next 60 seconds, etc. To create a new queue, provide a name, timeout value, a list of destinations and, if desired, a set of latency policies. If successful, a new queue object is returned. <ul> <li> <a>CreateGameSessionQueue</a> </li> <li> <a>DescribeGameSessionQueues</a> </li> <li> <a>UpdateGameSessionQueue</a> </li> <li> <a>DeleteGameSessionQueue</a> </li> </ul>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGameSessionQueueOutput"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"481":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"482":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"483":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGameSessionQueueInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateMatchmakingConfiguration":{"post":{"operationId":"CreateMatchmakingConfiguration","description":"Defines a new matchmaking configuration for use with FlexMatch. A matchmaking configuration sets out guidelines for matching players and getting the matches into games. You can set up multiple matchmaking configurations to handle the scenarios needed for your game. Each matchmaking ticket (<a>StartMatchmaking</a> or <a>StartMatchBackfill</a>) specifies a configuration for the match and provides player attributes to support the configuration being used. To create a matchmaking configuration, at a minimum you must specify the following: configuration name; a rule set that governs how to evaluate players and find acceptable matches; a game session queue to use when placing a new game session for the match; and the maximum time allowed for a matchmaking attempt. Player acceptance -- In each configuration, you have the option to require that all players accept participation in a proposed match. To enable this feature, set AcceptanceRequired to true and specify a time limit for player acceptance. Players have the option to accept or reject a proposed match, and a match does not move ahead to game session placement unless all matched players accept. Matchmaking status notification -- There are two ways to track the progress of matchmaking tickets: (1) polling ticket status with <a>DescribeMatchmaking</a>; or (2) receiving notifications with Amazon Simple Notification Service (SNS). To use notifications, you first need to set up an SNS topic to receive the notifications, and provide the topic ARN in the matchmaking configuration (see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/match-notification.html\"> Setting up Notifications for Matchmaking</a>). Since notifications promise only \"best effort\" delivery, we recommend calling <code>DescribeMatchmaking</code> if no notifications are received within 30 seconds. <ul> <li> <a>CreateMatchmakingConfiguration</a> </li> <li> <a>DescribeMatchmakingConfigurations</a> </li> <li> <a>UpdateMatchmakingConfiguration</a> </li> <li> <a>DeleteMatchmakingConfiguration</a> </li> <li> <a>CreateMatchmakingRuleSet</a> </li> <li> <a>DescribeMatchmakingRuleSets</a> </li> <li> <a>ValidateMatchmakingRuleSet</a> </li> <li> <a>DeleteMatchmakingRuleSet</a> </li> </ul>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMatchmakingConfigurationOutput"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"482":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}},"483":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"484":{"description":"UnsupportedRegionException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedRegionException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMatchmakingConfigurationInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreateMatchmakingRuleSet":{"post":{"operationId":"CreateMatchmakingRuleSet","description":"Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams, and sets the parameters for acceptable player matches, such as minimum skill level or character type. A rule set is used by a <a>MatchmakingConfiguration</a>. To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same region as the matchmaking configuration they will be used with. Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using <a>ValidateMatchmakingRuleSet</a> before creating a new rule set. Learn more <ul> <li> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/match-rulesets.html\">Build a Rule Set</a> </li> <li> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/match-configuration.html\">Design a Matchmaker</a> </li> <li> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/match-intro.html\">Matchmaking with FlexMatch</a> </li> </ul> Related operations <ul> <li> <a>CreateMatchmakingConfiguration</a> </li> <li> <a>DescribeMatchmakingConfigurations</a> </li> <li> <a>UpdateMatchmakingConfiguration</a> </li> <li> <a>DeleteMatchmakingConfiguration</a> </li> <li> <a>CreateMatchmakingRuleSet</a> </li> <li> <a>DescribeMatchmakingRuleSets</a> </li> <li> <a>ValidateMatchmakingRuleSet</a> </li> <li> <a>DeleteMatchmakingRuleSet</a> </li> </ul>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMatchmakingRuleSetOutput"}}}},"480":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"481":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"482":{"description":"UnsupportedRegionException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedRegionException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMatchmakingRuleSetInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreatePlayerSession":{"post":{"operationId":"CreatePlayerSession","description":"Adds a player to a game session and creates a player session record. Before a player can be added, a game session must have an <code>ACTIVE</code> status, have a creation policy of <code>ALLOW_ALL</code>, and have an open player slot. To add a group of players to a game session, use <a>CreatePlayerSessions</a>. To create a player session, specify a game session ID, player ID, and optionally a string of player data. If successful, the player is added to the game session and a new <a>PlayerSession</a> object is returned. Player sessions cannot be updated. Available in Amazon GameLift Local. <ul> <li> <a>CreatePlayerSession</a> </li> <li> <a>CreatePlayerSessions</a> </li> <li> <a>DescribePlayerSessions</a> </li> <li> Game session placements <ul> <li> <a>StartGameSessionPlacement</a> </li> <li> <a>DescribeGameSessionPlacement</a> </li> <li> <a>StopGameSessionPlacement</a> </li> </ul> </li> </ul>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePlayerSessionOutput"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"InvalidGameSessionStatusException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidGameSessionStatusException"}}}},"483":{"description":"GameSessionFullException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GameSessionFullException"}}}},"484":{"description":"TerminalRoutingStrategyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalRoutingStrategyException"}}}},"485":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"486":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePlayerSessionInput"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/#CreatePlayerSessions":{"post":{"operationId":"CreatePlayerSessions","description":"Adds a group of players to a game session. This action is useful with a team matching feature. Before players can be added, a game session must have an <code>ACTIVE</code> status, have a creation policy of <code>ALLOW_ALL</code>, and have an open player slot. To add a single player to a game session, use <a>CreatePlayerSession</a>. To create player sessions, specify a game session ID, a list of player IDs, and optionally a set of player data strings. If successful, the players are added to the game session and a set of new <a>PlayerSession</a> objects is returned. Player sessions cannot be updated. Available in Amazon GameLift Local. <ul> <li> <a>CreatePlayerSession</a> </li> <li> <a>CreatePlayerSessions</a> </li> <li> <a>DescribePlayerSessions</a> </li> <li> Game session placements <ul> <li> <a>StartGameSessionPlacement</a> </li> <li> <a>DescribeGameSessionPlacement</a> </li> <li> <a>StopGameSessionPlacement</a> </li> </ul> </li> </ul>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePlayerSessionsOutput"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"481":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"482":{"description":"InvalidGameSessionStatusException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidGameSessionStatusException"}}}},"483":{"description":"GameSessionFullException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GameSessionFullException"}}}},"484":{"description":"TerminalRoutingStrategyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalRoutingStrategyException"}}}},"485":{"description":"InvalidRequestException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRequestException"}}}},"486":{"description":"NotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundException"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePlayerSessionsInput"}}},"required":true}},"parameters":[{"$ref":"#/components/pa