# C\$1\$1 server SDK 5.x for Amazon GameLift Servers -- Data types
Use the Amazon GameLift Servers C\$1\$1 server SDK 5.x reference to integrate your multiplayer game for hosting with Amazon GameLift Servers. For guidance about the integration process, see [Add Amazon GameLift Servers to your game server with the server SDK](gamelift-sdk-server-api.md).
**Note**
This topic describes the Amazon GameLift Servers C\$1\$1 API that you can use when you build with the C\$1\$1 Standard Library (`std`). Specifically, this documentation applies to code that you compile with the `-DDGAMELIFT_USE_STD=1` option.
[C\$1\$1 server SDK 5.x for Amazon GameLift Servers -- Actions](integration-server-sdk5-cpp-actions.md)
**Topics**
+ [LogParameters](#integration-server-sdk5-cpp-dataypes-log)
+ [MetricsParameters](#integration-server-sdk5-cpp-datatypes-metricsparameters)
+ [ProcessParameters](#integration-server-sdk5-cpp-dataypes-process)
+ [UpdateGameSession](#integration-server-sdk5-cpp-dataypes-updategamesession)
+ [GameSession](#integration-server-sdk5-cpp-dataypes-gamesession)
+ [ServerParameters](#integration-server-sdk5-cpp-dataypes-serverparameters)
+ [StartMatchBackfillRequest](#integration-server-sdk5-cpp-dataypes-startmatchbackfillrequest)
+ [Player](#integration-server-sdk5-cpp-dataypes-player)
+ [DescribePlayerSessionsRequest](#integration-server-sdk5-cpp-dataypes-playersessions)
+ [StopMatchBackfillRequest](#integration-server-sdk5-cpp-dataypes-stopmatchbackfillrequest)
+ [AttributeValue](#integration-server-sdk5-cpp-dataypes-attributevalue)
+ [GetFleetRoleCredentialsRequest](#integration-server-sdk5-cpp-dataypes-getfleetrolecredentialsrequest)
+ [AwsLongOutcome](#integration-server-sdk5-cpp-datatypes-awslongoutcome)
+ [AwsStringOutcome](#integration-server-sdk5-cpp-datatypes-awsstringoutcome)
+ [DescribePlayerSessionsOutcome](#integration-server-sdk5-cpp-datatypes-describeplayersessionsoutcome)
+ [DescribePlayerSessionsResult](#integration-server-sdk5-cpp-datatypes-describeplayersessionsresult)
+ [GenericOutcome](#integration-server-sdk5-cpp-datatypes-genericoutcome)
+ [GenericOutcomeCallable](#integration-server-sdk5-cpp-datatypes-genericoutcomecallable)
+ [PlayerSession](#integration-server-sdk5-cpp-datatypes-playersession)
+ [StartMatchBackfillOutcome](#integration-server-sdk5-cpp-datatypes-startmatchbackfilloutcome)
+ [StartMatchBackfillResult](#integration-server-sdk5-cpp-datatypes-startmatchbackfillresult)
+ [GetComputeCertificateOutcome](#integration-server-sdk5-cpp-datatypes-getcomputecertificateoutcome)
+ [GetComputeCertificateResult](#integration-server-sdk5-cpp-datatypes-getcomputecertificateresult)
+ [GetFleetRoleCredentialsOutcome](#integration-server-sdk5-cpp-datatypes-getfleetrolecredentialsoutcome)
+ [GetFleetRoleCredentialsResult](#integration-server-sdk5-cpp-datatypes-getfleetrolecredentialsresult)
+ [InitSDKOutcome](#integration-server-sdk5-cpp-datatypes-initsdkoutcome)
+ [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror)
+ [Enums](#integration-server-sdk5-cpp-dataypes-enums)
## LogParameters
An object identifying files generated during a game session that you want Amazon GameLift Servers to upload and store after the game session ends. The game server provides `LogParameters` to Amazon GameLift Servers as part of a `ProcessParameters` object in a [ProcessReady()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-processready) call.
| | |
| --- |--- |
| **Properties** | Description |
| LogPaths | The list of directory paths to game server log files you want Amazon GameLift Servers to store for future access. The server process generates these files during each game session. You define file paths and names in your game server and store them in the root game build directory. The log paths must be absolute. For example, if your game build stores game session logs in a path like `MyGame\sessionLogs\`, then the path would be `c:\game\MyGame\sessionLogs` on a Windows instance. **Type:** `std:vector` **Required:** No |
## MetricsParameters
Use this data type to configure metrics collection and crash reporting for the game server. The game server communicates `MetricsParameters` to Amazon GameLift Servers in an [InitMetrics()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-initmetrics) call.
| | |
| --- |--- |
| **Properties** | Description |
| StatsdHost | The hostname or IP address of the StatsD server for metrics collection. **Type:** `std::string` **Required:** No |
| StatsdPort | The port number of the StatsD server for metrics collection. **Type:** `int` **Required:** No |
| CrashReporterHost | The hostname or IP address of the crash reporter server. **Type:** `std::string` **Required:** No |
| CrashReporterPort | The port number of the crash reporter server. **Type:** `int` **Required:** No |
| FlushIntervalMs | The interval in milliseconds for flushing metrics data to the server. **Type:** `int` **Required:** No |
| MaxPacketSize | The maximum size in bytes for metrics packets sent to the server. **Type:** `int` **Required:** No |
## ProcessParameters
This data type contains the set of parameters sent to Amazon GameLift Servers in a [ProcessReady()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-processready).
| | |
| --- |--- |
| **Properties** | Description |
| LogParameters | An object with directory paths to files that are generated during a game session. Amazon GameLift Servers copies and stores the files for future access.**Type:** `Aws::GameLift::Server::LogParameters`**Required:** No |
| OnHealthCheck | The callback function that Amazon GameLift Servers invokes to request a health status report from the server process. Amazon GameLift Servers calls this function every 60 seconds and waits 60 seconds for a response. The server process returns TRUE if healthy, FALSE if not healthy. If no response is returned, Amazon GameLift Servers records the server process as not healthy.**Type:** `std::function onHealthCheck`**Required:** No |
| OnProcessTerminate | The callback function that Amazon GameLift Servers invokes to force the server process to shut down. After calling this function, Amazon GameLift Servers waits 5 minutes for the server process to shut down and respond with a [ProcessEnding()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-processending) call before it shuts down the server process.**Type:** `std::function onProcessTerminate`**Required:** Yes |
| OnStartGameSession | The callback function that Amazon GameLift Servers invokes to activate a new game session. Amazon GameLift Servers calls this function in response to a client request [CreateGameSession](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_CreateGameSession.html). The callback function passes a [GameSession](#integration-server-sdk5-cpp-dataypes-gamesession) object.**Type:** `const std::function onStartGameSession`**Required:** Yes |
| OnUpdateGameSession | The callback function that Amazon GameLift Servers invokes to pass an updated game session object to the server process. Amazon GameLift Servers calls this function when a match backfill request has been processed to provide updated matchmaker data. It passes a [GameSession](#integration-server-sdk5-cpp-dataypes-gamesession) object, a status update (updateReason), and the match backfill ticket ID.**Type:** `std::function onUpdateGameSession`**Required:** No |
| Port | The port number the server process listens on for new player connections. The value must fall into the port range configured for any fleet deploying this game server build. This port number is included in game session and player session objects, which game sessions use when connecting to a server process.**Type:** `Integer`**Required:** Yes |
## UpdateGameSession
This data type updates to a game session object, which includes the reason that the game session was updated and the related backfill ticket ID if backfill is used to fill player sessions in the game session.
| Properties | **Description** |
| --- | --- |
| GameSession | A [GameSession](#integration-server-sdk5-cpp-dataypes-gamesession) object. The GameSession object contains properties describing a game session. **Type:** `Aws::GameLift::Server::GameSession`**Required:** Yes |
| UpdateReason | The reason that the game session is being updated.**Type:** `Aws::GameLift::Server::UpdateReason`**Required:** Yes |
| BackfillTicketId | The ID of the backfill ticket attempting to update the game session.**Type:** `std::string`**Required:** No |
## GameSession
This data type provides details of a game session.
| Properties | **Description** |
| --- | --- |
| GameSessionId | A unique identifier for the game session. A game session ARN has the following format: `arn:aws:gamelift:::gamesession//`. **Type:** `std::string` **Required**: No |
| Name | A descriptive label of the game session. **Type:** `std::string` **Required**: No |
| FleetId | A unique identifier for the fleet that the game session is running on. **Type:** `std::string` **Required**: No |
| MaximumPlayerSessionCount | The maximum number of player connections to the game session. **Type:** `int` **Required**: No |
| Port | The port number for the game session. To connect to an Amazon GameLift Servers game server, an app needs both the IP address and port number. **Type:** `in` **Required**: No |
| IpAddress | The IP address of the game session. To connect to an Amazon GameLift Servers game server, an app needs both the IP address and port number. **Type:** `std::string` **Required**: No |
| GameSessionData | A set of custom game session properties, formatted as a single string value. **Type:** `std::string` **Required**: No |
| MatchmakerData | Information about the matchmaking process that was used to create the game session, in JSON syntax, formatted as a string. In addition to the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. **Type:** `std::string` **Required**: No |
| GameProperties | A set of custom properties for a game session, formatted as key:value pairs. These properties are passed with a request to start a new game session. **Type:** `std :: vector < GameProperty >` **Required**: No |
| DnsName | The DNS identifier assigned to the instance that's running the game session. Values have the following format: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) When connecting to a game session that's running on a TLS-enabled fleet, you must use the DNS name, not the IP address. **Type:** `std::string` **Required**: No |
## ServerParameters
Information that a game server process uses to establish a connection with the Amazon GameLift Servers service. Include these parameters when calling [InitSDK()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-initsdk-anywhere) only if the game server build will be deployed to an Anywhere fleet or a container fleet without the Amazon GameLift Servers Agent. For all other deployment scenarios, call [InitSDK()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-initsdk) without parameters.
| Properties | **Description** |
| --- | --- |
| webSocketUrl | The `GameLiftServerSdkEndpoint` Amazon GameLift Servers returns when you [https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html) for a Amazon GameLift Servers Anywhere compute resource. **Type:** `std::string` **Required**: Yes |
| processId | A unique identifier registered to the server process hosting your game. **Type:** `std::string` **Required**: Yes |
| hostId | The HostID is the ComputeName used when you registered your compute. For more information see, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).**Type:** `std::string`**Required**: Yes |
| fleetId | The unique identifier of the fleet that the compute is registered to. For more information see, [RegisterCompute](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_RegisterCompute.html).**Type:** `std::string`**Required**: Yes |
| authToken | The authentication token generated by Amazon GameLift Servers that authenticates your server to Amazon GameLift Servers. For more information see, [GetComputeAuthToken](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_GetComputeAuthToken.html).**Type:** `std::string`**Required**: Yes |
## StartMatchBackfillRequest
Information used to create a matchmaking backfill request. The game server communicates this information to Amazon GameLift Servers in a [StartMatchBackfill()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-startmatchbackfill) call.
| Properties | **Description** |
| --- | --- |
| GameSessionArn | A unique game session identifier. The API operation `[GetGameSessionId](https://docs.aws.amazon.com/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-actions.html#integration-server-sdk5-cpp-getgamesessionid)` returns the identifier in ARN format. **Type:** `std::string` **Required**: Yes |
| MatchmakingConfigurationArn | A unique identifier, in the form of an ARN, for the matchmaker to use for this request. The matchmaker ARN for the original game session is in the game session object in the matchmaker data property. Learn more about matchmaker data in [Work with matchmaker data](https://docs.aws.amazon.com/gameliftservers/latest/flexmatchguide/match-server.html#match-server-data.html). **Type:** `std::string` **Required**: Yes |
| Players | A set of data representing all players who are in the game session. The matchmaker uses this information to search for new players who are good matches for the current players. **Type:** `std::vector` **Required**: Yes |
| TicketId | A unique identifier for a matchmaking or match backfill request ticket. If you don't provide a value, Amazon GameLift Servers generates one. Use this identifier to track the match backfill ticket status or cancel the request if needed. **Type:** `std::string` **Required**: No |
## Player
This data type represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and possibly latency data. Amazon GameLift Servers adds team information after a match is made.
| Properties | **Description** |
| --- | --- |
| LatencyInMS | A set of values expressed in milliseconds that indicate the amount of latency that a player experiences when connected to a location. If this property is used, the player is only matched for locations listed. If a matchmaker has a rule that evaluates player latency, players must report latency to be matched. **Type:** `Dictionary` **Required**: No |
| PlayerAttributes | A collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the PlayerAttributes used in a matchmaking rule set. For more information about player attributes, see [AttributeValue](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_AttributeValue.html). **Type:** `std::map` **Required**: No |
| PlayerId | A unique identifier for a player. **Type:** `std::string` **Required**: No |
| Team | The name of the team that the player is assigned to in a match. You define team name in the matchmaking rule set. **Type:** `std::string` **Required**: No |
## DescribePlayerSessionsRequest
An object that specifies which player sessions to retrieve. The server process provides this information with a [DescribePlayerSessions()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-describeplayersessions) call to Amazon GameLift Servers.
| Properties | **Description** |
| --- | --- |
| GameSessionId | A unique game session identifier. Use this parameter to request all player sessions for the specified game session. Game session ID format is `arn:aws:gamelift:::gamesession/fleet-/`. The `GameSessionID` is a custom ID string or a **Type:** `std::string` **Required**: No |
| PlayerSessionId | The unique identifier for a player session. Use this parameter to request a single specific player session. **Type:** `std::string` **Required**: No |
| PlayerId | The unique identifier for a player. Use this parameter to request all player sessions for a specific player. See [Generate player IDs](player-sessions-player-identifiers.md). **Type:** `std::string` **Required**: No |
| PlayerSessionStatusFilter | The player session status to filter results on. Possible player session statuses include: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Type:** `std::string` **Required**: No |
| NextToken | The token indicating the start of the next page of results. To specify the start of the result set, don't provide a value. If you provide a player session ID, this parameter is ignored. **Type:** `std::string` **Required**: No |
| Limit | The maximum number of results to return. If you provide a player session ID, this parameter is ignored. **Type:** `int` **Required**: No |
## StopMatchBackfillRequest
Information used to cancel a matchmaking backfill request. The game server communicates this information to Amazon GameLift Servers service in a [StopMatchBackfill()](integration-server-sdk5-cpp-actions.md#integration-server-sdk5-cpp-stopmatchbackfill) call.
| Properties | **Description** |
| --- | --- |
| GameSessionArn | A unique game session identifier of the request being canceled. **Type:** `char[]` **Required**: No |
| MatchmakingConfigurationArn | A unique identifier of the matchmaker this request was sent to. **Type:** `char[]` **Required**: No |
| TicketId | A unique identifier of the backfill request ticket to be canceled. **Type:** `char[]` **Required**: No |
## AttributeValue
Use these values in [Player](#integration-server-sdk5-cpp-dataypes-player) attribute key-value pairs. This object lets you specify an attribute value using any of the valid data types: string, number, string array, or data map. Each `AttributeValue` object must use exactly one of the available properties: `S`, `N`, `SL`, or `SDM`.
| Properties | Description |
| --- | --- |
| AttrType | Specifies the type of attribute value. Possible attribute value types include: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Required:** No |
| S | Represents a string attribute value. **Type:** `std::string` **Required:** No |
| N | Represents a numeric attribute value. **Type:** `double` **Required:** No |
| SL | Represents an array of string attribute values. **Type:** `std::vector` **Required:** No |
| SDM | Represents a dictionary of string keys and double values. **Type:** `std::map` **Required:** No |
## GetFleetRoleCredentialsRequest
This data type gives the game server limited access to your other AWS resources. For more information see, [Set up an IAM service role for Amazon GameLift Servers](setting-up-role.md).
| Properties | **Description** |
| --- | --- |
| RoleArn | The Amazon Resource Name (ARN) of the service role that extends limited access to your AWS resources.**Type:** `std::string`**Required**: No |
| RoleSessionName | The role session name that you can use to uniquely identify an AWS Security Token Service [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) session. This name is exposed in audit logs such as those in CloudTrail. **Type:** `std::string` **Required**: No |
## AwsLongOutcome
This data type results from an action and produces an object with the following properties:
| Properties | Description |
| --- | --- |
| Result | The result of the action. **Type:** `long` **Required:** No |
| ResultWithOwnership | The result of the action, cast as an rvalue, so that the calling code can take ownership of the object. **Type:** `long&&` **Required**: No |
| Success | Whether the action was successful or not. **Type:** `bool` **Required**: Yes |
| Error | The error that occurred if the action was unsuccessful. **Type:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Required:** No |
## AwsStringOutcome
This data type results from an action and produces an object with the following properties:
| Properties | Description |
| --- | --- |
| Result | The result of the action. **Type:** `std::string` **Required:** No |
| ResultWithOwnership | The result of the action, cast as an rvalue, so that the calling code can take ownership of the object. **Type:** `long&&` **Required**: No |
| Success | Whether the action was successful or not. **Type:** `bool` **Required**: Yes |
| Error | The error that occurred if the action was unsuccessful. **Type:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Required:** No |
## DescribePlayerSessionsOutcome
This data type results from an action and produces an object with the following properties:
| Properties | Description |
| --- | --- |
| Result | The result of the action. **Type:** [DescribePlayerSessionsResult](#integration-server-sdk5-cpp-datatypes-describeplayersessionsresult) **Required:** No |
| ResultWithOwnership | The result of the action, cast as an rvalue, so that the calling code can take ownership of the object. **Type:** `Aws::GameLift::Server::Model::DescribePlayerSessionsResult&&` **Required**: No |
| Success | Whether the action was successful or not. **Type:** `bool` **Required**: Yes |
| Error | The error that occurred if the action was unsuccessful. **Type:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Required:** No |
## DescribePlayerSessionsResult
A collection of objects containing properties for each player session that matches the request.
| Properties | Description |
| --- | --- |
| NextToken | 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. If a player session ID is specified, this parameter is ignored. **Type:** `std::string` **Required:** Yes |
| PlayerSessions | **Type:** `IList` **Required:** |
| ResultWithOwnership | The result of the action, cast as an rvalue, so that the calling code can take ownership of the object. **Type:** `std::string&&` **Required**: No |
| Success | Whether the action was successful or not. **Type:** `bool` **Required**: Yes |
| Error | The error that occurred if the action was unsuccessful. **Type:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Required:** No |
## GenericOutcome
This data type results from an action and produces an object with the following properties:
| Properties | Description |
| --- | --- |
| Success | Whether the action was successful or not. **Type:** `bool` **Required**: Yes |
| Error | The error that occurred if the action was unsuccessful. **Type:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Required:** No |
## GenericOutcomeCallable
This data type is an asynchronous generic outcome. It has the following properties:
| Properties | Description |
| --- | --- |
| Success | Whether the action was successful or not. **Type:** `bool` **Required**: Yes |
| Error | The error that occurred if the action was unsuccessful. **Type:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Required:** No |
## PlayerSession
This data type represents a player session that Amazon GameLift Servers passes to the game server. For more information, see [PlayerSession](https://docs.aws.amazon.com/gameliftservers/latest/apireference/API_PlayerSession.html).
| Properties | Description |
| --- | --- |
| CreationTime | **Type:** `long` **Required:** No |
| FleetId | **Type:** `std::string` **Required:** No |
| GameSessionId | **Type:** `std::string` **Required:** No |
| IpAddress | **Type:** `std::string` **Required:** No |
| PlayerData | **Type:** `std::string` **Required:** No |
| PlayerId | **Type:** `std::string` **Required:** No |
| PlayerSessionId | **Type:** `std::string` **Required:** No |
| Port | **Type:** `int` **Required:** No |
| Status | Player session status to filter results on. When a PlayerSessionId or PlayerId is provided, then the PlayerSessionStatusFilter has no effect on the response. **Type:** A `PlayerSessionStatus` enum. Possible values include the following: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Required:** No |
| TerminationTime | **Type:** `long` **Required:** No |
| DnsName | **Type:** `std::string` **Required:** No |
## StartMatchBackfillOutcome
This data type results from an action and produces an object with the following properties:
| Properties | Description |
| --- | --- |
| Result | The result of the action. **Type:** [StartMatchBackfillResult](#integration-server-sdk5-cpp-datatypes-startmatchbackfillresult) **Required:** No |
| ResultWithOwnership | The result of the action, cast as an rvalue, so that the calling code can take ownership of the object. **Type:** `StartMatchBackfillResult&&` **Required**: No |
| Success | Whether the action was successful or not. **Type:** `bool` **Required**: Yes |
| Error | The error that occurred if the action was unsuccessful. **Type:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Required:** No |
## StartMatchBackfillResult
This data type results from an action and produces an object with the following properties:
| Properties | Description |
| --- | --- |
| TicketId | A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift Servers will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results. **Type:** `std::string` **Required:** No |
## GetComputeCertificateOutcome
This data type results from an action and produces an object with the following properties:
| Properties | Description |
| --- | --- |
| Result | The result of the action. **Type:** [GetComputeCertificateResult](#integration-server-sdk5-cpp-datatypes-getcomputecertificateresult) **Required:** No |
| ResultWithOwnership | The result of the action, cast as an rvalue, so that the calling code can take ownership of the object. **Type:** `Aws::GameLift::Server::Model::GetComputeCertificateResult&&` **Required**: No |
| Success | Whether the action was successful or not. **Type:** `bool` **Required**: Yes |
| Error | The error that occurred if the action was unsuccessful. **Type:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Required:** No |
## GetComputeCertificateResult
The path to the TLS certificate on your compute and the compute's host name.
| Properties | Description |
| --- | --- |
| CertificatePath | The path to the TLS certificate on your compute resource. When using an Amazon GameLift Servers managed fleet, this path contains: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/gameliftservers/latest/developerguide/integration-server-sdk5-cpp-datatypes.html) **Type:** `std::string` **Required:** No |
| ComputeName | The name of your compute resource. **Type:** `std::string` **Required:** No |
## GetFleetRoleCredentialsOutcome
This data type results from an action and produces an object with the following properties:
| Properties | Description |
| --- | --- |
| Result | The result of the action. **Type:** [GetFleetRoleCredentialsResult](#integration-server-sdk5-cpp-datatypes-getfleetrolecredentialsresult) **Required:** No |
| ResultWithOwnership | The result of the action, cast as an rvalue, so that the calling code can take ownership of the object. **Type:** `Aws::GameLift::Server::Model::GetFleetRoleCredentialsResult` **Required**: No |
| Success | Whether the action was successful or not. **Type:** `bool` **Required**: Yes |
| Error | The error that occurred if the action was unsuccessful. **Type:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Required:** No |
## GetFleetRoleCredentialsResult
| Properties | Description |
| --- | --- |
| AccessKeyId | The access key ID to authenticate and provide access to your AWS resources. **Type:** `string` **Required:** No |
| AssumedRoleId | The ID of the user that the service role belongs to. **Type:** `string` **Required:** No |
| AssumedRoleUserArn | The Amazon Resource Name (ARN) of the user that the service role belongs to. **Type:** `string` **Required:** No |
| Expiration | The amount of time until your session credentials expire. **Type:** `DateTime` **Required:** No |
| SecretAccessKey | The secret access key ID for authentication. **Type:** `string` **Required:** No |
| SessionToken | A token to identify the current active session interacting with your AWS resources. **Type:** `string` **Required:** No |
| Success | Whether the action was successful or not. **Type:** `bool` **Required**: Yes |
| Error | The error that occurred if the action was unsuccessful. **Type:** [GameLiftError](integration-server-sdk5-csharp-datatypes.md#integration-server-sdk5-csharp-datatypes-gamelifterror) **Required:** No |
## InitSDKOutcome
**Note**
`InitSDKOutcome` is returned only when you build the SDK with the `std` flag. If you build with the `nostd` flag, then [GenericOutcome](#integration-server-sdk5-cpp-datatypes-genericoutcome) is returned instead.
| Properties | Description |
| --- | --- |
| Success | Whether the action was successful or not. **Type:** `bool` **Required**: Yes |
| Error | The error that occurred if the action was unsuccessful. **Type:** [GameLiftError](#integration-server-sdk5-cpp-datatypes-gamelifterror) **Required:** No |
## GameLiftError
| Properties | Description |
| --- | --- |
| ErrorType | The type of error. **Type:** A `GameLiftErrorType` [enum](#integration-server-sdk5-cpp-dataypes-enums). **Required:** No |
| ErrorName | The name of the error. **Type:** `std::string` **Required:** No |
| ErrorMessage | The error message. **Type:** `std::string` **Required:** No |
## Enums
Enums defined for the server SDK for Amazon GameLift Servers (C\$1\$1) are defined as follows:
**GameLiftErrorType**
String value indicating the error type. Valid values include:
+ **BAD\$1REQUEST\$1EXCEPTION**
+ **GAMESESSION\$1ID\$1NOT\$1SET** – The game session ID has not been set.
+ **INTERNAL\$1SERVICE\$1EXCEPTION**
+ **LOCAL\$1CONNECTION\$1FAILED** – The local connection to Amazon GameLift Servers failed.
+ **NETWORK\$1NOT\$1INITIALIZED** – The network has not been initialized.
+ **SERVICE\$1CALL\$1FAILED** – A call to an AWS service has failed.
+ **WEBSOCKET\$1CONNECT\$1FAILURE**
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1FORBIDDEN**
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1INVALID\$1URL**
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1TIMEOUT**
+ **ALREADY\$1INITIALIZED** – The Amazon GameLift Servers Server or Client has already been initialized with Initialize().
+ **FLEET\$1MISMATCH** – The target fleet does not match the fleet of a gameSession or playerSession.
+ **GAMELIFT\$1CLIENT\$1NOT\$1INITIALIZED** – The Amazon GameLift Servers client has not been initialized.
+ **GAMELIFT\$1SERVER\$1NOT\$1INITIALIZED** – The Amazon GameLift Servers server has not been initialized.
+ **GAME\$1SESSION\$1ENDED\$1FAILED** – the server SDK for Amazon GameLift Servers could not contact the service to report the game session ended.
+ **GAME\$1SESSION\$1NOT\$1READY** – The Amazon GameLift Servers Server Game Session was not activated.
+ **GAME\$1SESSION\$1READY\$1FAILED** – the server SDK for Amazon GameLift Servers could not contact the service to report the game session is ready.
+ **INITIALIZATION\$1MISMATCH** – A client method was called after Server::Initialize(), or vice versa.
+ **NOT\$1INITIALIZED** – The Amazon GameLift Servers Server or Client has not been initialized with Initialize().
+ **NO\$1TARGET\$1ALIASID\$1SET** – A target aliasId has not been set.
+ **NO\$1TARGET\$1FLEET\$1SET** – A target fleet has not been set.
+ **PROCESS\$1ENDING\$1FAILED** – the server SDK for Amazon GameLift Servers could not contact the service to report the process is ending.
+ **PROCESS\$1NOT\$1ACTIVE** – The server process is not yet active, not bound to a GameSession, and cannot accept or process PlayerSessions.
+ **PROCESS\$1NOT\$1READY** – The server process is not yet ready to be activated.
+ **PROCESS\$1READY\$1FAILED** – the server SDK for Amazon GameLift Servers could not contact the service to report the process is ready.
+ **SDK\$1VERSION\$1DETECTION\$1FAILED** – SDK version detection failed.
+ **STX\$1CALL\$1FAILED** – A call to the XStx server backend component has failed.
+ **STX\$1INITIALIZATION\$1FAILED** – The XStx server backend component has failed to initialize.
+ **UNEXPECTED\$1PLAYER\$1SESSION** – An unregistered player session was encountered by the server.
+ **WEBSOCKET\$1CONNECT\$1FAILURE**
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1FORBIDDEN**
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1INVALID\$1URL**
+ **WEBSOCKET\$1CONNECT\$1FAILURE\$1TIMEOUT**
+ **WEBSOCKET\$1RETRIABLE\$1SEND\$1MESSAGE\$1FAILURE** – Retriable failure to send a message to the GameLift Service WebSocket.
+ **WEBSOCKET\$1SEND\$1MESSAGE\$1FAILURE** – Failure to send a message to the GameLift Service WebSocket.
+ **MATCH\$1BACKFILL\$1REQUEST\$1VALIDATION** – Validation of the request failed.
+ **PLAYER\$1SESSION\$1REQUEST\$1VALIDATION** – Validation of the request failed.
**PlayerSessionCreationPolicy**
String value indicating whether the game session accepts new players. Valid values include:
+ **ACCEPT\$1ALL** – Accept all new player sessions.
+ **DENY\$1ALL** – Deny all new player sessions.
+ **NOT\$1SET** – The game session is not set to accept or deny new player sessions.