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.CreateFleet API'
  description: <p>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. </p> <p> <b>About Amazon GameLift solutions</b> </p> <p>Get more information on these Amazon GameLift solutions in the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/">Amazon GameLift Developer Guide</a>.</p> <ul> <li> <p>Amazon GameLift managed hosting -- Amazon GameLift offers a fully managed service to set up and maintain computing machines for hosting, manage game session and player session life cycle, and handle security, storage, and performance tracking. You can use automatic scaling tools to balance player demand and hosting costs, configure your game session management to minimize player latency, and add FlexMatch for matchmaking.</p> </li> <li> <p>Managed hosting with Realtime Servers -- With Amazon GameLift Realtime Servers, you can quickly configure and set up ready-to-go game servers for your game. Realtime Servers provides a game server framework with core Amazon GameLift infrastructure already built in. Then use the full range of Amazon GameLift managed hosting features, including FlexMatch, for your game.</p> </li> <li> <p>Amazon GameLift FleetIQ -- Use Amazon GameLift FleetIQ as a standalone service while hosting your games using EC2 instances and Auto Scaling groups. Amazon GameLift FleetIQ provides optimizations for game hosting, including boosting the viability of low-cost Spot Instances gaming. For a complete solution, pair the Amazon GameLift FleetIQ and FlexMatch standalone services.</p> </li> <li> <p>Amazon GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a customizable matchmaking service for multiplayer games. Use FlexMatch as integrated with Amazon GameLift managed hosting or incorporate FlexMatch as a standalone service into your own hosting solution.</p> </li> </ul> <p> <b>About this API Reference</b> </p> <p>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:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html">Amazon GameLift API operations listed by tasks</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-components.html"> Amazon GameLift tools and resources</a> </p> </li> </ul>
  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.CreateFleet'
