Network.AWS.GameLift.DescribeMatchmakingRuleSets

Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.

Operations related to match configurations and rule sets include:

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

Creating a Request

describeMatchmakingRuleSets :: DescribeMatchmakingRuleSets

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

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

• dmrsNextToken - 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.
• dmrsNames - Unique identifier for a matchmaking rule set. This name is used to identify the rule set associated with a matchmaking configuration.
• dmrsLimit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

data DescribeMatchmakingRuleSets

Represents the input for a request action.

See: describeMatchmakingRuleSets smart constructor.

Instances

Eq DescribeMatchmakingRuleSets

Methods

(==) :: DescribeMatchmakingRuleSets -> DescribeMatchmakingRuleSets -> Bool

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

Data DescribeMatchmakingRuleSets

Methods

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

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

toConstr :: DescribeMatchmakingRuleSets -> Constr

dataTypeOf :: DescribeMatchmakingRuleSets -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeMatchmakingRuleSets

Methods

readsPrec :: Int -> ReadS DescribeMatchmakingRuleSets

readList :: ReadS [DescribeMatchmakingRuleSets]

readPrec :: ReadPrec DescribeMatchmakingRuleSets

readListPrec :: ReadPrec [DescribeMatchmakingRuleSets]

Show DescribeMatchmakingRuleSets

Methods

showsPrec :: Int -> DescribeMatchmakingRuleSets -> ShowS

show :: DescribeMatchmakingRuleSets -> String

showList :: [DescribeMatchmakingRuleSets] -> ShowS

Generic DescribeMatchmakingRuleSets

Associated Types

type Rep DescribeMatchmakingRuleSets :: * -> *

Methods

from :: DescribeMatchmakingRuleSets -> Rep DescribeMatchmakingRuleSets x

to :: Rep DescribeMatchmakingRuleSets x -> DescribeMatchmakingRuleSets

Hashable DescribeMatchmakingRuleSets

Methods

hashWithSalt :: Int -> DescribeMatchmakingRuleSets -> Int

hash :: DescribeMatchmakingRuleSets -> Int

ToJSON DescribeMatchmakingRuleSets

Methods

toJSON :: DescribeMatchmakingRuleSets -> Value

toEncoding :: DescribeMatchmakingRuleSets -> Encoding

toJSONList :: [DescribeMatchmakingRuleSets] -> Value

toEncodingList :: [DescribeMatchmakingRuleSets] -> Encoding

NFData DescribeMatchmakingRuleSets

Methods

rnf :: DescribeMatchmakingRuleSets -> ()

AWSRequest DescribeMatchmakingRuleSets

Associated Types

type Rs DescribeMatchmakingRuleSets :: *

Methods

request :: DescribeMatchmakingRuleSets -> Request DescribeMatchmakingRuleSets

response :: MonadResource m => Logger -> Service -> Proxy * DescribeMatchmakingRuleSets -> ClientResponse -> m (Response DescribeMatchmakingRuleSets)

ToQuery DescribeMatchmakingRuleSets

Methods

toQuery :: DescribeMatchmakingRuleSets -> QueryString

ToPath DescribeMatchmakingRuleSets

Methods

toPath :: DescribeMatchmakingRuleSets -> ByteString

ToHeaders DescribeMatchmakingRuleSets

Methods

toHeaders :: DescribeMatchmakingRuleSets -> [Header]

type Rep DescribeMatchmakingRuleSets

type Rep DescribeMatchmakingRuleSets = D1 (MetaData "DescribeMatchmakingRuleSets" "Network.AWS.GameLift.DescribeMatchmakingRuleSets" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "DescribeMatchmakingRuleSets'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dmrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dmrsNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (List1 Text)))) (S1 (MetaSel (Just Symbol "_dmrsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))))

type Rs DescribeMatchmakingRuleSets

type Rs DescribeMatchmakingRuleSets = DescribeMatchmakingRuleSetsResponse

Request Lenses

dmrsNextToken :: Lens' DescribeMatchmakingRuleSets (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.

dmrsNames :: Lens' DescribeMatchmakingRuleSets (Maybe (NonEmpty Text))

Unique identifier for a matchmaking rule set. This name is used to identify the rule set associated with a matchmaking configuration.

dmrsLimit :: Lens' DescribeMatchmakingRuleSets (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

describeMatchmakingRuleSetsResponse

Arguments

:: Int

dmrsrsResponseStatus

-> DescribeMatchmakingRuleSetsResponse

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

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

• dmrsrsNextToken - 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.
• dmrsrsResponseStatus - -- | The response status code.
• dmrsrsRuleSets - Collection of requested matchmaking rule set objects.

data DescribeMatchmakingRuleSetsResponse

Represents the returned data in response to a request action.

See: describeMatchmakingRuleSetsResponse smart constructor.

Instances

Eq DescribeMatchmakingRuleSetsResponse

Methods

(==) :: DescribeMatchmakingRuleSetsResponse -> DescribeMatchmakingRuleSetsResponse -> Bool

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

Data DescribeMatchmakingRuleSetsResponse

Methods

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

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

toConstr :: DescribeMatchmakingRuleSetsResponse -> Constr

dataTypeOf :: DescribeMatchmakingRuleSetsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read DescribeMatchmakingRuleSetsResponse

Methods

readsPrec :: Int -> ReadS DescribeMatchmakingRuleSetsResponse

readList :: ReadS [DescribeMatchmakingRuleSetsResponse]

readPrec :: ReadPrec DescribeMatchmakingRuleSetsResponse

readListPrec :: ReadPrec [DescribeMatchmakingRuleSetsResponse]

Show DescribeMatchmakingRuleSetsResponse

Methods

showsPrec :: Int -> DescribeMatchmakingRuleSetsResponse -> ShowS

show :: DescribeMatchmakingRuleSetsResponse -> String

showList :: [DescribeMatchmakingRuleSetsResponse] -> ShowS

Generic DescribeMatchmakingRuleSetsResponse

Associated Types

type Rep DescribeMatchmakingRuleSetsResponse :: * -> *

Methods

from :: DescribeMatchmakingRuleSetsResponse -> Rep DescribeMatchmakingRuleSetsResponse x

to :: Rep DescribeMatchmakingRuleSetsResponse x -> DescribeMatchmakingRuleSetsResponse

NFData DescribeMatchmakingRuleSetsResponse

Methods

rnf :: DescribeMatchmakingRuleSetsResponse -> ()

type Rep DescribeMatchmakingRuleSetsResponse

type Rep DescribeMatchmakingRuleSetsResponse = D1 (MetaData "DescribeMatchmakingRuleSetsResponse" "Network.AWS.GameLift.DescribeMatchmakingRuleSets" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "DescribeMatchmakingRuleSetsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dmrsrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dmrsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_dmrsrsRuleSets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [MatchmakingRuleSet])))))

Response Lenses

dmrsrsNextToken :: Lens' DescribeMatchmakingRuleSetsResponse (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.

dmrsrsResponseStatus :: Lens' DescribeMatchmakingRuleSetsResponse Int

• - | The response status code.

dmrsrsRuleSets :: Lens' DescribeMatchmakingRuleSetsResponse [MatchmakingRuleSet]

Collection of requested matchmaking rule set objects.