Amazon GameLift #X Amz Target=GameLift.DescribeFleetLocationCapacity API

openapi: 3.2.0
info:
  version: 2015-10-01
  x-release: v4
  title: 'Amazon GameLift #X Amz Target=GameLift.DescribeFleetLocation…'
  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.DescribeFleetLocationCapacity'
paths:
  /#X-Amz-Target=GameLift.DescribeFleetLocationCapacity:
    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: DescribeFleetLocationCapacity
      description: 'Retrieves the resource capacity settings for a fleet location. The data returned includes the current capacity (number of EC2 instances) and some scaling settings for the requested fleet location. Use this operation to retrieve capacity information for a fleet''s remote location or home Region (you can also retrieve home Region capacity by calling DescribeFleetCapacity).


        To retrieve capacity data, identify a fleet and location.


        If successful, a FleetCapacity object is returned for the requested fleet location.


        Learn more


        Setting up Amazon GameLift fleets


        GameLift metrics for fleets'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeFleetLocationCapacityOutput'
              examples:
                DescribeFleetLocationCapacity200Example:
                  summary: Default DescribeFleetLocationCapacity 200 response
                  x-microcks-default: true
                  value:
                    FleetCapacity: example-value
        '480':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                DescribeFleetLocationCapacity480Example:
                  summary: Default DescribeFleetLocationCapacity 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                DescribeFleetLocationCapacity481Example:
                  summary: Default DescribeFleetLocationCapacity 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
              examples:
                DescribeFleetLocationCapacity482Example:
                  summary: Default DescribeFleetLocationCapacity 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
              examples:
                DescribeFleetLocationCapacity483Example:
                  summary: Default DescribeFleetLocationCapacity 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: UnsupportedRegionException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedRegionException'
              examples:
                DescribeFleetLocationCapacity484Example:
                  summary: Default DescribeFleetLocationCapacity 484 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeFleetLocationCapacityInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GameLift.DescribeFleetLocationCapacity
      summary: Amazon GameLift Describe Fleet Location Capacity
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=GameLift.DescribeFleetLocationCapacity'
components:
  schemas:
    LocationStringModel:
      type: string
      pattern: ^[A-Za-z0-9\-]+
      minLength: 1
      maxLength: 64
    InvalidRequestException: {}
    DescribeFleetLocationCapacityInput:
      type: object
      required:
      - FleetId
      - Location
      title: DescribeFleetLocationCapacityInput
      properties:
        FleetId:
          allOf:
          - $ref: '#/components/schemas/FleetIdOrArn'
          - description: A unique identifier for the fleet to request location capacity for. You can use either the fleet ID or ARN value.
        Location:
          allOf:
          - $ref: '#/components/schemas/LocationStringModel'
          - description: The fleet location to retrieve capacity information for. Specify a location in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.
    FleetId:
      type: string
      pattern: ^fleet-\S+
    UnsupportedRegionException: {}
    DescribeFleetLocationCapacityOutput:
      type: object
      properties:
        FleetCapacity:
          allOf:
          - $ref: '#/components/schemas/FleetCapacity'
          - description: Resource capacity information for the requested fleet location. Capacity objects are returned only for fleets and locations that currently exist.
    NotFoundException: {}
    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
    EC2InstanceCounts:
      type: object
      properties:
        DESIRED:
          allOf:
          - $ref: '#/components/schemas/WholeNumber'
          - description: 'Ideal number of active instances. GameLift will always try to maintain the desired number of instances. Capacity is scaled up or down by changing the desired instances. '
        MINIMUM:
          allOf:
          - $ref: '#/components/schemas/WholeNumber'
          - description: The minimum instance count value allowed.
        MAXIMUM:
          allOf:
          - $ref: '#/components/schemas/WholeNumber'
          - description: The maximum instance count value allowed.
        PENDING:
          allOf:
          - $ref: '#/components/schemas/WholeNumber'
          - description: Number of instances that are starting but not yet active.
        ACTIVE:
          allOf:
          - $ref: '#/components/schemas/WholeNumber'
          - description: Actual number of instances that are ready to host game sessions.
        IDLE:
          allOf:
          - $ref: '#/components/schemas/WholeNumber'
          - description: Number of active instances that are not currently hosting a game session.
        TERMINATING:
          allOf:
          - $ref: '#/components/schemas/WholeNumber'
          - description: Number of instances that are no longer active but haven't yet been terminated.
      description: Resource capacity settings. Fleet capacity is measured in Amazon EC2 instances. Pending and terminating counts are non-zero when the fleet capacity is adjusting to a scaling event or if access to resources is temporarily affected.
    FleetIdOrArn:
      type: string
      pattern: ^fleet-\S+|^arn:.*:fleet\/fleet-\S+
    FleetCapacity:
      type: object
      properties:
        FleetId:
          allOf:
          - $ref: '#/components/schemas/FleetId'
          - description: A unique identifier for the fleet associated with the location.
        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>.
        InstanceType:
          allOf:
          - $ref: '#/components/schemas/EC2InstanceType'
          - description: The Amazon EC2 instance type that is used for all instances in a fleet. The instance type determines the computing resources in use, 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.
        InstanceCounts:
          $ref: '#/components/schemas/EC2InstanceCounts'
        Location:
          allOf:
          - $ref: '#/components/schemas/LocationStringModel'
          - description: 'The fleet location for the instance count information, expressed as an Amazon Web Services Region code, such as <code>us-west-2</code>. '
      description: <p>Current resource capacity settings in a specified fleet or location. The location value might refer to a fleet's remote location or its home Region. </p> <p> <b>Related actions</b> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html">DescribeFleetCapacity</a> | <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html">DescribeFleetLocationCapacity</a> | <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html">UpdateFleetCapacity</a> </p>
    WholeNumber:
      type: integer
      minimum: 0
    InternalServiceException: {}
    FleetArn:
      type: string
      pattern: ^arn:.*:fleet\/fleet-\S+
    UnauthorizedException: {}
  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