DescribeMatchmakingRuleSetsRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the DescribeMatchmakingRuleSets operation. 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.

Learn more

Build a rule set

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.GameLift.AmazonGameLiftRequest
      Amazon.GameLift.Model.DescribeMatchmakingRuleSetsRequest

Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

public class DescribeMatchmakingRuleSetsRequest : AmazonGameLiftRequest
         IAmazonWebServiceRequest

The DescribeMatchmakingRuleSetsRequest type exposes the following members

Constructors

	Name	Description
	DescribeMatchmakingRuleSetsRequest()

Properties

Name Type Description

Name	Type	Description
Limit	System.Nullable<System.Int32>	Gets and sets the property Limit. The maximum number of results to return. Use this parameter with `NextToken` to get results as a set of sequential pages.
Names	System.Collections.Generic.List<System.String>	Gets and sets the property Names. A list of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
NextToken	System.String	Gets and sets the property 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.

Limit

System.Nullable<System.Int32>

Gets and sets the property Limit.

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

Names

System.Collections.Generic.List<System.String>

Gets and sets the property Names.

A list of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value.

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

NextToken

System.String

Gets and sets the property 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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer