Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.GameLift.DescribeGameSessionDetails

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve all game session properties, use DescribeGameSessions.

This operation can be used in the following ways:

To retrieve details for all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns details from the fleet's home Region and all remote locations.
To retrieve details for all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.
To retrieve details for a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the AWS Region defined in the request.

Use the pagination parameters to retrieve results as a set of sequential pages.

If successful, a GameSessionDetail object is returned for each game session that matches the request.

Learn more

Find a game session

Related actions

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeGameSessionDetails Source #

Represents the input for a request operation.

See: newDescribeGameSessionDetails smart constructor.

Constructors

DescribeGameSessionDetails'

Fields

location :: Maybe Text
A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as us-west-2.
gameSessionId :: Maybe Text
A unique identifier for the game session to retrieve.
aliasId :: Maybe Text
A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.
nextToken :: Maybe Text
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.
statusFilter :: Maybe Text
Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).
limit :: Maybe Natural
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
fleetId :: Maybe Text
A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

Instances

Instances details

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

newDescribeGameSessionDetails :: DescribeGameSessionDetails Source #

Create a value of DescribeGameSessionDetails 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:location:DescribeGameSessionDetails', describeGameSessionDetails_location - A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as us-west-2.

$sel:gameSessionId:DescribeGameSessionDetails', describeGameSessionDetails_gameSessionId - A unique identifier for the game session to retrieve.

$sel:aliasId:DescribeGameSessionDetails', describeGameSessionDetails_aliasId - A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

$sel:nextToken:DescribeGameSessionDetails', describeGameSessionDetails_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.

$sel:statusFilter:DescribeGameSessionDetails', describeGameSessionDetails_statusFilter - Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

$sel:limit:DescribeGameSessionDetails', describeGameSessionDetails_limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

$sel:fleetId:DescribeGameSessionDetails', describeGameSessionDetails_fleetId - A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

Request Lenses

describeGameSessionDetails_location :: Lens' DescribeGameSessionDetails (Maybe Text) Source #

A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the AWS Region code format, such as us-west-2.

describeGameSessionDetails_gameSessionId :: Lens' DescribeGameSessionDetails (Maybe Text) Source #

A unique identifier for the game session to retrieve.

describeGameSessionDetails_aliasId :: Lens' DescribeGameSessionDetails (Maybe Text) Source #

A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

describeGameSessionDetails_nextToken :: Lens' DescribeGameSessionDetails (Maybe Text) Source #

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.

describeGameSessionDetails_statusFilter :: Lens' DescribeGameSessionDetails (Maybe Text) Source #

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

describeGameSessionDetails_limit :: Lens' DescribeGameSessionDetails (Maybe Natural) Source #

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

describeGameSessionDetails_fleetId :: Lens' DescribeGameSessionDetails (Maybe Text) Source #

A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

Destructuring the Response

data DescribeGameSessionDetailsResponse Source #

Represents the returned data in response to a request operation.

See: newDescribeGameSessionDetailsResponse smart constructor.

Constructors

DescribeGameSessionDetailsResponse'
Fields gameSessionDetails :: Maybe [GameSessionDetail] A collection of properties for each game session that matches the request. nextToken :: Maybe Text A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeGameSessionDetailsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessionDetails Methods (==) :: DescribeGameSessionDetailsResponse -> DescribeGameSessionDetailsResponse -> Bool # (/=) :: DescribeGameSessionDetailsResponse -> DescribeGameSessionDetailsResponse -> Bool #
Read DescribeGameSessionDetailsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessionDetails Methods readsPrec :: Int -> ReadS DescribeGameSessionDetailsResponse # readList :: ReadS [DescribeGameSessionDetailsResponse] # readPrec :: ReadPrec DescribeGameSessionDetailsResponse # readListPrec :: ReadPrec [DescribeGameSessionDetailsResponse] #
Show DescribeGameSessionDetailsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessionDetails Methods showsPrec :: Int -> DescribeGameSessionDetailsResponse -> ShowS # show :: DescribeGameSessionDetailsResponse -> String # showList :: [DescribeGameSessionDetailsResponse] -> ShowS #
Generic DescribeGameSessionDetailsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessionDetails Associated Types type Rep DescribeGameSessionDetailsResponse :: Type -> Type # Methods from :: DescribeGameSessionDetailsResponse -> Rep DescribeGameSessionDetailsResponse x # to :: Rep DescribeGameSessionDetailsResponse x -> DescribeGameSessionDetailsResponse #
NFData DescribeGameSessionDetailsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessionDetails Methods rnf :: DescribeGameSessionDetailsResponse -> () #
type Rep DescribeGameSessionDetailsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessionDetails type Rep DescribeGameSessionDetailsResponse = D1 ('MetaData "DescribeGameSessionDetailsResponse" "Amazonka.GameLift.DescribeGameSessionDetails" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DescribeGameSessionDetailsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameSessionDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GameSessionDetail])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeGameSessionDetailsResponse Source #

Arguments

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

Create a value of DescribeGameSessionDetailsResponse 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:gameSessionDetails:DescribeGameSessionDetailsResponse', describeGameSessionDetailsResponse_gameSessionDetails - A collection of properties for each game session that matches the request.

$sel:nextToken:DescribeGameSessionDetails', describeGameSessionDetailsResponse_nextToken - A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

$sel:httpStatus:DescribeGameSessionDetailsResponse', describeGameSessionDetailsResponse_httpStatus - The response's http status code.

Response Lenses

describeGameSessionDetailsResponse_gameSessionDetails :: Lens' DescribeGameSessionDetailsResponse (Maybe [GameSessionDetail]) Source #

A collection of properties for each game session that matches the request.

describeGameSessionDetailsResponse_nextToken :: Lens' DescribeGameSessionDetailsResponse (Maybe Text) Source #

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

describeGameSessionDetailsResponse_httpStatus :: Lens' DescribeGameSessionDetailsResponse Int Source #

The response's http status code.