Module Values.GetComputeAuthTokenOutputSource

This API works with the following fleet types: EC2, Anywhere, Container Requests an authentication token from Amazon GameLift Servers for a compute resource in an Amazon GameLift Servers fleet. Game servers that are running on the compute use this token to communicate with the Amazon GameLift Servers service, such as when calling the Amazon GameLift Servers server SDK action InitSDK(). Authentication tokens are valid for a limited time span, so you need to request a fresh token before the current token expires. Request options For managed EC2 fleets (compute type EC2), auth token retrieval and refresh is handled automatically. All game servers that are running on all fleet instances have access to a valid auth token. For Anywhere fleets (compute type ANYWHERE), if you're using the Amazon GameLift Servers Agent, auth token retrieval and refresh is handled automatically for any compute where the Agent is running. If you're not using the Agent, create a mechanism to retrieve and refresh auth tokens for computes that are running game server processes. Learn more Create an Anywhere fleet Test your integration Server SDK reference guides (for version 5.x)

Sourcetype nonrec t = {
  1. fleetId : FleetIdOrArn.t option;
    (*

    A unique identifier for the fleet that the compute is registered to.

    *)
  2. fleetArn : FleetArn.t option;
    (*

    The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

    *)
  3. computeName : ComputeNameOrArn.t option;
    (*

    The name of the compute resource that the authentication token is issued to.

    *)
  4. computeArn : ComputeArn.t option;
    (*

    The Amazon Resource Name (ARN) that is assigned to an Amazon GameLift Servers compute resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912.

    *)
  5. authToken : ComputeAuthToken.t option;
    (*

    A valid temporary authentication token.

    *)
  6. expirationTimestamp : Timestamp.t option;
    (*

    The amount of time until the authentication token is no longer valid.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalServiceException of InternalServiceException.t
  2. | `InvalidRequestException of InvalidRequestException.t
  3. | `NotFoundException of NotFoundException.t
  4. | `UnauthorizedException of UnauthorizedException.t
  5. | `UnsupportedRegionException of UnsupportedRegionException.t
  6. | `Unknown_operation_error of string * string option
]
Sourceval make : ?fleetId:??? -> ?fleetArn:??? -> ?computeName:??? -> ?computeArn:??? -> ?authToken:??? -> ?expirationTimestamp:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalServiceException of InternalServiceException.t | `InvalidRequestException of InvalidRequestException.t | `NotFoundException of NotFoundException.t | `UnauthorizedException of UnauthorizedException.t | `Unknown_operation_error of string * string option | `UnsupportedRegionException of UnsupportedRegionException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalServiceException of InternalServiceException.t | `InvalidRequestException of InvalidRequestException.t | `NotFoundException of NotFoundException.t | `UnauthorizedException of UnauthorizedException.t | `Unknown_operation_error of string * string option | `UnsupportedRegionException of UnsupportedRegionException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `String of FleetIdOrArn.t | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t