openapi: 3.0.0 info: version: 2015-10-01 x-release: v4 title: 'Amazon GameLift #X Amz Target=GameLift.AcceptMatch #X Amz Target=GameLift.AcceptMatch #X Amz Target=GameLift.DescribeRuntimeConfiguration API' description:

Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers. Built on Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance, high-reliability, low-cost game servers while dynamically scaling your resource usage to meet player demand.

About Amazon GameLift solutions

Get more information on these Amazon GameLift solutions in the Amazon GameLift Developer Guide.

About this API Reference

This reference guide describes the low-level service API for Amazon GameLift. With each topic in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI reference. Useful links:

x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png 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-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://gamelift.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon GameLift multi-region endpoint - url: https://gamelift.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon GameLift multi-region endpoint - url: http://gamelift.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon GameLift endpoint for China (Beijing) and China (Ningxia) - url: https://gamelift.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon GameLift endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=GameLift.DescribeRuntimeConfiguration' paths: /#X-Amz-Target=GameLift.DescribeRuntimeConfiguration: parameters: - $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' post: operationId: DescribeRuntimeConfiguration description:

Retrieves a fleet's runtime configuration settings. The runtime configuration tells Amazon GameLift which server processes to run (and how) on each instance in the fleet.

To get the runtime configuration that is currently in forces for a fleet, provide the fleet ID.

If successful, a RuntimeConfiguration object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up Amazon GameLift fleets

Running multiple processes on a fleet

responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeRuntimeConfigurationOutput' examples: DescribeRuntimeConfiguration200Example: summary: Default DescribeRuntimeConfiguration 200 response x-microcks-default: true value: RuntimeConfiguration: example-value '480': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: DescribeRuntimeConfiguration480Example: summary: Default DescribeRuntimeConfiguration 480 response x-microcks-default: true value: example-value '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DescribeRuntimeConfiguration481Example: summary: Default DescribeRuntimeConfiguration 481 response x-microcks-default: true value: example-value '482': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: DescribeRuntimeConfiguration482Example: summary: Default DescribeRuntimeConfiguration 482 response x-microcks-default: true value: example-value '483': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeRuntimeConfiguration483Example: summary: Default DescribeRuntimeConfiguration 483 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeRuntimeConfigurationInput' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - GameLift.DescribeRuntimeConfiguration summary: Amazon GameLift Describe Runtime Configuration x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=GameLift.DescribeRuntimeConfiguration' components: schemas: DescribeRuntimeConfigurationOutput: type: object properties: RuntimeConfiguration: allOf: - $ref: '#/components/schemas/RuntimeConfiguration' - description: Instructions that describe how server processes should be launched and maintained on each instance in the fleet. InternalServiceException: {} RuntimeConfiguration: type: object properties: ServerProcesses: allOf: - $ref: '#/components/schemas/ServerProcessList' - description: A collection of server process configurations that identify what server processes to run on each instance in a fleet. MaxConcurrentGameSessionActivations: allOf: - $ref: '#/components/schemas/MaxConcurrentGameSessionActivations' - description: The number of game sessions in status ACTIVATING to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time. GameSessionActivationTimeoutSeconds: allOf: - $ref: '#/components/schemas/GameSessionActivationTimeoutSeconds' - description: The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ACTIVATING. If the game session does not become active before the timeout, it is ended and the game session status is changed to TERMINATED. description:

A collection of server process configurations that describe the set of processes to run on each instance in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. Amazon GameLift launches the configured processes, manages their life cycle, and replaces them as needed. Each instance checks regularly for an updated runtime configuration.

A Amazon GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions parameter for each server process. Learn more about Running Multiple Processes on a Fleet.

ServerProcessList: type: array items: $ref: '#/components/schemas/ServerProcess' minItems: 1 maxItems: 50 LaunchPathStringModel: type: string pattern: '[A-Za-z0-9_:.+\/\\\- ]+' minLength: 1 maxLength: 1024 FleetIdOrArn: type: string pattern: ^fleet-\S+|^arn:.*:fleet\/fleet-\S+ ServerProcess: type: object required: - LaunchPath - ConcurrentExecutions properties: LaunchPath: allOf: - $ref: '#/components/schemas/LaunchPathStringModel' - description: '

The location of a game build executable or the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

' Parameters: allOf: - $ref: '#/components/schemas/LaunchParametersStringModel' - description: An optional list of parameters to pass to the server executable or Realtime script on launch. ConcurrentExecutions: allOf: - $ref: '#/components/schemas/PositiveInteger' - description: The number of server processes using this configuration that run concurrently on each instance. description: A set of instructions for launching server processes on each instance in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. Server process configurations are part of a fleet's runtime configuration. InvalidRequestException: {} NotFoundException: {} UnauthorizedException: {} MaxConcurrentGameSessionActivations: type: integer minimum: 1 maximum: 2147483647 LaunchParametersStringModel: type: string pattern: '[A-Za-z0-9_:.+\/\\\- =@;{},?''\[\]"]+' minLength: 1 maxLength: 1024 PositiveInteger: type: integer minimum: 1 GameSessionActivationTimeoutSeconds: type: integer minimum: 1 maximum: 600 DescribeRuntimeConfigurationInput: type: object required: - FleetId title: DescribeRuntimeConfigurationInput properties: FleetId: allOf: - $ref: '#/components/schemas/FleetIdOrArn' - description: A unique identifier for the fleet to get the runtime configuration for. You can use either the fleet ID or ARN value. parameters: X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/gamelift/ x-hasEquivalentPaths: true