AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::DescribeMatchmakingConfigurationsInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeMatchmakingConfigurationsInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  names: ["MatchmakingConfigurationName"],
  rule_set_name: "MatchmakingRuleSetName",
  limit: 1,
  next_token: "NonZeroAndMaxString",
}

Represents the input for a request operation.

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

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.

Returns:

  • (Integer)

    The maximum number of results to return.

#namesArray<String>

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

Returns:

  • (Array<String>)

    A unique identifier for a matchmaking configuration(s) to retrieve.

#next_tokenString

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.

Returns:

  • (String)

    A token that indicates the start of the next sequential page of results.

#rule_set_nameString

A unique identifier for a 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.

Returns:

  • (String)

    A unique identifier for a matchmaking rule set.