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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

Note:

When making an API call, you may pass DescribeMatchmakingConfigurationsInput data as a hash:

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

Represents the input for a request action.

Instance Attribute Summary collapse

Instance Attribute Details

#limitInteger

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)


2128
2129
2130
2131
2132
2133
2134
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2128

class DescribeMatchmakingConfigurationsInput < Struct.new(
  :names,
  :rule_set_name,
  :limit,
  :next_token)
  include Aws::Structure
end

#namesArray<String>

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

Returns:

  • (Array<String>)


2128
2129
2130
2131
2132
2133
2134
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2128

class DescribeMatchmakingConfigurationsInput < Struct.new(
  :names,
  :rule_set_name,
  :limit,
  :next_token)
  include Aws::Structure
end

#next_tokenString

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.

Returns:

  • (String)


2128
2129
2130
2131
2132
2133
2134
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2128

class DescribeMatchmakingConfigurationsInput < Struct.new(
  :names,
  :rule_set_name,
  :limit,
  :next_token)
  include Aws::Structure
end

#rule_set_nameString

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

Returns:

  • (String)


2128
2129
2130
2131
2132
2133
2134
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 2128

class DescribeMatchmakingConfigurationsInput < Struct.new(
  :names,
  :rule_set_name,
  :limit,
  :next_token)
  include Aws::Structure
end