Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GameLift.DescribeMatchmakingConfigurations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the details of FlexMatch matchmaking configurations.

This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, 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.

Learn more

Setting up FlexMatch matchmakers

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeMatchmakingConfigurations Source #

See: newDescribeMatchmakingConfigurations smart constructor.

Constructors

DescribeMatchmakingConfigurations'

Fields

limit :: Maybe Natural
The 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.
names :: Maybe [Text]
A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name or ARN value. To request all existing configurations, leave this parameter empty.
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.
ruleSetName :: Maybe Text
A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this parameter to retrieve all matchmaking configurations that use this rule set.

Instances

Instances details

ToJSON DescribeMatchmakingConfigurations Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Methods toJSON :: DescribeMatchmakingConfigurations -> Value # toEncoding :: DescribeMatchmakingConfigurations -> Encoding # toJSONList :: [DescribeMatchmakingConfigurations] -> Value # toEncodingList :: [DescribeMatchmakingConfigurations] -> Encoding #
ToHeaders DescribeMatchmakingConfigurations Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Methods toHeaders :: DescribeMatchmakingConfigurations -> [Header] #
ToPath DescribeMatchmakingConfigurations Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Methods toPath :: DescribeMatchmakingConfigurations -> ByteString #
ToQuery DescribeMatchmakingConfigurations Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Methods toQuery :: DescribeMatchmakingConfigurations -> QueryString #
AWSPager DescribeMatchmakingConfigurations Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Methods page :: DescribeMatchmakingConfigurations -> AWSResponse DescribeMatchmakingConfigurations -> Maybe DescribeMatchmakingConfigurations #
AWSRequest DescribeMatchmakingConfigurations Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Associated Types type AWSResponse DescribeMatchmakingConfigurations # Methods request :: (Service -> Service) -> DescribeMatchmakingConfigurations -> Request DescribeMatchmakingConfigurations # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeMatchmakingConfigurations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeMatchmakingConfigurations))) #
Generic DescribeMatchmakingConfigurations Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Associated Types type Rep DescribeMatchmakingConfigurations :: Type -> Type # Methods from :: DescribeMatchmakingConfigurations -> Rep DescribeMatchmakingConfigurations x # to :: Rep DescribeMatchmakingConfigurations x -> DescribeMatchmakingConfigurations #
Read DescribeMatchmakingConfigurations Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Methods readsPrec :: Int -> ReadS DescribeMatchmakingConfigurations # readList :: ReadS [DescribeMatchmakingConfigurations] # readPrec :: ReadPrec DescribeMatchmakingConfigurations # readListPrec :: ReadPrec [DescribeMatchmakingConfigurations] #
Show DescribeMatchmakingConfigurations Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Methods showsPrec :: Int -> DescribeMatchmakingConfigurations -> ShowS # show :: DescribeMatchmakingConfigurations -> String # showList :: [DescribeMatchmakingConfigurations] -> ShowS #
NFData DescribeMatchmakingConfigurations Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Methods rnf :: DescribeMatchmakingConfigurations -> () #
Eq DescribeMatchmakingConfigurations Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Methods (==) :: DescribeMatchmakingConfigurations -> DescribeMatchmakingConfigurations -> Bool # (/=) :: DescribeMatchmakingConfigurations -> DescribeMatchmakingConfigurations -> Bool #
Hashable DescribeMatchmakingConfigurations Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Methods hashWithSalt :: Int -> DescribeMatchmakingConfigurations -> Int # hash :: DescribeMatchmakingConfigurations -> Int #
type AWSResponse DescribeMatchmakingConfigurations Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations type AWSResponse DescribeMatchmakingConfigurations = DescribeMatchmakingConfigurationsResponse
type Rep DescribeMatchmakingConfigurations Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations type Rep DescribeMatchmakingConfigurations = D1 ('MetaData "DescribeMatchmakingConfigurations" "Amazonka.GameLift.DescribeMatchmakingConfigurations" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribeMatchmakingConfigurations'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "names") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ruleSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDescribeMatchmakingConfigurations :: DescribeMatchmakingConfigurations Source #

Create a value of DescribeMatchmakingConfigurations 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:limit:DescribeMatchmakingConfigurations', describeMatchmakingConfigurations_limit - The 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.

