Network.AWS.GameLift.DescribeMatchmakingConfigurations

Retrieves the details of FlexMatch matchmaking configurations. with this operation, you have the following options: (1) retrieve all existing configurations, (2) provide the names of one or more configurations to retrieve, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.

Operations related to match configurations and rule sets include:

• CreateMatchmakingConfiguration
• DescribeMatchmakingConfigurations
• UpdateMatchmakingConfiguration
• DeleteMatchmakingConfiguration
• CreateMatchmakingRuleSet
• DescribeMatchmakingRuleSets
• ValidateMatchmakingRuleSet

Creating a Request

describeMatchmakingConfigurations :: DescribeMatchmakingConfigurations

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

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

• dmcRuleSetName - Unique identifier for a matchmaking rule set. Use this parameter to retrieve all matchmaking configurations that use this rule set.
• dmcNextToken - 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.
• dmcNames - Unique identifier for a matchmaking configuration(s) to retrieve. To request all existing configurations, leave this parameter empty.
• dmcLimit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages. This parameter is limited to 10.

data DescribeMatchmakingConfigurations

Represents the input for a request action.

See: describeMatchmakingConfigurations smart constructor.

Instances

Eq DescribeMatchmakingConfigurations

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Methods

(==) :: DescribeMatchmakingConfigurations -> DescribeMatchmakingConfigurations -> Bool

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

Data DescribeMatchmakingConfigurations

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Methods

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

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

toConstr :: DescribeMatchmakingConfigurations -> Constr

dataTypeOf :: DescribeMatchmakingConfigurations -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeMatchmakingConfigurations

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Methods

readsPrec :: Int -> ReadS DescribeMatchmakingConfigurations

readList :: ReadS [DescribeMatchmakingConfigurations]

readPrec :: ReadPrec DescribeMatchmakingConfigurations

readListPrec :: ReadPrec [DescribeMatchmakingConfigurations]

Show DescribeMatchmakingConfigurations

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Methods

showsPrec :: Int -> DescribeMatchmakingConfigurations -> ShowS

show :: DescribeMatchmakingConfigurations -> String

showList :: [DescribeMatchmakingConfigurations] -> ShowS

Generic DescribeMatchmakingConfigurations

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Associated Types

type Rep DescribeMatchmakingConfigurations :: Type -> Type

Methods

from :: DescribeMatchmakingConfigurations -> Rep DescribeMatchmakingConfigurations x

to :: Rep DescribeMatchmakingConfigurations x -> DescribeMatchmakingConfigurations

Hashable DescribeMatchmakingConfigurations

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Methods

hashWithSalt :: Int -> DescribeMatchmakingConfigurations -> Int

hash :: DescribeMatchmakingConfigurations -> Int

ToJSON DescribeMatchmakingConfigurations

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Methods

toJSON :: DescribeMatchmakingConfigurations -> Value

toEncoding :: DescribeMatchmakingConfigurations -> Encoding

toJSONList :: [DescribeMatchmakingConfigurations] -> Value

toEncodingList :: [DescribeMatchmakingConfigurations] -> Encoding

AWSRequest DescribeMatchmakingConfigurations

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Associated Types

type Rs DescribeMatchmakingConfigurations :: Type

Methods

request :: DescribeMatchmakingConfigurations -> Request DescribeMatchmakingConfigurations

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

ToHeaders DescribeMatchmakingConfigurations

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Methods

toHeaders :: DescribeMatchmakingConfigurations -> [Header]

ToPath DescribeMatchmakingConfigurations

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Methods

toPath :: DescribeMatchmakingConfigurations -> ByteString

ToQuery DescribeMatchmakingConfigurations

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Methods

toQuery :: DescribeMatchmakingConfigurations -> QueryString

NFData DescribeMatchmakingConfigurations

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Methods

rnf :: DescribeMatchmakingConfigurations -> ()

type Rep DescribeMatchmakingConfigurations

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

type Rep DescribeMatchmakingConfigurations = D1 (MetaData "DescribeMatchmakingConfigurations" "Network.AWS.GameLift.DescribeMatchmakingConfigurations" "amazonka-gamelift-1.6.1-GajLKSxsevT2faX837q2Xl" False) (C1 (MetaCons "DescribeMatchmakingConfigurations'" PrefixI True) ((S1 (MetaSel (Just "_dmcRuleSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dmcNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_dmcNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_dmcLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)))))

type Rs DescribeMatchmakingConfigurations

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

type Rs DescribeMatchmakingConfigurations = DescribeMatchmakingConfigurationsResponse

Request Lenses

dmcRuleSetName :: Lens' DescribeMatchmakingConfigurations (Maybe Text)

Unique identifier for a matchmaking rule set. Use this parameter to retrieve all matchmaking configurations that use this rule set.

dmcNextToken :: Lens' DescribeMatchmakingConfigurations (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.

dmcNames :: Lens' DescribeMatchmakingConfigurations [Text]

Unique identifier for a matchmaking configuration(s) to retrieve. To request all existing configurations, leave this parameter empty.

dmcLimit :: Lens' DescribeMatchmakingConfigurations (Maybe Natural)

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

Destructuring the Response

describeMatchmakingConfigurationsResponse

Arguments

:: Int

dmcsrsResponseStatus

-> DescribeMatchmakingConfigurationsResponse

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

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

• dmcsrsConfigurations - Collection of requested matchmaking configuration objects.
• dmcsrsNextToken - 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.
• dmcsrsResponseStatus - -- | The response status code.

data DescribeMatchmakingConfigurationsResponse

Represents the returned data in response to a request action.

See: describeMatchmakingConfigurationsResponse smart constructor.

Instances

Eq DescribeMatchmakingConfigurationsResponse

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Methods

(==) :: DescribeMatchmakingConfigurationsResponse -> DescribeMatchmakingConfigurationsResponse -> Bool

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

Data DescribeMatchmakingConfigurationsResponse

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Methods

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

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

toConstr :: DescribeMatchmakingConfigurationsResponse -> Constr

dataTypeOf :: DescribeMatchmakingConfigurationsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeMatchmakingConfigurationsResponse

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Methods

readsPrec :: Int -> ReadS DescribeMatchmakingConfigurationsResponse

readList :: ReadS [DescribeMatchmakingConfigurationsResponse]

readPrec :: ReadPrec DescribeMatchmakingConfigurationsResponse

readListPrec :: ReadPrec [DescribeMatchmakingConfigurationsResponse]

Show DescribeMatchmakingConfigurationsResponse

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Methods

showsPrec :: Int -> DescribeMatchmakingConfigurationsResponse -> ShowS

show :: DescribeMatchmakingConfigurationsResponse -> String

showList :: [DescribeMatchmakingConfigurationsResponse] -> ShowS

Generic DescribeMatchmakingConfigurationsResponse

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Associated Types

type Rep DescribeMatchmakingConfigurationsResponse :: Type -> Type

Methods

from :: DescribeMatchmakingConfigurationsResponse -> Rep DescribeMatchmakingConfigurationsResponse x

to :: Rep DescribeMatchmakingConfigurationsResponse x -> DescribeMatchmakingConfigurationsResponse

NFData DescribeMatchmakingConfigurationsResponse

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

Methods

rnf :: DescribeMatchmakingConfigurationsResponse -> ()

type Rep DescribeMatchmakingConfigurationsResponse

Defined in Network.AWS.GameLift.DescribeMatchmakingConfigurations

type Rep DescribeMatchmakingConfigurationsResponse = D1 (MetaData "DescribeMatchmakingConfigurationsResponse" "Network.AWS.GameLift.DescribeMatchmakingConfigurations" "amazonka-gamelift-1.6.1-GajLKSxsevT2faX837q2Xl" False) (C1 (MetaCons "DescribeMatchmakingConfigurationsResponse'" PrefixI True) (S1 (MetaSel (Just "_dmcsrsConfigurations") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [MatchmakingConfiguration])) :*: (S1 (MetaSel (Just "_dmcsrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_dmcsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

dmcsrsConfigurations :: Lens' DescribeMatchmakingConfigurationsResponse [MatchmakingConfiguration]

Collection of requested matchmaking configuration objects.

dmcsrsNextToken :: Lens' DescribeMatchmakingConfigurationsResponse (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.

dmcsrsResponseStatus :: Lens' DescribeMatchmakingConfigurationsResponse Int

• - | The response status code.