Amazon GameLift #X Amz Target=GameLift.DescribeMatchmakingConfigurations API

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.DescribeMatchmakingConfigurations 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.DescribeMatchmakingConfigurations'
paths:
  /#X-Amz-Target=GameLift.DescribeMatchmakingConfigurations:
    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: DescribeMatchmakingConfigurations
      description: '<p>Retrieves the details of FlexMatch matchmaking configurations. </p> <p>This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. </p> <p>If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned. </p> <p> <b>Learn more</b> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/matchmaker-build.html"> Setting up FlexMatch matchmakers</a> </p>'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DescribeMatchmakingConfigurationsOutput'
              examples:
                DescribeMatchmakingConfigurations200Example:
                  summary: Default DescribeMatchmakingConfigurations 200 response
                  x-microcks-default: true
                  value:
                    Configurations: example-value
                    NextToken: example-value
        '480':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                DescribeMatchmakingConfigurations480Example:
                  summary: Default DescribeMatchmakingConfigurations 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                DescribeMatchmakingConfigurations481Example:
                  summary: Default DescribeMatchmakingConfigurations 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: UnsupportedRegionException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedRegionException'
              examples:
                DescribeMatchmakingConfigurations482Example:
                  summary: Default DescribeMatchmakingConfigurations 482 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DescribeMatchmakingConfigurationsInput'
      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.DescribeMatchmakingConfigurations
      summary: Amazon GameLift Describe Matchmaking Configurations
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=GameLift.DescribeMatchmakingConfigurations'
components:
  schemas:
    SnsArnStringModel:
      type: string
      pattern: '[a-zA-Z0-9:_/-]*(.fifo)?'
      minLength: 0
      maxLength: 300
    DescribeMatchmakingConfigurationsInput:
      type: object
      title: DescribeMatchmakingConfigurationsInput
      properties:
        Names:
          allOf:
          - $ref: '#/components/schemas/MatchmakingConfigurationNameList'
          - description: A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name or ARN value. To request all existing configurations, leave this parameter empty.
        RuleSetName:
          allOf:
          - $ref: '#/components/schemas/MatchmakingRuleSetName'
          - description: A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this parameter to retrieve all matchmaking configurations that use this rule set.
        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 parameter is limited to 10.
        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.
    NonZeroAndMaxString:
      type: string
      minLength: 1
      maxLength: 1024
    InternalServiceException: {}
    WholeNumber:
      type: integer
      minimum: 0
    BackfillMode:
      type: string
      enum:
      - AUTOMATIC
      - MANUAL
    MatchmakingConfigurationArn:
      type: string
      pattern: ^arn:.*:matchmakingconfiguration\/[a-zA-Z0-9-\.]*
      description: Data type used for Matchmaking Configuration ARN.
    MatchmakingRuleSetName:
      type: string
      pattern: '[a-zA-Z0-9-\.]*|^arn:.*:matchmakingruleset\/[a-zA-Z0-9-\.]*'
      minLength: 1
      maxLength: 256
    QueueArnsList:
      type: array
      items:
        $ref: '#/components/schemas/ArnStringModel'
    MatchmakingRequestTimeoutInteger:
      type: integer
      minimum: 1
      maximum: 43200
    GameProperty:
      type: object
      required:
      - Key
      - Value
      properties:
        Key:
          allOf:
          - $ref: '#/components/schemas/GamePropertyKey'
          - description: The game property identifier.
        Value:
          allOf:
          - $ref: '#/components/schemas/GamePropertyValue'
          - description: The game property value.
      description: Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session. For example, a game property might specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session. For more information, see the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-create"> Amazon GameLift Developer Guide</a>.
    MatchmakingAcceptanceTimeoutInteger:
      type: integer
      minimum: 1
      maximum: 600
    GamePropertyKey:
      type: string
      maxLength: 32
    GamePropertyList:
      type: array
      items:
        $ref: '#/components/schemas/GameProperty'
      maxItems: 16
    MatchmakingConfigurationList:
      type: array
      items:
        $ref: '#/components/schemas/MatchmakingConfiguration'
    FlexMatchMode:
      type: string
      enum:
      - STANDALONE
      - WITH_QUEUE
    InvalidRequestException: {}
    MatchmakingRuleSetArn:
      type: string
      pattern: ^arn:.*:matchmakingruleset\/[a-zA-Z0-9-\.]*
      description: Data type used for Matchmaking RuleSet ARN.
    GameSessionData:
      type: string
      minLength: 1
      maxLength: 4096
    BooleanModel:
      type: boolean
    ArnStringModel:
      type: string
      pattern: '[a-zA-Z0-9:/-]+'
      minLength: 1
      maxLength: 256
    Timestamp:
      type: string
      format: date-time
    DescribeMatchmakingConfigurationsOutput:
      type: object
      properties:
        Configurations:
          allOf:
          - $ref: '#/components/schemas/MatchmakingConfigurationList'
          - description: A collection of requested matchmaking configurations.
        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.
    PositiveInteger:
      type: integer
      minimum: 1
    CustomEventData:
      type: string
      minLength: 0
      maxLength: 256
    MatchmakingConfigurationNameList:
      type: array
      items:
        $ref: '#/components/schemas/MatchmakingConfigurationName'
    MatchmakingConfigurationName:
      type: string
      pattern: '[a-zA-Z0-9-\.]*|^arn:.*:matchmakingconfiguration\/[a-zA-Z0-9-\.]*'
      minLength: 1
      maxLength: 256
    UnsupportedRegionException: {}
    MatchmakingConfiguration:
      type: object
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/MatchmakingIdStringModel'
          - description: A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.
        ConfigurationArn:
          allOf:
          - $ref: '#/components/schemas/MatchmakingConfigurationArn'
          - 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 matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:&lt;region&gt;::matchmakingconfiguration/&lt;matchmaking configuration name&gt;</code>. In a Amazon GameLift configuration ARN, the resource ID matches the <i>Name</i> value.
        Description:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: A descriptive label that is associated with matchmaking configuration.
        GameSessionQueueArns:
          allOf:
          - $ref: '#/components/schemas/QueueArnsList'
          - 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 game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:&lt;region&gt;::gamesessionqueue/&lt;queue name&gt;</code>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. This property is not set when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.
        RequestTimeoutSeconds:
          allOf:
          - $ref: '#/components/schemas/MatchmakingRequestTimeoutInteger'
          - description: The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.
        AcceptanceTimeoutSeconds:
          allOf:
          - $ref: '#/components/schemas/MatchmakingAcceptanceTimeoutInteger'
          - description: The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.
        AcceptanceRequired:
          allOf:
          - $ref: '#/components/schemas/BooleanModel'
          - description: A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. When this option is enabled, matchmaking tickets use the status <code>REQUIRES_ACCEPTANCE</code> to indicate when a completed potential match is waiting for player acceptance.
        RuleSetName:
          allOf:
          - $ref: '#/components/schemas/MatchmakingIdStringModel'
          - description: A unique identifier for the matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same Region.
        RuleSetArn:
          allOf:
          - $ref: '#/components/schemas/MatchmakingRuleSetArn'
          - 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 matchmaking rule set resource that this configuration uses.
        NotificationTarget:
          allOf:
          - $ref: '#/components/schemas/SnsArnStringModel'
          - description: An SNS topic ARN that is set up to receive matchmaking notifications.
        AdditionalPlayerCount:
          allOf:
          - $ref: '#/components/schemas/WholeNumber'
          - description: The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.
        CustomEventData:
          allOf:
          - $ref: '#/components/schemas/CustomEventData'
          - description: 'Information to attach to all events related to the matchmaking configuration. '
        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>).
        GameProperties:
          allOf:
          - $ref: '#/components/schemas/GamePropertyList'
          - description: A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is created for a successful match. This parameter is not used when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.
        GameSessionData:
          allOf:
          - $ref: '#/components/schemas/GameSessionData'
          - description: A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is created for a successful match. This parameter is not used when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.
        BackfillMode:
          allOf:
          - $ref: '#/components/schemas/BackfillMode'
          - description: The method used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift creates backfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html">Backfill existing games with FlexMatch</a>. Automatic backfill is not available when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.
        FlexMatchMode:
          allOf:
          - $ref: '#/components/schemas/FlexMatchMode'
          - description: <p>Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution. </p> <ul> <li> <p> <b>STANDALONE</b> - FlexMatch forms matches and returns match information, including players and team assignments, in a <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded"> MatchmakingSucceeded</a> event.</p> </li> <li> <p> <b>WITH_QUEUE</b> - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match. </p> </li> </ul>
      description: Guidelines for use with FlexMatch to match players into games. All matchmaking requests must specify a matchmaking configuration.
    MatchmakingIdStringModel:
      type: string
      pattern: '[a-zA-Z0-9-\.]*'
      maxLength: 128
    GamePropertyValue:
      type: string
      maxLength: 96
  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