$sel:names:DescribeMatchmakingConfigurations', describeMatchmakingConfigurations_names - A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name or ARN value. To request all existing configurations, leave this parameter empty.

DescribeMatchmakingConfigurations, describeMatchmakingConfigurations_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.

DescribeMatchmakingConfigurations, describeMatchmakingConfigurations_ruleSetName - A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this parameter to retrieve all matchmaking configurations that use this rule set.

Request Lenses

describeMatchmakingConfigurations_limit :: Lens' DescribeMatchmakingConfigurations (Maybe Natural) Source #

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

describeMatchmakingConfigurations_names :: Lens' DescribeMatchmakingConfigurations (Maybe [Text]) Source #

A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name or ARN value. To request all existing configurations, leave this parameter empty.

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

describeMatchmakingConfigurations_ruleSetName :: Lens' DescribeMatchmakingConfigurations (Maybe Text) Source #

A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this parameter to retrieve all matchmaking configurations that use this rule set.

Destructuring the Response

data DescribeMatchmakingConfigurationsResponse Source #

See: newDescribeMatchmakingConfigurationsResponse smart constructor.

Constructors

DescribeMatchmakingConfigurationsResponse'
Fields configurations :: Maybe [MatchmakingConfiguration] A collection of requested matchmaking configurations. 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

Generic DescribeMatchmakingConfigurationsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Associated Types type Rep DescribeMatchmakingConfigurationsResponse :: Type -> Type # Methods from :: DescribeMatchmakingConfigurationsResponse -> Rep DescribeMatchmakingConfigurationsResponse x # to :: Rep DescribeMatchmakingConfigurationsResponse x -> DescribeMatchmakingConfigurationsResponse #
Read DescribeMatchmakingConfigurationsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Methods readsPrec :: Int -> ReadS DescribeMatchmakingConfigurationsResponse # readList :: ReadS [DescribeMatchmakingConfigurationsResponse] # readPrec :: ReadPrec DescribeMatchmakingConfigurationsResponse # readListPrec :: ReadPrec [DescribeMatchmakingConfigurationsResponse] #
Show DescribeMatchmakingConfigurationsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Methods showsPrec :: Int -> DescribeMatchmakingConfigurationsResponse -> ShowS # show :: DescribeMatchmakingConfigurationsResponse -> String # showList :: [DescribeMatchmakingConfigurationsResponse] -> ShowS #
NFData DescribeMatchmakingConfigurationsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Methods rnf :: DescribeMatchmakingConfigurationsResponse -> () #
Eq DescribeMatchmakingConfigurationsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations Methods (==) :: DescribeMatchmakingConfigurationsResponse -> DescribeMatchmakingConfigurationsResponse -> Bool # (/=) :: DescribeMatchmakingConfigurationsResponse -> DescribeMatchmakingConfigurationsResponse -> Bool #
type Rep DescribeMatchmakingConfigurationsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmakingConfigurations type Rep DescribeMatchmakingConfigurationsResponse = D1 ('MetaData "DescribeMatchmakingConfigurationsResponse" "Amazonka.GameLift.DescribeMatchmakingConfigurations" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribeMatchmakingConfigurationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MatchmakingConfiguration])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeMatchmakingConfigurationsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeMatchmakingConfigurationsResponse'`
-> DescribeMatchmakingConfigurationsResponse

Create a value of DescribeMatchmakingConfigurationsResponse 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:configurations:DescribeMatchmakingConfigurationsResponse', describeMatchmakingConfigurationsResponse_configurations - A collection of requested matchmaking configurations.

DescribeMatchmakingConfigurations, describeMatchmakingConfigurationsResponse_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:DescribeMatchmakingConfigurationsResponse', describeMatchmakingConfigurationsResponse_httpStatus - The response's http status code.

Response Lenses

describeMatchmakingConfigurationsResponse_configurations :: Lens' DescribeMatchmakingConfigurationsResponse (Maybe [MatchmakingConfiguration]) Source #

A collection of requested matchmaking configurations.

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

describeMatchmakingConfigurationsResponse_httpStatus :: Lens' DescribeMatchmakingConfigurationsResponse Int Source #

The response's http status code.