Amazon GameLift #X Amz Target=GameLift.DescribeFleetLocationAttributes 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.DescribeFleetLocationAttributes'
paths:
  /#X-Amz-Target=GameLift.DescribeFleetLocationAttributes:
    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: DescribeFleetLocationAttributes
      description: 'Retrieves information on a fleet''s remote locations, including life-cycle status and any suspended fleet activity.


        This operation can be used in the following ways:


        To get data for specific locations, provide a fleet identifier and a list of locations. Location data is returned in the order that it is requested.


        To get data for all locations, provide a fleet identifier only. Location data is returned in no particular order.


        When requesting attributes for multiple locations, use the pagination parameters to retrieve results as a set of sequential pages.


        If successful, a LocationAttributes object is returned for each requested location. If the fleet does not have a requested location, no information is returned. This operation does not return the home Region. To get information on a fleet''s home Region, call DescribeFleetAttributes.


        Learn more


        Setting up Amazon GameLift fleets'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeFleetLocationAttributesOutput'
              examples:
                DescribeFleetLocationAttributes200Example:
                  summary: Default DescribeFleetLocationAttributes 200 response
                  x-microcks-default: true
                  value:
                    FleetId: fleet-1a2b3c4d-5678-90ab-cdef-1234567890ab
                    FleetArn: arn:aws:gamelift:us-east-1:123456789012:fleet/fleet-1a2b3c4d
                    LocationAttributes: example-value
                    NextToken: example-value
        '480':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                DescribeFleetLocationAttributes480Example:
                  summary: Default DescribeFleetLocationAttributes 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                DescribeFleetLocationAttributes481Example:
                  summary: Default DescribeFleetLocationAttributes 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
              examples:
                DescribeFleetLocationAttributes482Example:
                  summary: Default DescribeFleetLocationAttributes 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
              examples:
                DescribeFleetLocationAttributes483Example:
                  summary: Default DescribeFleetLocationAttributes 483 response
                  x-microcks-default: true
                  value: example-value
        '484':
          description: UnsupportedRegionException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedRegionException'
              examples:
                DescribeFleetLocationAttributes484Example:
                  summary: Default DescribeFleetLocationAttributes 484 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeFleetLocationAttributesInput'
      parameters:
      - name: Limit
        in: query
        schema:
          type: string
        description: Pagination limit
        required: false
      - name: NextToken
        in: query
        schema:
          type: string
        description: Pagination token
        required: false
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GameLift.DescribeFleetLocationAttributes
      summary: Amazon GameLift Describe Fleet Location Attributes
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=GameLift.DescribeFleetLocationAttributes'
components:
  schemas:
    LocationStringModel:
      type: string
      pattern: ^[A-Za-z0-9\-]+
      minLength: 1
      maxLength: 64
    LocationList:
      type: array
      items:
        $ref: '#/components/schemas/LocationStringModel'
      minItems: 1
      maxItems: 100
    FleetActionList:
      type: array
      items:
        $ref: '#/components/schemas/FleetAction'
      minItems: 1
      maxItems: 1
    InvalidRequestException: {}
    UnsupportedRegionException: {}
    LocationAttributesList:
      type: array
      items:
        $ref: '#/components/schemas/LocationAttributes'
    NotFoundException: {}
    NonZeroAndMaxString:
      type: string
      minLength: 1
      maxLength: 1024
    FleetIdOrArn:
      type: string
      pattern: ^fleet-\S+|^arn:.*:fleet\/fleet-\S+
    FleetAction:
      type: string
      enum:
      - AUTO_SCALING
    DescribeFleetLocationAttributesInput:
      type: object
      required:
      - FleetId
      title: DescribeFleetLocationAttributesInput
      properties:
        FleetId:
          allOf:
          - $ref: '#/components/schemas/FleetIdOrArn'
          - description: A unique identifier for the fleet to retrieve remote locations for. You can use either the fleet ID or ARN value.
        Locations:
          allOf:
          - $ref: '#/components/schemas/LocationList'
          - description: A list of fleet locations to retrieve information for. Specify locations in the form of an Amazon Web Services Region code, such as <code>us-west-2</code>.
        Limit:
          allOf:
          - $ref: '#/components/schemas/PositiveInteger'
          - description: The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. This limit is not currently enforced.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
    InternalServiceException: {}
    PositiveInteger:
      type: integer
      minimum: 1
    FleetArn:
      type: string
      pattern: ^arn:.*:fleet\/fleet-\S+
    FleetStatus:
      type: string
      enum:
      - NEW
      - DOWNLOADING
      - VALIDATING
      - BUILDING
      - ACTIVATING
      - ACTIVE
      - DELETING
      - ERROR
      - TERMINATED
      - NOT_FOUND
    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>
    DescribeFleetLocationAttributesOutput:
      type: object
      properties:
        FleetId:
          allOf:
          - $ref: '#/components/schemas/FleetIdOrArn'
          - description: A unique identifier for the fleet that location attributes were requested for.
        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>.
        LocationAttributes:
          allOf:
          - $ref: '#/components/schemas/LocationAttributesList'
          - description: ' Location-specific information on the requested fleet''s remote locations.'
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
    LocationAttributes:
      type: object
      properties:
        LocationState:
          allOf:
          - $ref: '#/components/schemas/LocationState'
          - description: A fleet location and its current life-cycle state.
        StoppedActions:
          allOf:
          - $ref: '#/components/schemas/FleetActionList'
          - description: A list of fleet actions that have been suspended in the fleet location.
        UpdateStatus:
          allOf:
          - $ref: '#/components/schemas/LocationUpdateStatus'
          - description: The status of fleet activity updates to the location. The status <code>PENDING_UPDATE</code> indicates that <code>StopFleetActions</code> or <code>StartFleetActions</code> has been requested but the update has not yet been completed for the location.
      description: Details about a location in a multi-location fleet.
    UnauthorizedException: {}
    LocationUpdateStatus:
      type: string
      enum:
      - PENDING_UPDATE
  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