Amazon GameLift #X Amz Target=GameLift.StopGameSessionPlacement API

openapi: 3.2.0
info:
  version: 2015-10-01
  x-release: v4
  title: 'Amazon GameLift #X Amz Target=GameLift.StopGameSessionPlacem…'
  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.StopGameSessionPlacement'
paths:
  /#X-Amz-Target=GameLift.StopGameSessionPlacement:
    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: StopGameSessionPlacement
      description: Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StopGameSessionPlacementOutput'
              examples:
                StopGameSessionPlacement200Example:
                  summary: Default StopGameSessionPlacement 200 response
                  x-microcks-default: true
                  value:
                    GameSessionPlacement: example-value
        '480':
          description: InternalServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServiceException'
              examples:
                StopGameSessionPlacement480Example:
                  summary: Default StopGameSessionPlacement 480 response
                  x-microcks-default: true
                  value: example-value
        '481':
          description: InvalidRequestException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidRequestException'
              examples:
                StopGameSessionPlacement481Example:
                  summary: Default StopGameSessionPlacement 481 response
                  x-microcks-default: true
                  value: example-value
        '482':
          description: NotFoundException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundException'
              examples:
                StopGameSessionPlacement482Example:
                  summary: Default StopGameSessionPlacement 482 response
                  x-microcks-default: true
                  value: example-value
        '483':
          description: UnauthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedException'
              examples:
                StopGameSessionPlacement483Example:
                  summary: Default StopGameSessionPlacement 483 response
                  x-microcks-default: true
                  value: example-value
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StopGameSessionPlacementInput'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - GameLift.StopGameSessionPlacement
      summary: Amazon GameLift Stop Game Session Placement
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=GameLift.StopGameSessionPlacement'
components:
  schemas:
    Float:
      type: number
      format: float
    InvalidRequestException: {}
    GameSessionPlacementState:
      type: string
      enum:
      - PENDING
      - FULFILLED
      - CANCELLED
      - TIMED_OUT
      - FAILED
    Timestamp:
      type: string
      format: date-time
    PlayerLatency:
      type: object
      properties:
        PlayerId:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: A unique identifier for a player associated with the latency data.
        RegionIdentifier:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: Name of the Region that is associated with the latency value.
        LatencyInMilliseconds:
          allOf:
          - $ref: '#/components/schemas/Float'
          - description: Amount of time that represents the time lag experienced by the player when connected to the specified Region.
      description: 'Regional latency information for a player, used when requesting a new game session. This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified Region. The relative difference between a player''s latency values for multiple Regions are used to determine which fleets are best suited to place a new game session for the player. '
    StopGameSessionPlacementOutput:
      type: object
      properties:
        GameSessionPlacement:
          allOf:
          - $ref: '#/components/schemas/GameSessionPlacement'
          - description: 'Object that describes the canceled game session placement, with <code>CANCELLED</code> status and an end time stamp. '
    GamePropertyList:
      type: array
      items:
        $ref: '#/components/schemas/GameProperty'
      maxItems: 16
    StopGameSessionPlacementInput:
      type: object
      required:
      - PlacementId
      title: StopGameSessionPlacementInput
      properties:
        PlacementId:
          allOf:
          - $ref: '#/components/schemas/IdStringModel'
          - description: A unique identifier for a game session placement to stop.
    IdStringModel:
      type: string
      pattern: '[a-zA-Z0-9-]+'
      minLength: 1
      maxLength: 48
    PlayerLatencyList:
      type: array
      items:
        $ref: '#/components/schemas/PlayerLatency'
    NotFoundException: {}
    PlayerSessionId:
      type: string
      pattern: ^psess-\S+
    NonZeroAndMaxString:
      type: string
      minLength: 1
      maxLength: 1024
    GamePropertyKey:
      type: string
      maxLength: 32
    WholeNumber:
      type: integer
      minimum: 0
    InternalServiceException: {}
    GameSessionQueueName:
      type: string
      pattern: '[a-zA-Z0-9-]+'
      minLength: 1
      maxLength: 128
    LargeGameSessionData:
      type: string
      minLength: 1
      maxLength: 262144
    IpAddress:
      type: string
      pattern: ^[0-9A-Fa-f\:\.]+
      minLength: 1
      maxLength: 128
    PlacedPlayerSessionList:
      type: array
      items:
        $ref: '#/components/schemas/PlacedPlayerSession'
    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>.
    MatchmakerData:
      type: string
      minLength: 1
      maxLength: 390000
    GamePropertyValue:
      type: string
      maxLength: 96
    PortNumber:
      type: integer
      minimum: 1
      maximum: 60000
    PlacedPlayerSession:
      type: object
      properties:
        PlayerId:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: A unique identifier for a player that is associated with this player session.
        PlayerSessionId:
          allOf:
          - $ref: '#/components/schemas/PlayerSessionId'
          - description: A unique identifier for a player session.
      description: Information about a player session. This object contains only the player ID and player session ID. To retrieve full details on a player session, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribePlayerSessions.html">DescribePlayerSessions</a> with the player session ID.
    DnsName:
      type: string
    UnauthorizedException: {}
    GameSessionPlacement:
      type: object
      properties:
        PlacementId:
          allOf:
          - $ref: '#/components/schemas/IdStringModel'
          - description: A unique identifier for a game session placement.
        GameSessionQueueName:
          allOf:
          - $ref: '#/components/schemas/GameSessionQueueName'
          - description: A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
        Status:
          allOf:
          - $ref: '#/components/schemas/GameSessionPlacementState'
          - description: <p>Current status of the game session placement request.</p> <ul> <li> <p> <b>PENDING</b> -- The placement request is currently in the queue waiting to be processed.</p> </li> <li> <p> <b>FULFILLED</b> -- A new game session and player sessions (if requested) have been successfully created. Values for <i>GameSessionArn</i> and <i>GameSessionRegion</i> are available. </p> </li> <li> <p> <b>CANCELLED</b> -- The placement request was canceled.</p> </li> <li> <p> <b>TIMED_OUT</b> -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.</p> </li> <li> <p> <b>FAILED</b> -- Amazon GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.</p> </li> </ul>
        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>).
        MaximumPlayerSessionCount:
          allOf:
          - $ref: '#/components/schemas/WholeNumber'
          - description: The maximum number of players that can be connected simultaneously to the game session.
        GameSessionName:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: A descriptive label that is associated with a game session. Session names do not need to be unique.
        GameSessionId:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: A unique identifier for the game session. This value is set once the new game session is placed (placement status is <code>FULFILLED</code>).
        GameSessionArn:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is <code>FULFILLED</code>). This identifier is unique across all Regions. You can use this value as a <code>GameSessionId</code> value as needed.
        GameSessionRegion:
          allOf:
          - $ref: '#/components/schemas/NonZeroAndMaxString'
          - description: Name of the Region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is <code>FULFILLED</code>).
        PlayerLatencies:
          allOf:
          - $ref: '#/components/schemas/PlayerLatencyList'
          - description: A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.
        StartTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example <code>"1469498468.057"</code>).
        EndTime:
          allOf:
          - $ref: '#/components/schemas/Timestamp'
          - description: Time stamp indicating when this request was completed, canceled, or timed out.
        IpAddress:
          allOf:
          - $ref: '#/components/schemas/IpAddress'
          - description: 'The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is <code>FULFILLED</code>). '
        DnsName:
          allOf:
          - $ref: '#/components/schemas/DnsName'
          - description: '<p>The DNS identifier assigned to the instance that is running the game session. Values have the following format:</p> <ul> <li> <p>TLS-enabled fleets: <code>&lt;unique identifier&gt;.&lt;region identifier&gt;.amazongamelift.com</code>.</p> </li> <li> <p>Non-TLS-enabled fleets: <code>ec2-&lt;unique identifier&gt;.compute.amazonaws.com</code>. (See <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses">Amazon EC2 Instance IP Addressing</a>.)</p> </li> </ul> <p>When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.</p>'
        Port:
          allOf:
          - $ref: '#/components/schemas/PortNumber'
          - description: The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is <code>FULFILLED</code>).
        PlacedPlayerSessions:
          allOf:
          - $ref: '#/components/schemas/PlacedPlayerSessionList'
          - description: A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is <code>FULFILLED</code>). This information includes the player ID (as provided in the placement request) and the corresponding player session ID.
        GameSessionData:
          allOf:
          - $ref: '#/components/schemas/LargeGameSessionData'
          - description: A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the <code>GameSession</code> object 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>).
        MatchmakerData:
          allOf:
          - $ref: '#/components/schemas/MatchmakerData'
          - description: Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data">Match Data</a>.
      description: This object includes the full details of the original request plus the current status and start/end time stamps.
  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