Network.AWS.GameLift.DescribeGameSessionQueues

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.

Queue-related operations include:

• CreateGameSessionQueue
• DescribeGameSessionQueues
• UpdateGameSessionQueue
• DeleteGameSessionQueue

Creating a Request

describeGameSessionQueues :: DescribeGameSessionQueues

Creates a value of DescribeGameSessionQueues with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dgsqNextToken - Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.
• dgsqNames - List of queue names to retrieve information for. To request settings for all queues, leave this parameter empty.
• dgsqLimit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

data DescribeGameSessionQueues

Represents the input for a request action.

See: describeGameSessionQueues smart constructor.

Instances

Eq DescribeGameSessionQueues

Methods

(==) :: DescribeGameSessionQueues -> DescribeGameSessionQueues -> Bool

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

Data DescribeGameSessionQueues

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeGameSessionQueues -> c DescribeGameSessionQueues

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeGameSessionQueues

toConstr :: DescribeGameSessionQueues -> Constr

dataTypeOf :: DescribeGameSessionQueues -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeGameSessionQueues)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeGameSessionQueues)

gmapT :: (forall b. Data b => b -> b) -> DescribeGameSessionQueues -> DescribeGameSessionQueues

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGameSessionQueues -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGameSessionQueues -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeGameSessionQueues -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeGameSessionQueues -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeGameSessionQueues -> m DescribeGameSessionQueues

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGameSessionQueues -> m DescribeGameSessionQueues

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGameSessionQueues -> m DescribeGameSessionQueues

Read DescribeGameSessionQueues

Methods

readsPrec :: Int -> ReadS DescribeGameSessionQueues

readList :: ReadS [DescribeGameSessionQueues]

readPrec :: ReadPrec DescribeGameSessionQueues

readListPrec :: ReadPrec [DescribeGameSessionQueues]

Show DescribeGameSessionQueues

Methods

showsPrec :: Int -> DescribeGameSessionQueues -> ShowS

show :: DescribeGameSessionQueues -> String

showList :: [DescribeGameSessionQueues] -> ShowS

Generic DescribeGameSessionQueues

Associated Types

type Rep DescribeGameSessionQueues :: * -> *

Methods

from :: DescribeGameSessionQueues -> Rep DescribeGameSessionQueues x

to :: Rep DescribeGameSessionQueues x -> DescribeGameSessionQueues

Hashable DescribeGameSessionQueues

Methods

hashWithSalt :: Int -> DescribeGameSessionQueues -> Int

hash :: DescribeGameSessionQueues -> Int

ToJSON DescribeGameSessionQueues

Methods

toJSON :: DescribeGameSessionQueues -> Value

toEncoding :: DescribeGameSessionQueues -> Encoding

toJSONList :: [DescribeGameSessionQueues] -> Value

toEncodingList :: [DescribeGameSessionQueues] -> Encoding

NFData DescribeGameSessionQueues

Methods

rnf :: DescribeGameSessionQueues -> ()

AWSRequest DescribeGameSessionQueues

Associated Types

type Rs DescribeGameSessionQueues :: *

Methods

request :: DescribeGameSessionQueues -> Request DescribeGameSessionQueues

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeGameSessionQueues -> ClientResponse -> m (Response DescribeGameSessionQueues)

ToHeaders DescribeGameSessionQueues

Methods

toHeaders :: DescribeGameSessionQueues -> [Header]

ToPath DescribeGameSessionQueues

Methods

toPath :: DescribeGameSessionQueues -> ByteString

ToQuery DescribeGameSessionQueues

Methods

toQuery :: DescribeGameSessionQueues -> QueryString

type Rep DescribeGameSessionQueues

type Rep DescribeGameSessionQueues = D1 * (MetaData "DescribeGameSessionQueues" "Network.AWS.GameLift.DescribeGameSessionQueues" "amazonka-gamelift-1.6.0-DeAosbEJJf8D8cv8ebS5Uv" False) (C1 * (MetaCons "DescribeGameSessionQueues'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dgsqNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dgsqNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_dgsqLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))

type Rs DescribeGameSessionQueues

type Rs DescribeGameSessionQueues = DescribeGameSessionQueuesResponse

Request Lenses

dgsqNextToken :: Lens' DescribeGameSessionQueues (Maybe Text)

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

dgsqNames :: Lens' DescribeGameSessionQueues [Text]

List of queue names to retrieve information for. To request settings for all queues, leave this parameter empty.

dgsqLimit :: Lens' DescribeGameSessionQueues (Maybe Natural)

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

Destructuring the Response

describeGameSessionQueuesResponse

Arguments

:: Int

drsResponseStatus

-> DescribeGameSessionQueuesResponse

Creates a value of DescribeGameSessionQueuesResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• drsNextToken - Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
• drsGameSessionQueues - Collection of objects that describes the requested game session queues.
• drsResponseStatus - -- | The response status code.

data DescribeGameSessionQueuesResponse

Represents the returned data in response to a request action.

See: describeGameSessionQueuesResponse smart constructor.

Instances

Eq DescribeGameSessionQueuesResponse

Methods

(==) :: DescribeGameSessionQueuesResponse -> DescribeGameSessionQueuesResponse -> Bool

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

Data DescribeGameSessionQueuesResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeGameSessionQueuesResponse -> c DescribeGameSessionQueuesResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeGameSessionQueuesResponse

toConstr :: DescribeGameSessionQueuesResponse -> Constr

dataTypeOf :: DescribeGameSessionQueuesResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeGameSessionQueuesResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeGameSessionQueuesResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeGameSessionQueuesResponse -> DescribeGameSessionQueuesResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGameSessionQueuesResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGameSessionQueuesResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeGameSessionQueuesResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeGameSessionQueuesResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeGameSessionQueuesResponse -> m DescribeGameSessionQueuesResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGameSessionQueuesResponse -> m DescribeGameSessionQueuesResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGameSessionQueuesResponse -> m DescribeGameSessionQueuesResponse

Read DescribeGameSessionQueuesResponse

Methods

readsPrec :: Int -> ReadS DescribeGameSessionQueuesResponse

readList :: ReadS [DescribeGameSessionQueuesResponse]

readPrec :: ReadPrec DescribeGameSessionQueuesResponse

readListPrec :: ReadPrec [DescribeGameSessionQueuesResponse]

Show DescribeGameSessionQueuesResponse

Methods

showsPrec :: Int -> DescribeGameSessionQueuesResponse -> ShowS

show :: DescribeGameSessionQueuesResponse -> String

showList :: [DescribeGameSessionQueuesResponse] -> ShowS

Generic DescribeGameSessionQueuesResponse

Associated Types

type Rep DescribeGameSessionQueuesResponse :: * -> *

Methods

from :: DescribeGameSessionQueuesResponse -> Rep DescribeGameSessionQueuesResponse x

to :: Rep DescribeGameSessionQueuesResponse x -> DescribeGameSessionQueuesResponse

NFData DescribeGameSessionQueuesResponse

Methods

rnf :: DescribeGameSessionQueuesResponse -> ()

type Rep DescribeGameSessionQueuesResponse

type Rep DescribeGameSessionQueuesResponse = D1 * (MetaData "DescribeGameSessionQueuesResponse" "Network.AWS.GameLift.DescribeGameSessionQueues" "amazonka-gamelift-1.6.0-DeAosbEJJf8D8cv8ebS5Uv" False) (C1 * (MetaCons "DescribeGameSessionQueuesResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_drsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_drsGameSessionQueues") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [GameSessionQueue]))) (S1 * (MetaSel (Just Symbol "_drsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

drsNextToken :: Lens' DescribeGameSessionQueuesResponse (Maybe Text)

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

drsGameSessionQueues :: Lens' DescribeGameSessionQueuesResponse [GameSessionQueue]

Collection of objects that describes the requested game session queues.

drsResponseStatus :: Lens' DescribeGameSessionQueuesResponse Int

• - | The response status code.