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.ListGameServerGroups

Description

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

Retrieves information on all game servers groups that exist in the current AWS account for the selected Region. Use the pagination parameters to retrieve results in a set of sequential segments.

Learn more

GameLift FleetIQ Guide

Related actions

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

This operation returns paginated results.

Synopsis

Creating a Request

data ListGameServerGroups Source #

See: newListGameServerGroups smart constructor.

Constructors

ListGameServerGroups' 

Fields

  • 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.

  • limit :: Maybe Natural

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

Instances

Instances details
Eq ListGameServerGroups Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

Read ListGameServerGroups Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

Show ListGameServerGroups Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

Generic ListGameServerGroups Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

Associated Types

type Rep ListGameServerGroups :: Type -> Type #

NFData ListGameServerGroups Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

Methods

rnf :: ListGameServerGroups -> () #

Hashable ListGameServerGroups Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

ToJSON ListGameServerGroups Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

AWSPager ListGameServerGroups Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

AWSRequest ListGameServerGroups Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

Associated Types

type AWSResponse ListGameServerGroups #

ToHeaders ListGameServerGroups Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

ToPath ListGameServerGroups Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

ToQuery ListGameServerGroups Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

type Rep ListGameServerGroups Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

type Rep ListGameServerGroups = D1 ('MetaData "ListGameServerGroups" "Amazonka.GameLift.ListGameServerGroups" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "ListGameServerGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))
type AWSResponse ListGameServerGroups Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

newListGameServerGroups :: ListGameServerGroups Source #

Create a value of ListGameServerGroups 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:nextToken:ListGameServerGroups', listGameServerGroups_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:limit:ListGameServerGroups', listGameServerGroups_limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Request Lenses

listGameServerGroups_nextToken :: Lens' ListGameServerGroups (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.

listGameServerGroups_limit :: Lens' ListGameServerGroups (Maybe Natural) Source #

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

Destructuring the Response

data ListGameServerGroupsResponse Source #

See: newListGameServerGroupsResponse smart constructor.

Constructors

ListGameServerGroupsResponse' 

Fields

  • gameServerGroups :: Maybe [GameServerGroup]

    A collection of game server group objects that match 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 ListGameServerGroupsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

Read ListGameServerGroupsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

Show ListGameServerGroupsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

Generic ListGameServerGroupsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

Associated Types

type Rep ListGameServerGroupsResponse :: Type -> Type #

NFData ListGameServerGroupsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

type Rep ListGameServerGroupsResponse Source # 
Instance details

Defined in Amazonka.GameLift.ListGameServerGroups

type Rep ListGameServerGroupsResponse = D1 ('MetaData "ListGameServerGroupsResponse" "Amazonka.GameLift.ListGameServerGroups" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "ListGameServerGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameServerGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GameServerGroup])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListGameServerGroupsResponse Source #

Create a value of ListGameServerGroupsResponse 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:gameServerGroups:ListGameServerGroupsResponse', listGameServerGroupsResponse_gameServerGroups - A collection of game server group objects that match the request.

$sel:nextToken:ListGameServerGroups', listGameServerGroupsResponse_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:ListGameServerGroupsResponse', listGameServerGroupsResponse_httpStatus - The response's http status code.

Response Lenses

listGameServerGroupsResponse_gameServerGroups :: Lens' ListGameServerGroupsResponse (Maybe [GameServerGroup]) Source #

A collection of game server group objects that match the request.

listGameServerGroupsResponse_nextToken :: Lens' ListGameServerGroupsResponse (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.