Amazon GameLift #X Amz Target=GameLift.UpdateRuntimeConfiguration API

openapi: 3.2.0
info:
  version: 2015-10-01
  x-release: v4
  title: 'Amazon GameLift #X Amz Target=GameLift.UpdateRuntimeConfigur…'
  description: Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers.
  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.UpdateRuntimeConfiguration'
paths:
  /#X-Amz-Target=GameLift.UpdateRuntimeConfiguration:
    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: UpdateRuntimeConfiguration
      description: 'Updates the current runtime configuration for the specified fleet, which tells Amazon GameLift how to launch server processes on all instances in the fleet. You can update a fleet''s runtime configuration at any time after the fleet is created; it does not need to be in ACTIVE status.


        To update runtime configuration, specify the fleet ID and provide a RuntimeConfiguration with an updated set of server process configurations.


        If successful, the fleet''s runtime configuration settings are updated. Each instance in the fleet regularly checks for and retrieves updated runtime configurations. Instances immediately begin complying with the new configuration by launching new server processes or not replacing existing processes when they shut down. Updating a fleet''s runtime configuration never affects existing server processes.


        Learn more


        Setting up Amazon GameLift fleets'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateRuntimeConfigurationOutput'
              examples:
                UpdateRuntimeConfiguration200Example:
                  summary: Default UpdateRuntimeConfiguration 200 response
                  x-microcks-default: true
                  value:
                    RuntimeConfiguration: example-value
        '480':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
              examples:
                UpdateRuntimeConfiguration480Example:
                  summary: Default UpdateRuntimeConfiguration 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
              examples:
                UpdateRuntimeConfiguration481Example:
                  summary: Default UpdateRuntimeConfiguration 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                UpdateRuntimeConfiguration482Example:
                  summary: Default UpdateRuntimeConfiguration 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                UpdateRuntimeConfiguration483Example:
                  summary: Default UpdateRuntimeConfiguration 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: InvalidFleetStatusException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidFleetStatusException'
              examples:
                UpdateRuntimeConfiguration484Example:
                  summary: Default UpdateRuntimeConfiguration 484 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRuntimeConfigurationInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GameLift.UpdateRuntimeConfiguration
      summary: Amazon GameLift Update Runtime Configuration
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=GameLift.UpdateRuntimeConfiguration'
components:
  schemas:
    LaunchParametersStringModel:
      type: string
      pattern: '[A-Za-z0-9_:.+\/\\\- =@;{},?''\[\]"]+'
      minLength: 1
      maxLength: 1024
    InvalidFleetStatusException: {}
    InvalidRequestException: {}
    UpdateRuntimeConfigurationOutput:
      type: object
      properties:
        RuntimeConfiguration:
          allOf:
          - $ref: '#/components/schemas/RuntimeConfiguration'
          - description: 'The runtime configuration currently in use by all instances in the fleet. If the update was successful, all property changes are shown. '
    MaxConcurrentGameSessionActivations:
      type: integer
      minimum: 1
      maximum: 2147483647
    NotFoundException: {}
    FleetIdOrArn:
      type: string
      pattern: ^fleet-\S+|^arn:.*:fleet\/fleet-\S+
    InternalServiceException: {}
    ServerProcessList:
      type: array
      items:
        $ref: '#/components/schemas/ServerProcess'
      minItems: 1
      maxItems: 50
    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 <code>ACTIVATING</code> 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 <code>ACTIVATING</code>. If the game session does not become active before the timeout, it is ended and the game session status is changed to <code>TERMINATED</code>.
      description: <p>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. </p> <p>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 <code>ConcurrentExecutions</code> parameter for each server process. Learn more about <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html"> Running Multiple Processes on a Fleet</a>.</p>
    PositiveInteger:
      type: integer
      minimum: 1
    ServerProcess:
      type: object
      required:
      - LaunchPath
      - ConcurrentExecutions
      properties:
        LaunchPath:
          allOf:
          - $ref: '#/components/schemas/LaunchPathStringModel'
          - description: '<p>The location of a game build executable or the Realtime script file that contains the <code>Init()</code> function. Game builds and Realtime scripts are installed on instances at the root: </p> <ul> <li> <p>Windows (custom game builds only): <code>C:\game</code>. Example: "<code>C:\game\MyGame\server.exe</code>" </p> </li> <li> <p>Linux: <code>/local/game</code>. Examples: "<code>/local/game/MyGame/server.exe</code>" or "<code>/local/game/MyRealtimeScript.js</code>"</p> </li> </ul>'
        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.
    LaunchPathStringModel:
      type: string
      pattern: '[A-Za-z0-9_:.+\/\\\- ]+'
      minLength: 1
      maxLength: 1024
    UnauthorizedException: {}
    UpdateRuntimeConfigurationInput:
      type: object
      required:
      - FleetId
      - RuntimeConfiguration
      title: UpdateRuntimeConfigurationInput
      properties:
        FleetId:
          allOf:
          - $ref: '#/components/schemas/FleetIdOrArn'
          - description: A unique identifier for the fleet to update runtime configuration for. You can use either the fleet ID or ARN value.
        RuntimeConfiguration:
          allOf:
          - $ref: '#/components/schemas/RuntimeConfiguration'
          - description: Instructions for launching server processes on each instance in the fleet. Server processes run either a custom game build executable or a Realtime Servers script. The runtime configuration lists the types of server processes to run on an instance, how to launch them, and the number of processes to run concurrently.
    GameSessionActivationTimeoutSeconds:
      type: integer
      minimum: 1
      maximum: 600
  parameters:
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    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-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      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