Struct aws_sdk_gamelift::client::fluent_builders::DescribeMatchmakingRuleSets

pub struct DescribeMatchmakingRuleSets { /* private fields */ }

Fluent builder constructing a request to 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.

Learn more

• Build a rule set

Related actions

CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task

Implementations

impl DescribeMatchmakingRuleSets

pub async fn send(
    self
) -> Result<DescribeMatchmakingRuleSetsOutput, SdkError<DescribeMatchmakingRuleSetsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> DescribeMatchmakingRuleSetsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn names(self, input: impl Into<String>) -> Self

Appends an item to Names.

To override the contents of this collection use set_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.

pub fn set_names(self, input: Option<Vec<String>>) -> Self

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.

pub fn limit(self, input: i32) -> Self

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

pub fn set_limit(self, input: Option<i32>) -> Self

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

pub fn next_token(self, input: impl Into<String>) -> Self

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.

pub fn set_next_token(self, input: Option<String>) -> Self

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.

Trait Implementations

impl Clone for DescribeMatchmakingRuleSets

fn clone(&self) -> DescribeMatchmakingRuleSets

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeMatchmakingRuleSets

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.