DisconnectPlayer - Amazon GameSparks

Amazon GameSparks is currently in preview. Changes might be made to this service and to this documentation. We don't recommend using this service for production workloads.

DisconnectPlayer

Disconnects a player from the game runtime.

If a player has multiple connections, this operation attempts to close all of them.

Request Syntax

POST /runtime/game/GameName/stage/StageName/player/PlayerId/disconnect HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

GameName

The name of the game.

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

PlayerId

The unique identifier representing a player.

Length Constraints: Minimum length of 1. Maximum length of 44.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

StageName

The name of the stage.

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: ^[a-zA-Z0-9_-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "DisconnectFailures": [ "string" ], "DisconnectSuccesses": [ "string" ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DisconnectFailures

The list of the connection ids that could not be disconnected.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 36.

DisconnectSuccesses

The list of the connection ids that were disconnected.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 36.

Errors

For information about the errors that are common to all actions, see Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The service encountered an internal error.

HTTP Status Code: 500

ResourceNotFoundException

The resource specified in the request does not exist.

HTTP Status Code: 404

ThrottlingException

The request throughput limit was exceeded.

HTTP Status Code: 429

ValidationException

One of the parameters in the request is invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: