Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Requests an authorization token from GameLift. The authorization token is used by your game server to authenticate with GameLift. Each authentication token has an expiration token. To continue using the compute resource to host your game server, regularly retrieve a new authorization token.
Synopsis
- data GetComputeAuthToken = GetComputeAuthToken' {
- fleetId :: Text
- computeName :: Text
- newGetComputeAuthToken :: Text -> Text -> GetComputeAuthToken
- getComputeAuthToken_fleetId :: Lens' GetComputeAuthToken Text
- getComputeAuthToken_computeName :: Lens' GetComputeAuthToken Text
- data GetComputeAuthTokenResponse = GetComputeAuthTokenResponse' {
- authToken :: Maybe Text
- computeArn :: Maybe Text
- computeName :: Maybe Text
- expirationTimestamp :: Maybe POSIX
- fleetArn :: Maybe Text
- fleetId :: Maybe Text
- httpStatus :: Int
- newGetComputeAuthTokenResponse :: Int -> GetComputeAuthTokenResponse
- getComputeAuthTokenResponse_authToken :: Lens' GetComputeAuthTokenResponse (Maybe Text)
- getComputeAuthTokenResponse_computeArn :: Lens' GetComputeAuthTokenResponse (Maybe Text)
- getComputeAuthTokenResponse_computeName :: Lens' GetComputeAuthTokenResponse (Maybe Text)
- getComputeAuthTokenResponse_expirationTimestamp :: Lens' GetComputeAuthTokenResponse (Maybe UTCTime)
- getComputeAuthTokenResponse_fleetArn :: Lens' GetComputeAuthTokenResponse (Maybe Text)
- getComputeAuthTokenResponse_fleetId :: Lens' GetComputeAuthTokenResponse (Maybe Text)
- getComputeAuthTokenResponse_httpStatus :: Lens' GetComputeAuthTokenResponse Int
Creating a Request
data GetComputeAuthToken Source #
See: newGetComputeAuthToken
smart constructor.
GetComputeAuthToken' | |
|
Instances
newGetComputeAuthToken Source #
Create a value of GetComputeAuthToken
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetComputeAuthToken
, getComputeAuthToken_fleetId
- A unique identifier for the fleet that the compute is registered to.
GetComputeAuthToken
, getComputeAuthToken_computeName
- The name of the compute resource you are requesting the authorization
token for.
Request Lenses
getComputeAuthToken_fleetId :: Lens' GetComputeAuthToken Text Source #
A unique identifier for the fleet that the compute is registered to.
getComputeAuthToken_computeName :: Lens' GetComputeAuthToken Text Source #
The name of the compute resource you are requesting the authorization token for.
Destructuring the Response
data GetComputeAuthTokenResponse Source #
See: newGetComputeAuthTokenResponse
smart constructor.
GetComputeAuthTokenResponse' | |
|
Instances
newGetComputeAuthTokenResponse Source #
Create a value of GetComputeAuthTokenResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:authToken:GetComputeAuthTokenResponse'
, getComputeAuthTokenResponse_authToken
- The authorization token that your game server uses to authenticate with
GameLift.
GetComputeAuthTokenResponse
, getComputeAuthTokenResponse_computeArn
- The Amazon Resource Name
(ARN)
that is assigned to a GameLift 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
GetComputeAuthToken
, getComputeAuthTokenResponse_computeName
- The name of the compute resource you are requesting the authorization
token for.
$sel:expirationTimestamp:GetComputeAuthTokenResponse'
, getComputeAuthTokenResponse_expirationTimestamp
- The amount of time until the authorization token is no longer valid. To
continue using the compute resource for game server hosting, renew the
authorization token by using this operation again.
GetComputeAuthTokenResponse
, getComputeAuthTokenResponse_fleetArn
- The Amazon Resource Name
(ARN)
that is assigned to a GameLift 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
.
GetComputeAuthToken
, getComputeAuthTokenResponse_fleetId
- A unique identifier for the fleet that the compute is registered to.
$sel:httpStatus:GetComputeAuthTokenResponse'
, getComputeAuthTokenResponse_httpStatus
- The response's http status code.
Response Lenses
getComputeAuthTokenResponse_authToken :: Lens' GetComputeAuthTokenResponse (Maybe Text) Source #
The authorization token that your game server uses to authenticate with GameLift.
getComputeAuthTokenResponse_computeArn :: Lens' GetComputeAuthTokenResponse (Maybe Text) Source #
The Amazon Resource Name
(ARN)
that is assigned to a GameLift 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
getComputeAuthTokenResponse_computeName :: Lens' GetComputeAuthTokenResponse (Maybe Text) Source #
The name of the compute resource you are requesting the authorization token for.
getComputeAuthTokenResponse_expirationTimestamp :: Lens' GetComputeAuthTokenResponse (Maybe UTCTime) Source #
The amount of time until the authorization token is no longer valid. To continue using the compute resource for game server hosting, renew the authorization token by using this operation again.
getComputeAuthTokenResponse_fleetArn :: Lens' GetComputeAuthTokenResponse (Maybe Text) Source #
The Amazon Resource Name
(ARN)
that is assigned to a GameLift 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
.
getComputeAuthTokenResponse_fleetId :: Lens' GetComputeAuthTokenResponse (Maybe Text) Source #
A unique identifier for the fleet that the compute is registered to.
getComputeAuthTokenResponse_httpStatus :: Lens' GetComputeAuthTokenResponse Int Source #
The response's http status code.