Amazonka.GameLift.DescribeGameServerGroup

__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

Creating a Request

data DescribeGameServerGroup

See: newDescribeGameServerGroup smart constructor.

Constructors

DescribeGameServerGroup'

Fields

• gameServerGroupName :: Text

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

Instances

ToJSON DescribeGameServerGroup

Defined in Amazonka.GameLift.DescribeGameServerGroup

Methods

toJSON :: DescribeGameServerGroup -> Value

toEncoding :: DescribeGameServerGroup -> Encoding

toJSONList :: [DescribeGameServerGroup] -> Value

toEncodingList :: [DescribeGameServerGroup] -> Encoding

ToHeaders DescribeGameServerGroup

Defined in Amazonka.GameLift.DescribeGameServerGroup

Methods

toHeaders :: DescribeGameServerGroup -> [Header]

ToPath DescribeGameServerGroup

Defined in Amazonka.GameLift.DescribeGameServerGroup

Methods

toPath :: DescribeGameServerGroup -> ByteString

ToQuery DescribeGameServerGroup

Defined in Amazonka.GameLift.DescribeGameServerGroup

Methods

toQuery :: DescribeGameServerGroup -> QueryString

AWSRequest DescribeGameServerGroup

Defined in Amazonka.GameLift.DescribeGameServerGroup

Associated Types

type AWSResponse DescribeGameServerGroup

Methods

request :: (Service -> Service) -> DescribeGameServerGroup -> Request DescribeGameServerGroup

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeGameServerGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeGameServerGroup)))

Generic DescribeGameServerGroup

Defined in Amazonka.GameLift.DescribeGameServerGroup

Associated Types

type Rep DescribeGameServerGroup :: Type -> Type

Methods

from :: DescribeGameServerGroup -> Rep DescribeGameServerGroup x

to :: Rep DescribeGameServerGroup x -> DescribeGameServerGroup

Read DescribeGameServerGroup

Defined in Amazonka.GameLift.DescribeGameServerGroup

Methods

readsPrec :: Int -> ReadS DescribeGameServerGroup

readList :: ReadS [DescribeGameServerGroup]

readPrec :: ReadPrec DescribeGameServerGroup

readListPrec :: ReadPrec [DescribeGameServerGroup]

Show DescribeGameServerGroup

Defined in Amazonka.GameLift.DescribeGameServerGroup

Methods

showsPrec :: Int -> DescribeGameServerGroup -> ShowS

show :: DescribeGameServerGroup -> String

showList :: [DescribeGameServerGroup] -> ShowS

NFData DescribeGameServerGroup

Defined in Amazonka.GameLift.DescribeGameServerGroup

Methods

rnf :: DescribeGameServerGroup -> ()

Eq DescribeGameServerGroup

Defined in Amazonka.GameLift.DescribeGameServerGroup

Methods

(==) :: DescribeGameServerGroup -> DescribeGameServerGroup -> Bool

(/=) :: DescribeGameServerGroup -> DescribeGameServerGroup -> Bool

Hashable DescribeGameServerGroup

Defined in Amazonka.GameLift.DescribeGameServerGroup

Methods

hashWithSalt :: Int -> DescribeGameServerGroup -> Int

hash :: DescribeGameServerGroup -> Int

type AWSResponse DescribeGameServerGroup

Defined in Amazonka.GameLift.DescribeGameServerGroup

type AWSResponse DescribeGameServerGroup = DescribeGameServerGroupResponse

type Rep DescribeGameServerGroup

Defined in Amazonka.GameLift.DescribeGameServerGroup

type Rep DescribeGameServerGroup = D1 ('MetaData "DescribeGameServerGroup" "Amazonka.GameLift.DescribeGameServerGroup" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribeGameServerGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameServerGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeGameServerGroup

Arguments

:: Text

DescribeGameServerGroup

-> DescribeGameServerGroup

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:

DescribeGameServerGroup, describeGameServerGroup_gameServerGroupName - A unique identifier for the game server group. Use either the name or ARN value.

Request Lenses

describeGameServerGroup_gameServerGroupName :: Lens' DescribeGameServerGroup Text

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

Destructuring the Response

data DescribeGameServerGroupResponse

See: newDescribeGameServerGroupResponse smart constructor.

Constructors

DescribeGameServerGroupResponse'

Fields

• gameServerGroup :: Maybe GameServerGroup

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeGameServerGroupResponse

Defined in Amazonka.GameLift.DescribeGameServerGroup

Associated Types

type Rep DescribeGameServerGroupResponse :: Type -> Type

Methods

from :: DescribeGameServerGroupResponse -> Rep DescribeGameServerGroupResponse x

to :: Rep DescribeGameServerGroupResponse x -> DescribeGameServerGroupResponse

Read DescribeGameServerGroupResponse

Defined in Amazonka.GameLift.DescribeGameServerGroup

Methods

readsPrec :: Int -> ReadS DescribeGameServerGroupResponse

readList :: ReadS [DescribeGameServerGroupResponse]

readPrec :: ReadPrec DescribeGameServerGroupResponse

readListPrec :: ReadPrec [DescribeGameServerGroupResponse]

Show DescribeGameServerGroupResponse

Defined in Amazonka.GameLift.DescribeGameServerGroup

Methods

showsPrec :: Int -> DescribeGameServerGroupResponse -> ShowS

show :: DescribeGameServerGroupResponse -> String

showList :: [DescribeGameServerGroupResponse] -> ShowS

NFData DescribeGameServerGroupResponse

Defined in Amazonka.GameLift.DescribeGameServerGroup

Methods

rnf :: DescribeGameServerGroupResponse -> ()

Eq DescribeGameServerGroupResponse

Defined in Amazonka.GameLift.DescribeGameServerGroup

Methods

(==) :: DescribeGameServerGroupResponse -> DescribeGameServerGroupResponse -> Bool

(/=) :: DescribeGameServerGroupResponse -> DescribeGameServerGroupResponse -> Bool

type Rep DescribeGameServerGroupResponse

Defined in Amazonka.GameLift.DescribeGameServerGroup

type Rep DescribeGameServerGroupResponse = D1 ('MetaData "DescribeGameServerGroupResponse" "Amazonka.GameLift.DescribeGameServerGroup" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" '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

Arguments

:: Int

$sel:httpStatus:DescribeGameServerGroupResponse'

-> DescribeGameServerGroupResponse

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)

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

describeGameServerGroupResponse_httpStatus :: Lens' DescribeGameServerGroupResponse Int

The response's http status code.