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

Description

Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSessionQueue object is returned for each requested queue. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.

Learn more

View Your Queues

Related actions

CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeGameSessionQueues Source #

Represents the input for a request operation.

See: newDescribeGameSessionQueues smart constructor.

Constructors

DescribeGameSessionQueues' 

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.

  • names :: Maybe [Text]

    A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty.

  • limit :: Maybe Natural

    The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. You can request up to 50 results.

Instances

Instances details
Eq DescribeGameSessionQueues Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

Read DescribeGameSessionQueues Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

Show DescribeGameSessionQueues Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

Generic DescribeGameSessionQueues Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

Associated Types

type Rep DescribeGameSessionQueues :: Type -> Type #

NFData DescribeGameSessionQueues Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

Hashable DescribeGameSessionQueues Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

ToJSON DescribeGameSessionQueues Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

AWSPager DescribeGameSessionQueues Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

AWSRequest DescribeGameSessionQueues Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

ToHeaders DescribeGameSessionQueues Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

ToPath DescribeGameSessionQueues Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

ToQuery DescribeGameSessionQueues Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

type Rep DescribeGameSessionQueues Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

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

Defined in Amazonka.GameLift.DescribeGameSessionQueues

newDescribeGameSessionQueues :: DescribeGameSessionQueues Source #

Create a value of DescribeGameSessionQueues 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:DescribeGameSessionQueues', describeGameSessionQueues_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:names:DescribeGameSessionQueues', describeGameSessionQueues_names - A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty.

$sel:limit:DescribeGameSessionQueues', describeGameSessionQueues_limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. You can request up to 50 results.

Request Lenses

describeGameSessionQueues_nextToken :: Lens' DescribeGameSessionQueues (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.

describeGameSessionQueues_names :: Lens' DescribeGameSessionQueues (Maybe [Text]) Source #

A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty.

describeGameSessionQueues_limit :: Lens' DescribeGameSessionQueues (Maybe Natural) Source #

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. You can request up to 50 results.

Destructuring the Response

data DescribeGameSessionQueuesResponse Source #

Represents the returned data in response to a request operation.

See: newDescribeGameSessionQueuesResponse smart constructor.

Constructors

DescribeGameSessionQueuesResponse' 

Fields

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

  • gameSessionQueues :: Maybe [GameSessionQueue]

    A collection of objects that describe the requested game session queues.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeGameSessionQueuesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

Read DescribeGameSessionQueuesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

Show DescribeGameSessionQueuesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

Generic DescribeGameSessionQueuesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

Associated Types

type Rep DescribeGameSessionQueuesResponse :: Type -> Type #

NFData DescribeGameSessionQueuesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

type Rep DescribeGameSessionQueuesResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameSessionQueues

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

newDescribeGameSessionQueuesResponse Source #

Create a value of DescribeGameSessionQueuesResponse 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:DescribeGameSessionQueues', describeGameSessionQueuesResponse_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:gameSessionQueues:DescribeGameSessionQueuesResponse', describeGameSessionQueuesResponse_gameSessionQueues - A collection of objects that describe the requested game session queues.

$sel:httpStatus:DescribeGameSessionQueuesResponse', describeGameSessionQueuesResponse_httpStatus - The response's http status code.

Response Lenses

describeGameSessionQueuesResponse_nextToken :: Lens' DescribeGameSessionQueuesResponse (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.

describeGameSessionQueuesResponse_gameSessionQueues :: Lens' DescribeGameSessionQueuesResponse (Maybe [GameSessionQueue]) Source #

A collection of objects that describe the requested game session queues.