paths:
  /#X-Amz-Target=GameLift.CreateFleet:
    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: CreateFleet
      description: '<p>Creates a fleet of Amazon Elastic Compute Cloud (Amazon EC2) instances to host your custom game server or Realtime Servers. Use this operation to configure the computing resources for your fleet and provide instructions for running game servers on each instance.</p> <p>Most Amazon GameLift fleets can deploy instances to multiple locations, including the home Region (where the fleet is created) and an optional set of remote locations. Fleets that are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N. Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland), ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that are created in other Amazon GameLift Regions can deploy instances in the fleet''s home Region only. All fleet instances use the same configuration regardless of location; however, you can adjust capacity settings and turn auto-scaling on/off for each location.</p> <p>To create a fleet, choose the hardware for your instances, specify a game server build or Realtime script to deploy, and provide a runtime configuration to direct Amazon GameLift how to start and run game servers on each instance in the fleet. Set permissions for inbound traffic to your game servers, and enable optional features as needed. When creating a multi-location fleet, provide a list of additional remote locations.</p> <p>If you need to debug your fleet, fetch logs, view performance metrics or other actions on the fleet, create the development fleet with port 22/3389 open. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you''re finished. </p> <p>If successful, this operation creates a new Fleet resource and places it in <code>NEW</code> status, which prompts Amazon GameLift to initiate the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-all.html#fleets-creation-workflow">fleet creation workflow</a>.</p> <p> <b>Learn more</b> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up fleets</a> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation">Debug fleet creation issues</a> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Multi-location fleets</a> </p>'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFleetOutput'
              examples:
                CreateFleet200Example:
                  summary: Default CreateFleet 200 response
                  x-microcks-default: true
                  value:
                    FleetAttributes: example-value
                    LocationStates: example-value
        '480':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                CreateFleet480Example:
                  summary: Default CreateFleet 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
              examples:
                CreateFleet481Example:
                  summary: Default CreateFleet 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: ConflictException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConflictException'
              examples:
                CreateFleet482Example:
                  summary: Default CreateFleet 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
              examples:
                CreateFleet483Example:
                  summary: Default CreateFleet 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                CreateFleet484Example:
                  summary: Default CreateFleet 484 response
                  x-microcks-default: true
                  value: example-value
        '485':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
              examples:
                CreateFleet485Example:
                  summary: Default CreateFleet 485 response
                  x-microcks-default: true
                  value: example-value
        '486':
          description: TaggingFailedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaggingFailedException'
              examples:
                CreateFleet486Example:
                  summary: Default CreateFleet 486 response
                  x-microcks-default: true
                  value: example-value
        '487':
          description: UnsupportedRegionException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedRegionException'
              examples:
                CreateFleet487Example:
                  summary: Default CreateFleet 487 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFleetInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GameLift.CreateFleet
      summary: Amazon GameLift Create Fleet
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=GameLift.CreateFleet'
components:
  schemas:
    ConflictException: {}
    CreateFleetInput:
      type: object
      required:
      - Name
      title: CreateFleetInput
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
        Description:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: A description for the fleet.
        BuildId:
          allOf:
          - $ref: '#/components/schemas/BuildIdOrArn'
          - description: The unique identifier for a custom game server build to be deployed on fleet instances. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift and in <code>READY</code> status. This fleet property cannot be changed later.
        ScriptId:
          allOf:
          - $ref: '#/components/schemas/ScriptIdOrArn'
          - description: The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift prior to creating the fleet. This fleet property cannot be changed later.
        ServerLaunchPath:
          allOf:
          - $ref: '#/components/schemas/LaunchPathStringModel'
          - description: ' <b>This parameter is no longer used.</b> Specify a server launch path using the <code>RuntimeConfiguration</code> parameter. Requests that use this parameter instead continue to be valid.'
        ServerLaunchParameters:
          allOf:
          - $ref: '#/components/schemas/LaunchParametersStringModel'
          - description: ' <b>This parameter is no longer used.</b> Specify server launch parameters using the <code>RuntimeConfiguration</code> parameter. Requests that use this parameter instead continue to be valid.'
        LogPaths:
          allOf:
          - $ref: '#/components/schemas/StringList'
          - description: ' <b>This parameter is no longer used.</b> To specify where Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server API <code>ProcessReady()</code> and specify one or more directory paths in <code>logParameters</code>. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize">Initialize the server process</a> in the <i>Amazon GameLift Developer Guide</i>. '
        EC2InstanceType:
          allOf:
          - $ref: '#/components/schemas/EC2InstanceType'
          - description: The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See <a href="http://aws.amazon.com/ec2/instance-types/">Amazon Elastic Compute Cloud Instance Types</a> for detailed descriptions of Amazon EC2 instance types.
        EC2InboundPermissions:
          allOf:
          - $ref: '#/components/schemas/IpPermissionsList'
          - description: 'The allowed IP address ranges and port settings that allow inbound traffic to access game sessions on this fleet. If the fleet is hosting a custom game build, this property must be set before players can connect to game sessions. For Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges. '
        NewGameSessionProtectionPolicy:
          allOf:
          - $ref: '#/components/schemas/ProtectionPolicy'
          - description: <p>The status of termination protection for active game sessions on the fleet. By default, this property is set to <code>NoProtection</code>. You can also set game session protection for an individual game session by calling <a href="gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a>.</p> <ul> <li> <p> <b>NoProtection</b> - Game sessions can be terminated during active gameplay as a result of a scale-down event. </p> </li> <li> <p> <b>FullProtection</b> - Game sessions in <code>ACTIVE</code> status cannot be terminated during a scale-down event.</p> </li> </ul>
        RuntimeConfiguration:
          allOf:
          - $ref: '#/components/schemas/RuntimeConfiguration'
          - description: <p>Instructions for how to launch and maintain server processes on instances in the fleet. The runtime configuration defines one or more server process configurations, each identifying a build executable or Realtime script file and the number of processes of that type to run concurrently. </p> <note> <p>The <code>RuntimeConfiguration</code> parameter is required unless the fleet is being configured using the older parameters <code>ServerLaunchPath</code> and <code>ServerLaunchParameters</code>, which are still supported for backward compatibility.</p> </note>
        ResourceCreationLimitPolicy:
          allOf:
          - $ref: '#/components/schemas/ResourceCreationLimitPolicy'
          - description: A policy that limits the number of game sessions that an individual player can create on instances in this fleet within a specified span of time.
        MetricGroups:
          allOf:
          - $ref: '#/components/schemas/MetricGroupList'
          - description: 'The name of an Amazon Web Services CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time. '
        PeerVpcAwsAccountId:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: 'Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the Amazon Web Services account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account settings. '
        PeerVpcId:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console. Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>.
        FleetType:
          allOf:
          - $ref: '#/components/schemas/FleetType'
          - description: Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to <code>ON_DEMAND</code>. Learn more about when to use <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot"> On-Demand versus Spot Instances</a>. This property cannot be changed after the fleet is created.
        InstanceRoleArn:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the <a href="https://console.aws.amazon.com/iam/">IAM dashboard</a> in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html"> Access external resources from a game server</a>. This property cannot be changed after the fleet is created.
        CertificateConfiguration:
          allOf:
          - $ref: '#/components/schemas/CertificateConfiguration'
          - description: <p>Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. By default, the <code>CertificateConfiguration</code> is <code>DISABLED</code>. You can't change this property after you create the fleet. </p> <p>Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition.</p> <note> <p>ACM isn't available in all Amazon Web Services regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html">Supported Regions</a> in the <i>Certificate Manager User Guide</i>.</p> </note>
        Locations:
          allOf:
          - $ref: '#/components/schemas/LocationConfigurationList'
          - description: <p>A set of remote locations to deploy additional instances to and manage as part of the fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. To create a fleet with instances in the home Region only, don't use this parameter. </p> <p>To use this parameter, Amazon GameLift requires you to use your home location in the request.</p>
        Tags:
          allOf:
          - $ref: '#/components/schemas/TagList'
          - description: A list of labels to assign to the new fleet resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.
        ComputeType:
          allOf:
          - $ref: '#/components/schemas/ComputeType'
          - description: The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift. By default, this property is set to <code>EC2</code>.
        AnywhereConfiguration:
          allOf:
          - $ref: '#/components/schemas/AnywhereConfiguration'
          - description: Amazon GameLift Anywhere configuration options.
    BuildIdOrArn:
      type: string
      pattern: ^build-\S+|^arn:.*:build\/build-\S+
    NonZeroAndMaxString:
      type: string
      minLength: 1
      maxLength: 1024
    Tag:
      type: object
      required:
      - Key
      - Value
      properties:
        Key:
          allOf:
          - $ref: '#/components/schemas/TagKey'
          - description: 'The key for a developer-defined key value pair for tagging an Amazon Web Services resource. '
        Value:
          allOf:
          - $ref: '#/components/schemas/TagValue'
          - description: 'The value for a developer-defined key value pair for tagging an Amazon Web Services resource. '
      description: <p>A label that you can assign to a Amazon GameLift resource. </p> <p> <b>Learn more</b> </p> <p> <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i> </p> <p> <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/"> Amazon Web Services Tagging Strategies</a> </p> <p> <b>Related actions</b> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>
    LocationStateList:
      type: array
      items:
        $ref: '#/components/schemas/LocationState'
    FleetId:
      type: string
      pattern: ^fleet-\S+
    InternalServiceException: {}
    WholeNumber:
      type: integer
      minimum: 0
    IpProtocol:
      type: string
      enum:
      - TCP
      - UDP
    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>
    StringList:
      type: array
      items:
        $ref: '#/components/schemas/NonZeroAndMaxString'
    ServerProcessList:
      type: array
      items:
        $ref: '#/components/schemas/ServerProcess'
      minItems: 1
      maxItems: 50
    CreateFleetOutput:
      type: object
      properties:
        FleetAttributes:
          allOf:
          - $ref: '#/components/schemas/FleetAttributes'
          - description: 'The properties for the new fleet, including the current status. All fleets are placed in <code>NEW</code> status on creation. '
        LocationStates:
          allOf:
          - $ref: '#/components/schemas/LocationStateList'
          - description: The fleet's locations and life-cycle status of each location. For new fleets, the status of all locations is set to <code>NEW</code>. During fleet creation, Amazon GameLift updates each location status as instances are deployed there and prepared for game hosting. This list includes an entry for the fleet's home Region. For fleets with no remote locations, only one entry, representing the home Region, is returned.
    ProtectionPolicy:
      type: string
      enum:
      - NoProtection
      - FullProtection
    FleetActionList:
      type: array
      items:
        $ref: '#/components/schemas/FleetAction'
      minItems: 1
      maxItems: 1
    FleetStatus:
      type: string
      enum:
      - NEW
      - DOWNLOADING
      - VALIDATING
      - BUILDING
      - ACTIVATING
      - ACTIVE
      - DELETING
      - ERROR
      - TERMINATED
      - NOT_FOUND
    FleetArn:
      type: string
      pattern: ^arn:.*:fleet\/fleet-\S+
    FleetAction:
      type: string
      enum:
      - AUTO_SCALING
    NonBlankString:
      type: string
      pattern: '[^\s]+'
    ComputeType:
      type: string
      enum:
      - EC2
      - ANYWHERE
    ScriptArn:
      type: string
      pattern: ^arn:.*:script\/script-\S+
    LocationState:
      type: object
      properties:
        Location:
          allOf:
          - $ref: '#/components/schemas/LocationStringModel'
          - description: 'The fleet location, expressed as an Amazon Web Services Region code such as <code>us-west-2</code>. '
        Status:
          allOf:
          - $ref: '#/components/schemas/FleetStatus'
          - description: 'The life-cycle status of a fleet location. '
      description: <p>A fleet location and its life-cycle state. A location state object might be used to describe a fleet's remote location or home Region. Life-cycle state tracks the progress of launching the first instance in a new location and preparing it for game hosting, and then removing all instances and deleting the location from the fleet.</p> <ul> <li> <p> <b>NEW</b> -- A new fleet location has been defined and desired instances is set to 1. </p> </li> <li> <p> <b>DOWNLOADING/VALIDATING/BUILDING/ACTIVATING</b> -- Amazon GameLift is setting up the new fleet location, creating new instances with the game build or Realtime script and starting server processes.</p> </li> <li> <p> <b>ACTIVE</b> -- Hosts can now accept game sessions.</p> </li> <li> <p> <b>ERROR</b> -- An error occurred when downloading, validating, building, or activating the fleet location.</p> </li> <li> <p> <b>DELETING</b> -- Hosts are responding to a delete fleet location request.</p> </li> <li> <p> <b>TERMINATED</b> -- The fleet location no longer exists.</p> </li> <li> <p> <b>NOT_FOUND</b> -- The fleet location was not found. This could be because the custom location was removed or not created. </p> </li> </ul>
    MetricGroup:
      type: string
      minLength: 1
      maxLength: 255
    LaunchPathStringModel:
      type: string
      pattern: '[A-Za-z0-9_:.+\/\\\- ]+'
      minLength: 1
      maxLength: 1024
    ScriptId:
      type: string
      pattern: ^script-\S+
    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.
    IpPermissionsList:
      type: array
      items:
        $ref: '#/components/schemas/IpPermission'
      maxItems: 50
    CertificateConfiguration:
      type: object
      required:
      - CertificateType
      properties:
        CertificateType:
          allOf:
          - $ref: '#/components/schemas/CertificateType'
          - description: '<p>Indicates whether a TLS/SSL certificate is generated for a fleet. </p> <p>Valid values include: </p> <ul> <li> <p> <b>GENERATED</b> - Generate a TLS/SSL certificate for this fleet.</p> </li> <li> <p> <b>DISABLED</b> - (default) Do not generate a TLS/SSL certificate for this fleet. </p> </li> </ul>'
      description: 'Determines whether a TLS/SSL certificate is generated for a fleet. This feature must be enabled when creating the fleet. All instances in a fleet share the same certificate. The certificate can be retrieved by calling the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html">Amazon GameLift Server SDK</a> operation <code>GetInstanceCertificate</code>. '
    ScriptIdOrArn:
      type: string
      pattern: ^script-\S+|^arn:.*:script\/script-\S+
    FleetAttributes:
      type: object
      properties:
        FleetId:
          allOf:
          - $ref: '#/components/schemas/FleetId'
          - description: A unique identifier for the fleet.
        FleetArn:
          allOf:
          - $ref: '#/components/schemas/FleetArn'
          - description: The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:&lt;region&gt;::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>. In a GameLift fleet ARN, the resource ID matches the <code>FleetId</code> value.
        FleetType:
          allOf:
          - $ref: '#/components/schemas/FleetType'
          - description: Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to <code>ON_DEMAND</code>. Learn more about when to use <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot"> On-Demand versus Spot Instances</a>. This property cannot be changed after the fleet is created.
        InstanceType:
          allOf:
          - $ref: '#/components/schemas/EC2InstanceType'
          - description: The Amazon EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See <a href="http://aws.amazon.com/ec2/instance-types/">Amazon Elastic Compute Cloud Instance Types</a> for detailed descriptions.
        Description:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: A human-readable description of the fleet.
        Name:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
        CreationTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example <code>"1469498468.057"</code>).
        TerminationTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example <code>"1469498468.057"</code>).
        Status:
          allOf:
          - $ref: '#/components/schemas/FleetStatus'
          - description: <p>Current status of the fleet. Possible fleet statuses include the following:</p> <ul> <li> <p> <b>NEW</b> -- A new fleet has been defined and desired instances is set to 1. </p> </li> <li> <p> <b>DOWNLOADING/VALIDATING/BUILDING/ACTIVATING</b> -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.</p> </li> <li> <p> <b>ACTIVE</b> -- Hosts can now accept game sessions.</p> </li> <li> <p> <b>ERROR</b> -- An error occurred when downloading, validating, building, or activating the fleet.</p> </li> <li> <p> <b>DELETING</b> -- Hosts are responding to a delete fleet request.</p> </li> <li> <p> <b>TERMINATED</b> -- The fleet no longer exists.</p> </li> </ul>
        BuildId:
          allOf:
          - $ref: '#/components/schemas/BuildId'
          - description: A unique identifier for the build resource that is deployed on instances in this fleet.
        BuildArn:
          allOf:
          - $ref: '#/components/schemas/BuildArn'
          - description: ' The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) associated with the Amazon GameLift build resource that is deployed on instances in this fleet. In a GameLift build ARN, the resource ID matches the <code>BuildId</code> value.'
        ScriptId:
          allOf:
          - $ref: '#/components/schemas/ScriptId'
          - description: A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
        ScriptArn:
          allOf:
          - $ref: '#/components/schemas/ScriptArn'
          - description: ' The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the <code>ScriptId</code> value.'
        ServerLaunchPath:
          allOf:
          - $ref: '#/components/schemas/LaunchPathStringModel'
          - description: ' <b>This parameter is no longer used.</b> Server launch paths are now defined using the fleet''s <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/RuntimeConfiguration.html">RuntimeConfiguration</a> . Requests that use this parameter instead continue to be valid.'
        ServerLaunchParameters:
          allOf:
          - $ref: '#/components/schemas/LaunchParametersStringModel'
          - description: ' <b>This parameter is no longer used.</b> Server launch parameters are now defined using the fleet''s runtime configuration . Requests that use this parameter instead continue to be valid.'
        LogPaths:
          allOf:
          - $ref: '#/components/schemas/StringList'
          - description: ' <b>This parameter is no longer used.</b> Game session log paths are now defined using the Amazon GameLift server API <code>ProcessReady()</code> <code>logParameters</code>. See more information in the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process">Server API Reference</a>. '
        NewGameSessionProtectionPolicy:
          allOf:
          - $ref: '#/components/schemas/ProtectionPolicy'
          - description: <p>The type of game session protection to set on all new instances that are started in the fleet.</p> <ul> <li> <p> <b>NoProtection</b> -- The game session can be terminated during a scale-down event.</p> </li> <li> <p> <b>FullProtection</b> -- If the game session is in an <code>ACTIVE</code> status, it cannot be terminated during a scale-down event.</p> </li> </ul>
        OperatingSystem:
          allOf:
          - $ref: '#/components/schemas/OperatingSystem'
          - description: The operating system of the fleet's computing resources. A fleet's operating system is determined by the OS of the build or script that is deployed on this fleet.
        ResourceCreationLimitPolicy:
          $ref: '#/components/schemas/ResourceCreationLimitPolicy'
        MetricGroups:
          allOf:
          - $ref: '#/components/schemas/MetricGroupList'
          - description: Name of a metric group that metrics for this fleet are added to. In Amazon CloudWatch, you can view aggregated metrics for fleets that are in a metric group. A fleet can be included in only one metric group at a time.
        StoppedActions:
          allOf:
          - $ref: '#/components/schemas/FleetActionList'
          - description: A list of fleet activity that has been suspended using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html">StopFleetActions</a> . This includes fleet auto-scaling.
        InstanceRoleArn:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: A unique identifier for an IAM role that manages access to your Amazon Web Services services. With an instance role ARN set, any application that runs on an instance in this fleet can assume the role, including install scripts, server processes, and daemons (background processes). Create a role or look up a role's ARN by using the <a href="https://console.aws.amazon.com/iam/">IAM dashboard</a> in the Amazon Web Services Management Console. Learn more about using on-box credentials for your game servers at <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html"> Access external resources from a game server</a>.
        CertificateConfiguration:
          $ref: '#/components/schemas/CertificateConfiguration'
        ComputeType:
          allOf:
          - $ref: '#/components/schemas/ComputeType'
          - description: The type of compute resource used to host your game servers. You can use your own compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed Amazon GameLift.
        AnywhereConfiguration:
          $ref: '#/components/schemas/AnywhereConfiguration'
      description: <p>Describes a Amazon GameLift fleet of game hosting resources.</p> <p> <b>Related actions</b> </p>
    ResourceCreationLimitPolicy:
      type: object
      properties:
        NewGameSessionsPerCreator:
          allOf:
          - $ref: '#/components/schemas/WholeNumber'
          - description: <p>A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.</p> <p>The policy is evaluated when a player tries to create a new game session. On receiving a <code>CreateGameSession</code> request, Amazon GameLift checks that the player (identified by <code>CreatorId</code>) has created fewer than game session limit in the specified time period.</p>
        PolicyPeriodInMinutes:
          allOf:
          - $ref: '#/components/schemas/WholeNumber'
          - description: 'The time span used in evaluating the resource creation limit policy. '
      description: <p>A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.</p> <p>The policy is evaluated when a player tries to create a new game session. On receiving a <code>CreateGameSession</code> request, Amazon GameLift checks that the player (identified by <code>CreatorId</code>) has created fewer than game session limit in the specified time period.</p>
    FleetType:
      type: string
      enum:
      - ON_DEMAND
      - SPOT
    InvalidRequestException: {}
    NonNegativeLimitedLengthDouble:
      type: string
      pattern: ^\d{1,5}(?:\.\d{1,5})?$
      minLength: 1
      maxLength: 11
    NotFoundException: {}
    AnywhereConfiguration:
      type: object
      required:
      - Cost
      properties:
        Cost:
          allOf:
          - $ref: '#/components/schemas/NonNegativeLimitedLengthDouble'
          - description: The cost to run your fleet per hour. Amazon GameLift uses the provided cost of your fleet to balance usage in queues. For more information about queues, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html">Setting up queues</a> in the <i>Amazon GameLift Developer Guide</i>.
      description: Amazon GameLift Anywhere configuration options for your Anywhere fleets.
    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
      - c5.large
      - c5.xlarge
      - c5.2xlarge
      - c5.4xlarge
      - c5.9xlarge
      - c5.12xlarge
      - c5.18xlarge
      - c5.24xlarge
      - c5a.large
      - c5a.xlarge
      - c5a.2xlarge
      - c5a.4xlarge
      - c5a.8xlarge
      - c5a.12xlarge
      - c5a.16xlarge
      - c5a.24xlarge
      - r3.large
      - r3.xlarge
      - r3.2xlarge
      - r3.4xlarge
      - r3.8xlarge
      - r4.large
      - r4.xlarge
      - r4.2xlarge
      - r4.4xlarge
      - r4.8xlarge
      - r4.16xlarge
      - r5.large
      - r5.xlarge
      - r5.2xlarge
      - r5.4xlarge
      - r5.8xlarge
      - r5.12xlarge
      - r5.16xlarge
      - r5.24xlarge
      - r5a.large
      - r5a.xlarge
      - r5a.2xlarge
      - r5a.4xlarge
      - r5a.8xlarge
      - r5a.12xlarge
      - r5a.16xlarge
      - r5a.24xlarge
      - m3.medium
      - m3.large
      - m3.xlarge
      - m3.2xlarge
      - m4.large
      - m4.xlarge
      - m4.2xlarge
      - m4.4xlarge
      - m4.10xlarge
      - m5.large
      - m5.xlarge
      - m5.2xlarge
      - m5.4xlarge
      - m5.8xlarge
      - m5.12xlarge
      - m5.16xlarge
      - m5.24xlarge
      - m5a.large
      - m5a.xlarge
      - m5a.2xlarge
      - m5a.4xlarge
      - m5a.8xlarge
      - m5a.12xlarge
      - m5a.16xlarge
      - m5a.24xlarge
      - c5d.large
      - c5d.xlarge
      - c5d.2xlarge
      - c5d.4xlarge
      - c5d.9xlarge
      - c5d.12xlarge
      - c5d.18xlarge
      - c5d.24xlarge
      - c6a.large
      - c6a.xlarge
      - c6a.2xlarge
      - c6a.4xlarge
      - c6a.8xlarge
      - c6a.12xlarge
      - c6a.16xlarge
      - c6a.24xlarge
      - c6i.large
      - c6i.xlarge
      - c6i.2xlarge
      - c6i.4xlarge
      - c6i.8xlarge
      - c6i.12xlarge
      - c6i.16xlarge
      - c6i.24xlarge
      - r5d.large
      - r5d.xlarge
      - r5d.2xlarge
      - r5d.4xlarge
      - r5d.8xlarge
      - r5d.12xlarge
      - r5d.16xlarge
      - r5d.24xlarge
    TaggingFailedException: {}
    IpPermission:
      type: object
      required:
      - FromPort
      - ToPort
      - IpRange
      - Protocol
      properties:
        FromPort:
          allOf:
          - $ref: '#/components/schemas/PortNumber'
          - description: <p>A starting value for a range of allowed port numbers.</p> <p>For fleets using Linux builds, only ports <code>22</code> and <code>1026-60000</code> are valid.</p> <p>For fleets using Windows builds, only ports <code>1026-60000</code> are valid.</p>
        ToPort:
          allOf:
          - $ref: '#/components/schemas/PortNumber'
          - description: <p>An ending value for a range of allowed port numbers. Port numbers are end-inclusive. This value must be equal to or greater than <code>FromPort</code>.</p> <p>For fleets using Linux builds, only ports <code>22</code> and <code>1026-60000</code> are valid.</p> <p>For fleets using Windows builds, only ports <code>1026-60000</code> are valid.</p>
        IpRange:
          allOf:
          - $ref: '#/components/schemas/NonBlankString'
          - description: 'A range of allowed IP addresses. This value must be expressed in CIDR notation. Example: "<code>000.000.000.000/[subnet mask]</code>" or optionally the shortened version "<code>0.0.0.0/[subnet mask]</code>".'
        Protocol:
          allOf:
          - $ref: '#/components/schemas/IpProtocol'
          - description: The network communication protocol used by the fleet.
      description: A range of IP addresses and port settings that allow inbound traffic to connect to server processes on an instance in a fleet. New game sessions are assigned an IP address/port number combination, which must fall into the fleet's allowed ranges. Fleets with custom game builds must have permissions explicitly set. For Realtime Servers fleets, Amazon GameLift automatically opens two port ranges, one for TCP messaging and one for UDP.
    PortNumber:
      type: integer
      minimum: 1
      maximum: 60000
    LimitExceededException: {}
    UnauthorizedException: {}
    Timestamp:
      type: string
      format: date-time
    LocationStringModel:
      type: string
      pattern: ^[A-Za-z0-9\-]+
      minLength: 1
      maxLength: 64
    TagKey:
      type: string
      minLength: 1
      maxLength: 128
    OperatingSystem:
      type: string
      enum:
      - WINDOWS_2012
      - AMAZON_LINUX
      - AMAZON_LINUX_2
      - WINDOWS_2016
    MaxConcurrentGameSessionActivations:
      type: integer
      minimum: 1
      maximum: 2147483647
    LaunchParametersStringModel:
      type: string
      pattern: '[A-Za-z0-9_:.+\/\\\- =@;{},?''\[\]"]+'
      minLength: 1
      maxLength: 1024
    PositiveInteger:
      type: integer
      minimum: 1
    BuildId:
      type: string
      pattern: ^build-\S+
    GameSessionActivationTimeoutSeconds:
      type: integer
      minimum: 1
      maximum: 600
    LocationConfiguration:
      type: object
      required:
      - Location
      properties:
        Location:
          allOf:
          - $ref: '#/components/schemas/LocationStringModel'
          - description: 'An Amazon Web Services Region code, such as <code>us-west-2</code>. '
      description: 'A remote location where a multi-location fleet can deploy game servers for game hosting. '
    CertificateType:
      type: string
      enum:
      - DISABLED
      - GENERATED
    LocationConfigurationList:
      type: array
      items:
        $ref: '#/components/schemas/LocationConfiguration'
      minItems: 1
      maxItems: 100
    BuildArn:
      type: string
      pattern: ^arn:.*:build\/build-\S+
    TagValue:
      type: string
      minLength: 0
      maxLength: 256
    UnsupportedRegionException: {}
    NonEmptyString:
      type: string
      minLength: 1
    MetricGroupList:
      type: array
      items:
        $ref: '#/components/schemas/MetricGroup'
      maxItems: 1
    TagList:
      type: array
      items:
        $ref: '#/components/schemas/Tag'
      minItems: 0
      maxItems: 200
  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