libZSservicesZSamazonka-gameliftZSamazonka-gamelift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GameLift.DescribeGameServerGroup

Description

__This operation is used with the GameLift FleetIQ solution and game server groups.__

Retrieves information on a game server group. This operation returns only properties related to GameLift FleetIQ. To view or update properties for the corresponding Auto Scaling group, such as launch template, auto scaling policies, and maximum/minimum group size, access the Auto Scaling group directly.

To get attributes for a game server group, provide a group name or ARN value. If successful, a GameServerGroup object is returned.

Learn more

GameLift FleetIQ Guide

Related actions

CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | All APIs by task

Synopsis

Creating a Request

data DescribeGameServerGroup Source #

See: newDescribeGameServerGroup smart constructor.

Constructors

DescribeGameServerGroup' 

Fields

  • gameServerGroupName :: Text

    A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Instances

Instances details
Eq DescribeGameServerGroup Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

Read DescribeGameServerGroup Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

Show DescribeGameServerGroup Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

Generic DescribeGameServerGroup Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

Associated Types

type Rep DescribeGameServerGroup :: Type -> Type #

NFData DescribeGameServerGroup Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

Methods

rnf :: DescribeGameServerGroup -> () #

Hashable DescribeGameServerGroup Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

ToJSON DescribeGameServerGroup Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

AWSRequest DescribeGameServerGroup Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

ToHeaders DescribeGameServerGroup Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

ToPath DescribeGameServerGroup Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

ToQuery DescribeGameServerGroup Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

type Rep DescribeGameServerGroup Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

type Rep DescribeGameServerGroup = D1 ('MetaData "DescribeGameServerGroup" "Amazonka.GameLift.DescribeGameServerGroup" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DescribeGameServerGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameServerGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeGameServerGroup Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

newDescribeGameServerGroup Source #

Create a value of DescribeGameServerGroup 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:gameServerGroupName:DescribeGameServerGroup', describeGameServerGroup_gameServerGroupName - A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Request Lenses

describeGameServerGroup_gameServerGroupName :: Lens' DescribeGameServerGroup Text Source #

A unique identifier for the game server group. Use either the GameServerGroup name or ARN value.

Destructuring the Response

data DescribeGameServerGroupResponse Source #

See: newDescribeGameServerGroupResponse smart constructor.

Constructors

DescribeGameServerGroupResponse' 

Fields

Instances

Instances details
Eq DescribeGameServerGroupResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

Read DescribeGameServerGroupResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

Show DescribeGameServerGroupResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

Generic DescribeGameServerGroupResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

Associated Types

type Rep DescribeGameServerGroupResponse :: Type -> Type #

NFData DescribeGameServerGroupResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

type Rep DescribeGameServerGroupResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServerGroup

type Rep DescribeGameServerGroupResponse = D1 ('MetaData "DescribeGameServerGroupResponse" "Amazonka.GameLift.DescribeGameServerGroup" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DescribeGameServerGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameServerGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GameServerGroup)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeGameServerGroupResponse Source #

Create a value of DescribeGameServerGroupResponse 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:gameServerGroup:DescribeGameServerGroupResponse', describeGameServerGroupResponse_gameServerGroup - An object with the property settings for the requested game server group resource.

$sel:httpStatus:DescribeGameServerGroupResponse', describeGameServerGroupResponse_httpStatus - The response's http status code.

Response Lenses

describeGameServerGroupResponse_gameServerGroup :: Lens' DescribeGameServerGroupResponse (Maybe GameServerGroup) Source #

An object with the property settings for the requested game server group resource.