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

Amazonka.GameLift.GetComputeAuthToken

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Constructors

GetComputeAuthToken'
Fields fleetId :: Text A unique identifier for the fleet that the compute is registered to. computeName :: Text The name of the compute resource you are requesting the authorization token for.

Instances

Instances details

ToJSON GetComputeAuthToken Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Methods toJSON :: GetComputeAuthToken -> Value # toEncoding :: GetComputeAuthToken -> Encoding # toJSONList :: [GetComputeAuthToken] -> Value # toEncodingList :: [GetComputeAuthToken] -> Encoding #
ToHeaders GetComputeAuthToken Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Methods toHeaders :: GetComputeAuthToken -> [Header] #
ToPath GetComputeAuthToken Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Methods toPath :: GetComputeAuthToken -> ByteString #
ToQuery GetComputeAuthToken Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Methods toQuery :: GetComputeAuthToken -> QueryString #
AWSRequest GetComputeAuthToken Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Associated Types type AWSResponse GetComputeAuthToken # Methods request :: (Service -> Service) -> GetComputeAuthToken -> Request GetComputeAuthToken # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetComputeAuthToken -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetComputeAuthToken))) #
Generic GetComputeAuthToken Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Associated Types type Rep GetComputeAuthToken :: Type -> Type # Methods from :: GetComputeAuthToken -> Rep GetComputeAuthToken x # to :: Rep GetComputeAuthToken x -> GetComputeAuthToken #
Read GetComputeAuthToken Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Methods readsPrec :: Int -> ReadS GetComputeAuthToken # readList :: ReadS [GetComputeAuthToken] # readPrec :: ReadPrec GetComputeAuthToken # readListPrec :: ReadPrec [GetComputeAuthToken] #
Show GetComputeAuthToken Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Methods showsPrec :: Int -> GetComputeAuthToken -> ShowS # show :: GetComputeAuthToken -> String # showList :: [GetComputeAuthToken] -> ShowS #
NFData GetComputeAuthToken Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Methods rnf :: GetComputeAuthToken -> () #
Eq GetComputeAuthToken Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Methods (==) :: GetComputeAuthToken -> GetComputeAuthToken -> Bool # (/=) :: GetComputeAuthToken -> GetComputeAuthToken -> Bool #
Hashable GetComputeAuthToken Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Methods hashWithSalt :: Int -> GetComputeAuthToken -> Int # hash :: GetComputeAuthToken -> Int #
type AWSResponse GetComputeAuthToken Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken type AWSResponse GetComputeAuthToken = GetComputeAuthTokenResponse
type Rep GetComputeAuthToken Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken type Rep GetComputeAuthToken = D1 ('MetaData "GetComputeAuthToken" "Amazonka.GameLift.GetComputeAuthToken" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "GetComputeAuthToken'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "computeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetComputeAuthToken Source #

Arguments

:: Text	`GetComputeAuthToken`
-> Text	`GetComputeAuthToken`
-> GetComputeAuthToken

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.

Constructors

GetComputeAuthTokenResponse'

Fields

authToken :: Maybe Text
The authorization token that your game server uses to authenticate with GameLift.
computeArn :: Maybe Text
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
computeName :: Maybe Text
The name of the compute resource you are requesting the authorization token for.
expirationTimestamp :: Maybe POSIX
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.
fleetArn :: Maybe Text
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.
fleetId :: Maybe Text
A unique identifier for the fleet that the compute is registered to.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetComputeAuthTokenResponse Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Associated Types type Rep GetComputeAuthTokenResponse :: Type -> Type # Methods from :: GetComputeAuthTokenResponse -> Rep GetComputeAuthTokenResponse x # to :: Rep GetComputeAuthTokenResponse x -> GetComputeAuthTokenResponse #
Read GetComputeAuthTokenResponse Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Methods readsPrec :: Int -> ReadS GetComputeAuthTokenResponse # readList :: ReadS [GetComputeAuthTokenResponse] # readPrec :: ReadPrec GetComputeAuthTokenResponse # readListPrec :: ReadPrec [GetComputeAuthTokenResponse] #
Show GetComputeAuthTokenResponse Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Methods showsPrec :: Int -> GetComputeAuthTokenResponse -> ShowS # show :: GetComputeAuthTokenResponse -> String # showList :: [GetComputeAuthTokenResponse] -> ShowS #
NFData GetComputeAuthTokenResponse Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Methods rnf :: GetComputeAuthTokenResponse -> () #
Eq GetComputeAuthTokenResponse Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken Methods (==) :: GetComputeAuthTokenResponse -> GetComputeAuthTokenResponse -> Bool # (/=) :: GetComputeAuthTokenResponse -> GetComputeAuthTokenResponse -> Bool #
type Rep GetComputeAuthTokenResponse Source #
Instance details Defined in Amazonka.GameLift.GetComputeAuthToken type Rep GetComputeAuthTokenResponse = D1 ('MetaData "GetComputeAuthTokenResponse" "Amazonka.GameLift.GetComputeAuthToken" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "GetComputeAuthTokenResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "computeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "computeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "expirationTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "fleetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetComputeAuthTokenResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetComputeAuthTokenResponse'`
-> GetComputeAuthTokenResponse

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.