# DescribeGameSessionPlacement
<a name="API_DescribeGameSessionPlacement"></a>

 **This API works with the following fleet types:** EC2, Anywhere, Container

Retrieves information, including current status, about a game session placement request. 

To get game session placement details, specify the placement ID.

This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with `DescribeGameSessionPlacement` should only be used for games in development with low game session usage. For a reference implementation of event-based game session placement tracking, see [ Event-based game session placement guidance](https://github.com/amazon-gamelift/amazon-gamelift-toolkit/tree/main/event-based-session-placement) in the Amazon GameLift Toolkit.

## Request Syntax
<a name="API_DescribeGameSessionPlacement_RequestSyntax"></a>

```
{
   "PlacementId": "string"
}
```

## Request Parameters
<a name="API_DescribeGameSessionPlacement_RequestParameters"></a>

For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

**Note**  
In the following list, the required parameters are described first.

 ** [PlacementId](#API_DescribeGameSessionPlacement_RequestSyntax) **   <a name="gameliftservers-DescribeGameSessionPlacement-request-PlacementId"></a>
A unique identifier for a game session placement to retrieve.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 48.  
Pattern: `[a-zA-Z0-9-]+`   
Required: Yes

## Response Syntax
<a name="API_DescribeGameSessionPlacement_ResponseSyntax"></a>

```
{
   "GameSessionPlacement": { 
      "DnsName": "string",
      "EndTime": number,
      "GameProperties": [ 
         { 
            "Key": "string",
            "Value": "string"
         }
      ],
      "GameSessionArn": "string",
      "GameSessionData": "string",
      "GameSessionId": "string",
      "GameSessionName": "string",
      "GameSessionQueueName": "string",
      "GameSessionRegion": "string",
      "IpAddress": "string",
      "MatchmakerData": "string",
      "MaximumPlayerSessionCount": number,
      "PlacedPlayerSessions": [ 
         { 
            "PlayerId": "string",
            "PlayerSessionId": "string"
         }
      ],
      "PlacementId": "string",
      "PlayerGatewayStatus": "string",
      "PlayerLatencies": [ 
         { 
            "LatencyInMilliseconds": number,
            "PlayerId": "string",
            "RegionIdentifier": "string"
         }
      ],
      "Port": number,
      "PriorityConfigurationOverride": { 
         "LocationOrder": [ "string" ],
         "PlacementFallbackStrategy": "string"
      },
      "StartTime": number,
      "Status": "string"
   }
}
```

## Response Elements
<a name="API_DescribeGameSessionPlacement_ResponseElements"></a>

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

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

 ** [GameSessionPlacement](#API_DescribeGameSessionPlacement_ResponseSyntax) **   <a name="gameliftservers-DescribeGameSessionPlacement-response-GameSessionPlacement"></a>
Object that describes the requested game session placement.  
Type: [GameSessionPlacement](API_GameSessionPlacement.md) object

## Errors
<a name="API_DescribeGameSessionPlacement_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** InternalServiceException **   
The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.  
HTTP Status Code: 500

 ** InvalidRequestException **   
One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.  
HTTP Status Code: 400

 ** NotFoundException **   
The requested resources was not found. The resource was either not created yet or deleted.  
HTTP Status Code: 400

 ** UnauthorizedException **   
The client failed authentication. Clients should not retry such requests.  
HTTP Status Code: 400

## See Also
<a name="API_DescribeGameSessionPlacement_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/gamelift-2015-10-01/DescribeGameSessionPlacement) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/gamelift-2015-10-01/DescribeGameSessionPlacement) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/gamelift-2015-10-01/DescribeGameSessionPlacement) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/gamelift-2015-10-01/DescribeGameSessionPlacement) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/gamelift-2015-10-01/DescribeGameSessionPlacement) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/gamelift-2015-10-01/DescribeGameSessionPlacement) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/gamelift-2015-10-01/DescribeGameSessionPlacement) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/gamelift-2015-10-01/DescribeGameSessionPlacement) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/gamelift-2015-10-01/DescribeGameSessionPlacement) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/gamelift-2015-10-01/DescribeGameSessionPlacement)