Amazon GameLift #X Amz Target=GameLift.ListAliases API

openapi: 3.2.0
info:
  version: 2015-10-01
  x-release: v4
  title: 'Amazon GameLift #X Amz Target=GameLift.ListAliases API'
  description: Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers.
  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.ListAliases'
paths:
  /#X-Amz-Target=GameLift.ListAliases:
    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: ListAliases
      description: 'Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias name and/or routing strategy type. Use the pagination parameters to retrieve results in sequential pages.


        Returned aliases are not listed in any particular order.


        Related actions


        All APIs by task'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAliasesOutput'
              examples:
                ListAliases200Example:
                  summary: Default ListAliases 200 response
                  x-microcks-default: true
                  value:
                    Aliases: example-value
                    NextToken: example-value
        '480':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
              examples:
                ListAliases480Example:
                  summary: Default ListAliases 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                ListAliases481Example:
                  summary: Default ListAliases 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                ListAliases482Example:
                  summary: Default ListAliases 482 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListAliasesInput'
      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.ListAliases
      summary: Amazon GameLift List Aliases
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=GameLift.ListAliases'
components:
  schemas:
    Alias:
      type: object
      properties:
        AliasId:
          allOf:
          - $ref: '#/components/schemas/AliasId'
          - description: A unique identifier for the alias. Alias IDs are unique within a Region.
        Name:
          allOf:
          - $ref: '#/components/schemas/NonBlankAndLengthConstraintString'
          - description: A descriptive label that is associated with an alias. Alias names do not need to be unique.
        AliasArn:
          allOf:
          - $ref: '#/components/schemas/AliasArn'
          - 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 alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:&lt;region&gt;::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>. In a GameLift alias ARN, the resource ID matches the alias ID value.
        Description:
          allOf:
          - $ref: '#/components/schemas/FreeText'
          - description: A human-readable description of an alias.
        RoutingStrategy:
          allOf:
          - $ref: '#/components/schemas/RoutingStrategy'
          - description: 'The routing configuration, including routing type and fleet target, for the alias. '
        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>).
        LastUpdatedTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: The time that this data object was last modified. Format is a number expressed in Unix time as milliseconds (for example <code>"1469498468.057"</code>).
      description: <p>Properties that describe an alias resource.</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>
    InvalidRequestException: {}
    NonEmptyString:
      type: string
      minLength: 1
    Timestamp:
      type: string
      format: date-time
    FleetId:
      type: string
      pattern: ^fleet-\S+
    RoutingStrategyType:
      type: string
      enum:
      - SIMPLE
      - TERMINAL
    FreeText:
      type: string
    NonBlankAndLengthConstraintString:
      type: string
      pattern: .*\S.*
      minLength: 1
      maxLength: 1024
    AliasList:
      type: array
      items:
        $ref: '#/components/schemas/Alias'
    InternalServiceException: {}
    ListAliasesOutput:
      type: object
      properties:
        Aliases:
          allOf:
          - $ref: '#/components/schemas/AliasList'
          - description: A collection of alias resources that match the request parameters.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - 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.
    ListAliasesInput:
      type: object
      title: ListAliasesInput
      properties:
        RoutingStrategyType:
          allOf:
          - $ref: '#/components/schemas/RoutingStrategyType'
          - description: <p>The routing type to filter results on. Use this parameter to retrieve only aliases with a certain routing type. To retrieve all aliases, leave this parameter empty.</p> <p>Possible routing types include the following:</p> <ul> <li> <p> <b>SIMPLE</b> -- The alias resolves to one specific fleet. Use this type when routing to active fleets.</p> </li> <li> <p> <b>TERMINAL</b> -- The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_RoutingStrategy.html">RoutingStrategy</a> message embedded.</p> </li> </ul>
        Name:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - description: A descriptive label that is associated with an alias. Alias names do not need to be unique.
        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.
        NextToken:
          allOf:
          - $ref: '#/components/schemas/NonEmptyString'
          - 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.
    RoutingStrategy:
      type: object
      properties:
        Type:
          allOf:
          - $ref: '#/components/schemas/RoutingStrategyType'
          - description: <p>The type of routing strategy for the alias.</p> <p>Possible routing types include the following:</p> <ul> <li> <p> <b>SIMPLE</b> - The alias resolves to one specific fleet. Use this type when routing to active fleets.</p> </li> <li> <p> <b>TERMINAL</b> - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the message embedded.</p> </li> </ul>
        FleetId:
          allOf:
          - $ref: '#/components/schemas/FleetId'
          - description: A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN.
        Message:
          allOf:
          - $ref: '#/components/schemas/FreeText'
          - description: The message text to be used with a terminal routing strategy.
      description: <p>The routing configuration for a fleet alias.</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>
    PositiveInteger:
      type: integer
      minimum: 1
    AliasArn:
      type: string
      pattern: ^arn:.*:alias\/alias-\S+
    UnauthorizedException: {}
    AliasId:
      type: string
      pattern: ^alias-\S+
  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